File: prometheus-mongodb-exporter.1

package info (click to toggle)
prometheus-mongodb-exporter 1.0.0%2Bgit20180522.e755a44-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 752 kB
  • sloc: sh: 91; makefile: 35
file content (144 lines) | stat: -rw-r--r-- 3,862 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.12.
.TH PROMETHEUS-MONGODB-EXPORTER "1" "May 2020" "prometheus-mongodb-exporter 1.0.0+git20180522.e755a44" "User Commands"
.SH NAME
prometheus-mongodb-exporter \- Prometheus exporter for MongoDB
.SH DESCRIPTION
.SS "Usage of prometheus-mongodb-exporter:"
.HP
\fB\-alsologtostderr\fR
.IP
log to standard error as well as files
.HP
\fB\-auth\fR.pass string
.IP
Password for basic auth.
.HP
\fB\-auth\fR.user string
.IP
Username for basic auth.
.HP
\fB\-groups\fR.enabled string
.IP
Comma\-separated list of groups to use, for more info see: docs.mongodb.org/manual/reference/command/serverStatus/
.HP
\fB\-log_backtrace_at\fR value
.IP
when logging hits line file:N, emit a stack trace
.HP
\fB\-log_dir\fR string
.IP
If non\-empty, write log files in this directory
.HP
\fB\-logtostderr\fR
.IP
log to standard error instead of files
.HP
\fB\-mongodb\fR.collect.collection
.IP
Collect MongoDB collection metrics
.HP
\fB\-mongodb\fR.collect.connpoolstats
.IP
Collect MongoDB connpoolstats
.HP
\fB\-mongodb\fR.collect.database
.IP
collect MongoDB database metrics
.HP
\fB\-mongodb\fR.collect.oplog
.IP
collect Mongodb Oplog status (default true)
.HP
\fB\-mongodb\fR.collect.profile
.IP
Collect MongoDB profile metrics
.HP
\fB\-mongodb\fR.collect.replset
.IP
collect Mongodb replica set status (default true)
.HP
\fB\-mongodb\fR.collect.top
.IP
collect Mongodb Top metrics
.HP
\fB\-mongodb\fR.mechanism string
.IP
auth mechanism to connect to Mongodb (ie: MONGODB\-X509)
.HP
\fB\-mongodb\fR.tls\-ca string
.IP
Path to PEM file that contains the CAs that are trused for server connections.
.IP
If provided: MongoDB servers connecting to should present a certificate signed by one of this CAs.
If not provided: System default CAs are used.
.HP
\fB\-mongodb\fR.tls\-cert string
.IP
Path to PEM file that contains the certificate (and optionally also the private key in PEM format).
.IP
This should include the whole certificate chain.
If provided: The connection will be opened via TLS to the MongoDB server.
.HP
\fB\-mongodb\fR.tls\-disable\-hostname\-validation
.IP
Do hostname validation for server connection.
.HP
\fB\-mongodb\fR.tls\-private\-key string
.IP
Path to PEM file that contains the private key (if not contained in mongodb.tls\-cert file).
.HP
\fB\-mongodb\fR.uri string
.IP
Mongodb URI, format:
[mongodb://] [user:pass@] host1[:port1] [,host2[:port2],...] [/database] [?options] 
Note: default "mongodb://localhost:27017"
.HP
\fB\-mongodb\fR.username string
.IP
Username to connect to Mongodb
.HP
\fB\-stderrthreshold\fR value
.IP
logs at or above this threshold go to stderr
.HP
\fB\-v\fR value
.IP
log level for V logs
.HP
\fB\-version\fR
.IP
Print mongodb_exporter version
.HP
\fB\-vmodule\fR value
.IP
comma\-separated list of pattern=N settings for file\-filtered logging
.HP
\fB\-web\fR.listen\-address string
.IP
Address on which to expose metrics and web interface. (default ":9001")
.HP
\fB\-web\fR.metrics\-path string
.IP
Path under which to expose metrics. (default "/metrics")
.HP
\fB\-web\fR.tls\-cert string
.IP
Path to PEM file that contains the certificate (and optionally also the private key in PEM format).
.IP
This should include the whole certificate chain.
If provided: The web socket will be a HTTPS socket.
If not provided: Only HTTP.
.HP
\fB\-web\fR.tls\-client\-ca string
.IP
Path to PEM file that contains the CAs that are trused for client connections.
.IP
If provided: Connecting clients should present a certificate signed by one of this CAs.
If not provided: Every client will be accepted.
.HP
\fB\-web\fR.tls\-private\-key string
.IP
Path to PEM file that contains the private key (if not contained in web.tls\-cert file).
.SH AUTHOR
 This manpage was written by Nilesh Patra for the Debian distribution and
 can be used for any other usage of the program.