summaryrefslogtreecommitdiff
path: root/src/mongo/db/traffic_recorder.idl
diff options
context:
space:
mode:
authorJason Carey <jcarey@argv.me>2019-01-25 12:54:45 -0500
committerJason Carey <jcarey@argv.me>2019-02-04 14:49:52 -0500
commit8c157f05ea25f13595734b03b3c5b55cd16d7cd6 (patch)
tree27cbb691e3cf0dbc014be24eccbbae6f4f269280 /src/mongo/db/traffic_recorder.idl
parent1b1cf52e94c49ca4c6d8ba693e949c2b655e74b5 (diff)
downloadmongo-8c157f05ea25f13595734b03b3c5b55cd16d7cd6.tar.gz
SERVER-37823 Server Side Traffic Capture
Adds support for special commands which dump wire protocol traffic to disk.
Diffstat (limited to 'src/mongo/db/traffic_recorder.idl')
-rw-r--r--src/mongo/db/traffic_recorder.idl77
1 files changed, 77 insertions, 0 deletions
diff --git a/src/mongo/db/traffic_recorder.idl b/src/mongo/db/traffic_recorder.idl
new file mode 100644
index 00000000000..fa9cd232c14
--- /dev/null
+++ b/src/mongo/db/traffic_recorder.idl
@@ -0,0 +1,77 @@
+# Copyright (C) 2018-present MongoDB, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the Server Side Public License, version 1,
+# as published by MongoDB, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# Server Side Public License for more details.
+#
+# You should have received a copy of the Server Side Public License
+# along with this program. If not, see
+# <http://www.mongodb.com/licensing/server-side-public-license>.
+#
+# As a special exception, the copyright holders give permission to link the
+# code of portions of this program with the OpenSSL library under certain
+# conditions as described in each individual source file and distribute
+# linked combinations including the program with the OpenSSL library. You
+# must comply with the Server Side Public License in all respects for
+# all of the code used other than as permitted herein. If you modify file(s)
+# with this exception, you may extend this exception to your version of the
+# file(s), but you are not obligated to do so. If you do not wish to do so,
+# delete this exception statement from your version. If you delete this
+# exception statement from all source files in the program, then also delete
+# it in the license file.
+
+# This IDL file describes the BSON format for a LogicalSessionId, and
+# handles the serialization to and deserialization from its BSON representation
+# for that class.
+
+global:
+ cpp_namespace: "mongo"
+
+imports:
+ - "mongo/idl/basic_types.idl"
+
+
+structs:
+
+ TrafficRecorderStats:
+ description: "A struct representing the trafficRecording server status section"
+ strict: true
+ fields:
+ running:
+ type: bool
+ bufferSize:
+ type: long
+ bufferedBytes:
+ type: long
+ recordingFile:
+ type: string
+ maxFileSize:
+ type: long
+ currentFileSize:
+ type: long
+
+commands:
+ startRecordingTraffic:
+ description: "start recording Command"
+ namespace: ignored
+ fields:
+ filename:
+ description: "output file name"
+ type: string
+ bufferSize:
+ description: "size of buffer"
+ default: 134217728
+ type: long
+ maxFileSize:
+ description: "size of log file"
+ default: 6294967296
+ type: long
+
+ stopRecordingTraffic:
+ description: "stop recording Command"
+ namespace: ignored