Current File : /home/opti/optisoftcom-new/perl5/man/man3/MongoDB::Monitoring.3pm
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MongoDB::Monitoring 3"
.TH MongoDB::Monitoring 3 "2018-11-30" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MongoDB::Monitoring \- Internal event monitoring API for instrumentation
.SH "VERSION"
.IX Header "VERSION"
version v2.0.2
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The MongoDB::MongoClient takes an optional \f(CW\*(C`monitoring_callback\*(C'\fR
attribute, which can be used to monitor events that occur during the
operation of the driver.
.PP
The \s-1API\s0 is very simple: given a code reference, a hashref for each event
is passed to the code reference. Here is a simple example that just
accumulates events in an array:
.PP
.Vb 2
\& our @events;
\& my $cb = sub { push @events, $_[0] };
\&
\& MongoDB\->connect( $uri, { monitoring_callback => $cb } );
.Ve
.SH "EVENT TYPES"
.IX Header "EVENT TYPES"
Every event is a hash reference, with a \f(CW\*(C`type\*(C'\fR field indicating the type,
e.g. \f(CW\*(C`command_started\*(C'\fR. Each type is described below.
.SS "command_started"
.IX Subsection "command_started"
This event is sent just before a command is put one the wire. It will be
followed by either a \f(CW\*(C`command_succeeded\*(C'\fR or \f(CW\*(C`command_failed\*(C'\fR event.
.PP
Fields:
.IP "\(bu" 4
type: \*(L"command_started\*(R"
.IP "\(bu" 4
databaseName: the name of the database to which the command applies
.IP "\(bu" 4
commandName: the name of the command being executed; for legacy operations that don't use commands, the driver will convert them to appear as if they are in command form.
.IP "\(bu" 4
command: a hash reference representing the full command to be sent
.IP "\(bu" 4
requestId: the request identifier sent to the server
.IP "\(bu" 4
connectionId: address and port of the destination server
.SS "command_succeeded"
.IX Subsection "command_succeeded"
This event is sent just after a command reply is received, but only if the
database reply document contains a non-false \f(CW\*(C`ok\*(C'\fR field. \s-1NOTE:\s0 write
errors will have \f(CW\*(C`ok:1\*(C'\fR even though they have write errors; for writes,
success indicates that the write attempt was valid, not that the write
succeeded.
.PP
Fields:
.IP "\(bu" 4
type: \*(L"command_succeeded\*(R"
.IP "\(bu" 4
commandName: the name of the command being executed
.IP "\(bu" 4
durationSecs: the elapsed time in seconds since the \f(CW\*(C`command_started\*(C'\fR event.
.IP "\(bu" 4
reply: a hash reference representing the full database reply
.IP "\(bu" 4
requestId: the request identifier sent to the server
.IP "\(bu" 4
connectionId: address and port of the destination server
.SS "command_failed"
.IX Subsection "command_failed"
This event is sent just after a command reply is received, but only if the
database reply document contains a false \f(CW\*(C`ok\*(C'\fR field or if an exception
occurred during send or receive operations.
.PP
Fields:
.IP "\(bu" 4
type: \*(L"command_failed\*(R"
.IP "\(bu" 4
commandName: the name of the command being executed
.IP "\(bu" 4
durationSecs: the elapsed time in seconds since the \f(CW\*(C`command_started\*(C'\fR event.
.IP "\(bu" 4
failure: a string with a error message about the failure
.IP "\(bu" 4
eval_error: if an exception occurs, this contains the value of \f(CW$@\fR when the exception was caught
.IP "\(bu" 4
reply: a hash reference representing the full database reply or an empty hashref if the failure is due to an exception
.IP "\(bu" 4
requestId: the request identifier sent to the server
.IP "\(bu" 4
connectionId: address and port of the destination server
.SH "REDACTION"
.IX Header "REDACTION"
Certain commands are considered sensitive. When any of the following
commands are seen in monitoring, the command body and database reply body
are replaced with an empty document:
.IP "\(bu" 4
authenticate
.IP "\(bu" 4
saslStart
.IP "\(bu" 4
saslContinue
.IP "\(bu" 4
getnonce
.IP "\(bu" 4
createUser
.IP "\(bu" 4
updateUser
.IP "\(bu" 4
copydbgetnonce
.IP "\(bu" 4
copydbsaslstart
.IP "\(bu" 4
copydb
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <david@mongodb.com>
.IP "\(bu" 4
Rassi <rassi@mongodb.com>
.IP "\(bu" 4
Mike Friedman <friedo@friedo.com>
.IP "\(bu" 4
Kristina Chodorow <k.chodorow@gmail.com>
.IP "\(bu" 4
Florian Ragwitz <rafl@debian.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2018 by MongoDB, Inc.
.PP
This is free software, licensed under:
.PP
.Vb 1
\& The Apache License, Version 2.0, January 2004
.Ve
Mini Shell