[DOCS-12424] Docs for SERVER-37823: Server Side Traffic Capture Created: 04/Feb/19  Updated: 13/Nov/23  Resolved: 31/Oct/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.1.8, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Emet Ozar
Resolution: Won't Fix Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on TOOLS-2201 Mongoreplay support for new mongod tr... Closed
Documented
documents SERVER-37823 Server Side Traffic Capture Closed
Duplicate
Related
related to DOCS-12506 4.2 mongoreplay update for TOOLS-2201... Closed
Participants:
Days since reply: 1 year, 14 weeks, 2 days ago
Epic Link: DOCSP-11344

 Description   

Description

Description:

Documentation for MongoTrafficReader

Preliminary docs changes: https://github.com/tkaye407/docs/commit/20369b1e89a3b475ac2dd2bcc30c3fd76de99210

There are two sections of the documentation that need to be edited / added

1. Add Commands startRecordingTraffic and stopRecordingTraffic
Notes:
mongod must be run with --setParameter="trafficRecordingDirectory=..."
dir above must exist and cannot have ~/ stuff
Only on admin database
Must have clusterManager role (hostManager)
Issues warning: *** important
Warning: the recording file contains unencrypted user traffic, we recommend that you limit retention of this file and store it on an encrypted filesystem volume.
Comment about the performance?

Parameters for startRecordingTraffic():
a. filename: string --> required
b. bufferSize: int64 --> default = 134217728 (128MiB)
c. maxFileSize: int64 --> default = 4294967296 (4GiB)

stopRecordingTraffic()
returns any errors that may have happened while recording

2. Server Sytatus New Fields:
"running" : <boolean>
"bufferSize" : NumberLong(<num>)
"bufferedBytes" : NumberLong(<num>)
"recordingFile" : <string>
"maxFileSize" : NumberLong(<num>)
"currentFileSize" : NumberLong(<num>)

Engineering Ticket Description:

Provide a mechanism for capturing client traffic sent to a mongo[d|s] process by observing and copying the messages after they’ve transited the transport layer – i.e. after operating system ::recv() and subsequent TLS decryption. This allows the use of mongoreplay and other tee like functionality to be used when TLS is enabled for client/server communication.

Scope of changes

*note:* mongoreplay will be updated to be able to read the captured traffic file (TOOLS-2201) For now, will only add a little blurb. When TOOLS-2201 finishes, will need to revamp the mongoreplay page.

  • source/reference/built-in-roles.txt
  • source/reference/command/serverStatus.txt
  • source/reference/command/startRecordingTraffic.txt
  • source/reference/command/stopRecordingTraffic.txt
  • source/reference/parameters.txt
  • source/reference/program/mongoreplay.txt (More to come when TOOLS-2201 completes – See DOCS-12506)
  • source/release-notes/4.2.txt
  • redirects

Impact to Other Docs

probably Atlas

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

Comment by Githook User [ 28/Jun/19 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: Revert "DOCS-12424: Adding TrafficCapture"

This reverts commit 59dd8bd735dac84bfd148406b7a8b8be31dbc7d7.
Branch: master
https://github.com/mongodb/docs/commit/013c4db9dd5815afc44e670330936c3e0c6523fd

Comment by Githook User [ 28/Jun/19 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: Revert "DOCS-12424: traffic capture part 2"

This reverts commit 33bc7e664dc4d22d95fb01a6793de077ee91c265.
Branch: master
https://github.com/mongodb/docs/commit/026c71818294f4a1f6056e133d947c8a1469d58d

Comment by Alyson Cabral (Inactive) [ 28/Jun/19 ]

Yes, that sounds right!

Comment by Githook User [ 22/Feb/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12424: traffic capture part 2
Branch: master
https://github.com/mongodb/docs/commit/33bc7e664dc4d22d95fb01a6793de077ee91c265

Comment by Githook User [ 22/Feb/19 ]

Author:

{'name': 'Tyler Kaye', 'username': 'tkaye407', 'email': 'tyler.kaye@mongodb.com'}

Message: DOCS-12424: Adding TrafficCapture
Branch: master
https://github.com/mongodb/docs/commit/59dd8bd735dac84bfd148406b7a8b8be31dbc7d7

Generated at Thu Feb 08 08:05:13 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.