← Back to branch summary

~evarlast/ubuntu/utopic/mongodb/upstart-workaround-debian-bug-718702

« back to all changes in this revision

Viewing changes to debian/manpages/mongosniff.1

  • Committer: Package Import Robot
  • Author(s): James Page, James Page, Robie Basak
  • Date: 2013-05-29 17:44:42 UTC
  • mfrom: (44.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20130529174442-z0a4qmoww4y0t458
Tags: 1:2.4.3-1ubuntu1
[ James Page ]
* Merge from Debian unstable, remaining changes:
  - Enable SSL support:
    + d/control: Add libssl-dev to BD's.
    + d/rules: Enabled --ssl option.
    + d/mongodb.conf: Add example SSL configuration options.
  - d/mongodb-server.mongodb.upstart: Add upstart configuration.
  - d/rules: Don't strip binaries during scons build for Ubuntu.
  - d/control: Add armhf to target archs.
  - d/p/SConscript.client.patch: fixup install of client libraries.
  - d/p/0010-install-libs-to-usr-lib-not-usr-lib64-Closes-588557.patch:
    Install libraries to lib not lib64.
* Dropped changes:
  - d/p/arm-support.patch: Included in Debian.
  - d/p/double-alignment.patch: Included in Debian.
  - d/rules,control: Debian also builds with avaliable system libraries
    now.
* Fix FTBFS due to gcc and boost upgrades in saucy:
  - d/p/0008-ignore-unused-local-typedefs.patch: Add -Wno-unused-typedefs
    to unbreak building with g++-4.8.
  - d/p/0009-boost-1.53.patch: Fixup signed/unsigned casting issue.

[ Robie Basak ]
* d/p/0011-Use-a-signed-char-to-store-BSONType-enumerations.patch: Fixup
  build failure on ARM due to missing signed'ness of char cast.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/manpages/mongosniff.1
1
 
.TH MONGOSNIFF "1" "Jan 2010" "10gen" "Mongo Database"
2
 
.SH "NAME"
3
 
mongosniff \- the Mongo packet analyzer
4
 
.SH "SYNOPSIS"
5
 
\fBmongosniff [\fIOPTIONS\fR] [\fI<port0> <port1> ...\fR]
6
 
.SH "DESCRIPTION"
7
 
.PP
8
 
\fBmongosniff\fR
9
 
is a analyzer tool for analyzing packets coming to your database.
10
 
.PP
11
 
.SH "OPTIONS"
12
 
.TP
13
 
.B \-\-forward
14
 
Forward all parsed request messages to mongod instance at specified host:port
15
 
.TP
16
 
.B \-\-source
17
 
Source of traffic to sniff, either a network interface or a file containing previously captured packets, in pcap format. If no source is specified, mongosniff will attempt to sniff from one of the machine's network interfaces.
18
 
.TP
19
 
.B \-\-help
20
 
print a short help message.
21
 
.TP
22
 
.B <port0>
23
 
These parameters are used to filter sniffing.  By default, only port 27017 is sniffed.
24
 
.TP
25
 
.B \-\-help
26
 
show usage information
27
 
.SH "COPYRIGHT"
28
 
.PP
29
 
Copyright 2007\-2011 10gen
30
 
.SH "SEE ALSO"
31
 
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
32
 
.SH "AUTHOR"
33
 
Antonin Kral
 
1
.TH "MONGOSNIFF" "1" "March 14, 2013" "2.2.3" "mongodb-manual"
 
2
.SH NAME
 
3
mongosniff \- MongoDB
 
4
.
 
5
.nr rst2man-indent-level 0
 
6
.
 
7
.de1 rstReportMargin
 
8
\\$1 \\n[an-margin]
 
9
level \\n[rst2man-indent-level]
 
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
11
-
 
12
\\n[rst2man-indent0]
 
13
\\n[rst2man-indent1]
 
14
\\n[rst2man-indent2]
 
15
..
 
16
.de1 INDENT
 
17
.\" .rstReportMargin pre:
 
18
. RS \\$1
 
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 
20
. nr rst2man-indent-level +1
 
21
.\" .rstReportMargin post:
 
22
..
 
23
.de UNINDENT
 
24
. RE
 
25
.\" indent \\n[an-margin]
 
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
27
.nr rst2man-indent-level -1
 
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 
30
..
 
31
.\" Man page generated from reStructuredText.
 
32
.
 
33
.SH SYNOPSIS
 
34
.sp
 
35
\fI\%mongosniff\fP provides a low\-level operation tracing/sniffing view
 
36
into database activity in real time. Think of \fI\%mongosniff\fP as a
 
37
MongoDB\-specific analogue of \fBtcpdump\fP for TCP/IP network
 
38
traffic. Typically, \fI\%mongosniff\fP is most frequently used in driver
 
39
development.
 
40
.IP Note
 
41
\fI\%mongosniff\fP requires \fBlibpcap\fP and is only available for
 
42
Unix\-like systems. Furthermore, the version distributed with the
 
43
MongoDB binaries is dynamically linked against aversion 0.9 of
 
44
\fBlibpcap\fP. If your system has a different version of \fBlibpcap\fP, you
 
45
will need to compile \fI\%mongosniff\fP yourself or create a
 
46
symbolic link pointing to \fBlibpcap.so.0.9\fP to your local version
 
47
of \fBlibpcap\fP. Use an operation that resembles the following:
 
48
.sp
 
49
.nf
 
50
.ft C
 
51
ln \-s /usr/lib/libpcap.so.1.1.1 /usr/lib/libpcap.so.0.9
 
52
.ft P
 
53
.fi
 
54
.sp
 
55
Change the path\(aqs and name of the shared library as needed.
 
56
.RE
 
57
.sp
 
58
As an alternative to \fI\%mongosniff\fP, Wireshark, a popular
 
59
network sniffing tool is capable of inspecting and parsing the MongoDB
 
60
wire protocol.
 
61
.SH OPTIONS
 
62
.INDENT 0.0
 
63
.TP
 
64
.B mongosniff
 
65
.UNINDENT
 
66
.INDENT 0.0
 
67
.TP
 
68
.B \-\-help
 
69
Returns a basic help and usage text.
 
70
.UNINDENT
 
71
.INDENT 0.0
 
72
.TP
 
73
.B \-\-forward <host><:port>
 
74
Declares a host to forward all parsed requests that the
 
75
\fI\%mongosniff\fP intercepts to another \fBmongod\fP
 
76
instance and issue those operations on that database instance.
 
77
.sp
 
78
Specify the target host name and port in the \fB<host><:port>\fP
 
79
format.
 
80
.sp
 
81
To connect to a replica set, you can specify the replica set seed
 
82
name, and a seed list of set members, in the following format:
 
83
.sp
 
84
.nf
 
85
.ft C
 
86
<replica_set_name>/<hostname1><:port>,<hostname2:<port>,...
 
87
.ft P
 
88
.fi
 
89
.UNINDENT
 
90
.INDENT 0.0
 
91
.TP
 
92
.B \-\-source <NET [interface]>, <FILE [filename]>, <DIAGLOG [filename]>
 
93
Specifies source material to inspect. Use \fB\-\-source NET
 
94
[interface]\fP to inspect traffic from a network interface
 
95
(e.g. \fBeth0\fP or \fBlo\fP.) Use \fB\-\-source FILE [filename]\fP to
 
96
read captured packets in \fIpcap\fP format.
 
97
.sp
 
98
You may use the \fB\-\-source DIAGLOG [filename]\fP option to read
 
99
the output files produced by the \fI\-\-diaglog\fP
 
100
option.
 
101
.UNINDENT
 
102
.INDENT 0.0
 
103
.TP
 
104
.B \-\-objcheck
 
105
Modifies the behavior to \fIonly\fP display invalid BSON objects and
 
106
nothing else. Use this option for troubleshooting driver
 
107
development. This option has some performance impact on the
 
108
performance of \fI\%mongosniff\fP.
 
109
.UNINDENT
 
110
.INDENT 0.0
 
111
.TP
 
112
.B <port>
 
113
Specifies alternate ports to sniff for traffic. By default,
 
114
\fI\%mongosniff\fP watches for MongoDB traffic on port 27017. Append
 
115
multiple port numbers to the end of \fI\%mongosniff\fP to monitor
 
116
traffic on multiple ports.
 
117
.UNINDENT
 
118
.SH USAGE
 
119
.sp
 
120
Use the following command to connect to a \fBmongod\fP or
 
121
\fBmongos\fP running on port 27017 \fIand\fP 27018 on the localhost
 
122
interface:
 
123
.sp
 
124
.nf
 
125
.ft C
 
126
mongosniff \-\-source NET lo 27017 27018
 
127
.ft P
 
128
.fi
 
129
.sp
 
130
Use the following command to only log invalid \fIBSON\fP objects for
 
131
the \fBmongod\fP or \fBmongos\fP running on the localhost
 
132
interface and port 27018, for driver development and troubleshooting:
 
133
.sp
 
134
.nf
 
135
.ft C
 
136
mongosniff \-\-objcheck \-\-source NET lo 27018
 
137
.ft P
 
138
.fi
 
139
.SH BUILD MONGOSNIFF
 
140
.sp
 
141
To build \fBmongosniff\fP yourself, Linux users can use the following
 
142
procedure:
 
143
.INDENT 0.0
 
144
.IP 1. 3
 
145
Obtain prerequisites using your operating
 
146
systems package management software. Dependencies include:
 
147
.INDENT 3.0
 
148
.IP \(bu 2
 
149
\fBlibpcap\fP \- to capture network packets.
 
150
.IP \(bu 2
 
151
\fBgit\fP \- to download the MongoDB source code.
 
152
.IP \(bu 2
 
153
\fBscons\fP and a C++ compiler \- to build \fI\%mongosniff\fP.
 
154
.UNINDENT
 
155
.IP 2. 3
 
156
Download a copy of the MongoDB source code using \fBgit\fP:
 
157
.sp
 
158
.nf
 
159
.ft C
 
160
git clone git://github.com/mongodb/mongo.git
 
161
.ft P
 
162
.fi
 
163
.IP 3. 3
 
164
Issue the following sequence of commands to change to the
 
165
\fBmongo/\fP directory and build \fI\%mongosniff\fP:
 
166
.sp
 
167
.nf
 
168
.ft C
 
169
cd mongo
 
170
scons mongosniff
 
171
.ft P
 
172
.fi
 
173
.UNINDENT
 
174
.IP Note
 
175
If you run \fBscons mongosniff\fP before installing \fBlibpcap\fP you
 
176
must run \fBscons clean\fP before you can build \fI\%mongosniff\fP.
 
177
.RE
 
178
.SH AUTHOR
 
179
MongoDB Documentation Project
 
180
.SH COPYRIGHT
 
181
2011-2013, 10gen, Inc.
 
182
.\" Generated by docutils manpage writer.
 
183
.