1prometheus-node-exporter(1)          1.5.0         prometheus-node-exporter(1)
2
3
4

NAME

6       prometheus-node-exporter - The Prometheus Node-Exporter
7

SYNOPSIS

9       prometheus-node-exporter [<flags>]
10
11

DESCRIPTION

OPTIONS

14       -h, --help
15              Show  context-sensitive  help  (also try --help-long and --help-
16              man).
17
18       --collector.arp.device-include=COLLECTOR.ARP.DEVICE-INCLUDE
19              Regexp of arp devices to include (mutually exclusive to  device-
20              exclude).
21
22       --collector.arp.device-exclude=COLLECTOR.ARP.DEVICE-EXCLUDE
23              Regexp  of arp devices to exclude (mutually exclusive to device-
24              include).
25
26       --collector.bcache.priorityStats
27              Expose expensive priority stats.
28
29       --collector.cpu.guest
30              Enables metric node_cpu_guest_seconds_total
31
32       --collector.cpu.info
33              Enables metric cpu_info
34
35       --collector.cpu.info.flags-include=COLLECTOR.CPU.INFO.FLAGS-INCLUDE
36              Filter the `flags` field in cpuInfo with a value that must be  a
37              regular expression
38
39       --collector.cpu.info.bugs-include=COLLECTOR.CPU.INFO.BUGS-INCLUDE
40              Filter  the  `bugs` field in cpuInfo with a value that must be a
41              regular expression
42
43       --collector.diskstats.device-exclude="^(ram|loop|fd|(h|s|v|xv)d[a-
44       z]|nvme\d+n\d+p)\d+$"
45              Regexp  of  diskstats  devices to exclude (mutually exclusive to
46              device-include).
47
48       --collector.diskstats.device-include=COLLECTOR.DISKSTATS.DEVICE-INCLUDE
49              Regexp of diskstats devices to include  (mutually  exclusive  to
50              device-exclude).
51
52       --collector.ethtool.device-include=COLLECTOR.ETHTOOL.DEVICE-INCLUDE
53              Regexp  of ethtool devices to include (mutually exclusive to de‐
54              vice-exclude).
55
56       --collector.ethtool.device-exclude=COLLECTOR.ETHTOOL.DEVICE-EXCLUDE
57              Regexp of ethtool devices to exclude (mutually exclusive to  de‐
58              vice-include).
59
60       --collector.ethtool.metrics-include=".*"
61              Regexp of ethtool stats to include.
62
63       --collector.filesystem.mount-points-exclude="^/(dev|proc|run/creden‐
64       tials/.+|sys|var/lib/docker/.+|var/lib/containers/storage/.+)($|/)"
65              Regexp of mount points to exclude for filesystem collector.
66
67       --collector.filesystem.fs-types-exclude="^(aut‐
68       ofs|binfmt_misc|bpf|cgroup2?|configfs|debugfs|devpts|devtmpfs|fu‐
69       sectl|hugetlbfs|iso9660|mqueue|nsfs|over‐
70       lay|proc|procfs|pstore|rpc_pipefs|securityfs|selin‐
71       uxfs|squashfs|sysfs|tracefs)$"
72              Regexp of filesystem types to exclude for filesystem collector.
73
74       --collector.ipvs.backend-labels="local_address,local_port,remote_ad‐
75       dress,remote_port,proto,local_mark"
76              Comma separated list for IPVS backend stats labels.
77
78       --collector.netclass.ignored-devices="^$"
79              Regexp of net devices to ignore for netclass collector.
80
81       --collector.netclass.ignore-invalid-speed
82              Ignore  devices where the speed is invalid. This will be the de‐
83              fault behavior in 2.x.
84
85       --collector.netclass.netlink
86              Use netlink to gather stats instead of /proc/net/dev.
87
88       --collector.netclass_rtnl.with-stats
89              Expose the statistics for each network device, replacing  netdev
90              collector.
91
92       --collector.netdev.device-include=COLLECTOR.NETDEV.DEVICE-INCLUDE
93              Regexp  of net devices to include (mutually exclusive to device-
94              exclude).
95
96       --collector.netdev.device-exclude=COLLECTOR.NETDEV.DEVICE-EXCLUDE
97              Regexp of net devices to exclude (mutually exclusive to  device-
98              include).
99
100       --collector.netdev.address-info
101              Collect address-info for every device
102
103       --collector.netdev.enable-detailed-metrics
104              Use (incompatible) metric names that provide more detailed stats
105              on Linux
106
107       --collector.netdev.netlink
108              Use netlink to gather stats instead of /proc/net/dev.
109
110       --collector.netstat.fields="^(.*_(InErrors|InErrs)|Ip_Forward‐
111       ing|Ip(6|Ext)_(InOctets|OutOctets)|Icmp6?_(InMsgs|OutMsgs)|TcpExt_(Lis‐
112       ten.*|Syncookies.*|TCPSynRetrans|TCPTimeouts)|Tcp_(ActiveOpens|In‐
113       Segs|OutSegs|OutRsts|PassiveOpens|RetransSegs|CurrEstab)|Udp6?_(InData‐
114       grams|OutDatagrams|NoPorts|RcvbufErrors|SndbufErrors))$"
115              Regexp of fields to return for netstat collector.
116
117       --collector.ntp.server="127.0.0.1"
118              NTP server to use for ntp collector
119
120       --collector.ntp.server-port=123
121              UDP port number to connect to on NTP server
122
123       --collector.ntp.protocol-version=4
124              NTP protocol version
125
126       --collector.ntp.server-is-local
127              Certify that collector.ntp.server address is not  a  public  ntp
128              server
129
130       --collector.ntp.ip-ttl=1
131              IP TTL to use while sending NTP query
132
133       --collector.ntp.max-distance=3.46608s
134              Max accumulated distance to the root
135
136       --collector.ntp.local-offset-tolerance=1ms
137              Offset between local clock and local ntpd time to tolerate
138
139       --path.procfs="/proc"
140              procfs mountpoint.
141
142       --path.sysfs="/sys"
143              sysfs mountpoint.
144
145       --path.rootfs="/"
146              rootfs mountpoint.
147
148       --path.udev.data="/run/udev/data"
149              udev data path.
150
151       --collector.perf.cpus=""
152              List of CPUs from which perf metrics should be collected
153
154       --collector.perf.tracepoint=COLLECTOR.PERF.TRACEPOINT
155              perf tracepoint that should be collected
156
157       --collector.powersupply.ignored-supplies="^$"
158              Regexp  of power supplies to ignore for powersupplyclass collec‐
159              tor.
160
161       --collector.qdisc.fixtures=""
162              test fixtures to use for qdisc collector end-to-end testing
163
164       --collector.qdisk.device-include=COLLECTOR.QDISK.DEVICE-INCLUDE
165              Regexp of qdisk devices to include (mutually  exclusive  to  de‐
166              vice-exclude).
167
168       --collector.qdisk.device-exclude=COLLECTOR.QDISK.DEVICE-EXCLUDE
169              Regexp  of  qdisk  devices to exclude (mutually exclusive to de‐
170              vice-include).
171
172       --collector.rapl.enable-zone-label
173              Enables service unit metric unit_start_time_seconds
174
175       --collector.runit.servicedir="/etc/service"
176              Path to runit service directory.
177
178       --collector.stat.softirq
179              Export softirq calls per vector
180
181       --collector.supervisord.url="http://localhost:9001/RPC2"
182              XML RPC endpoint.
183
184       --collector.sysctl.include=COLLECTOR.SYSCTL.INCLUDE
185              Select sysctl metrics to include
186
187       --collector.sysctl.include-info=COLLECTOR.SYSCTL.INCLUDE-INFO
188              Select sysctl metrics to include as info metrics
189
190       --collector.systemd.unit-include=".+"
191              Regexp of systemd units to include. Units must  both  match  in‐
192              clude and not match exclude to be included.
193
194       --collector.systemd.unit-exclude=".+\.(automount|de‐
195       vice|mount|scope|slice)"
196              Regexp of systemd units to exclude. Units must  both  match  in‐
197              clude and not match exclude to be included.
198
199       --collector.systemd.enable-task-metrics
200              Enables   service  unit  tasks  metrics  unit_tasks_current  and
201              unit_tasks_max
202
203       --collector.systemd.enable-restarts-metrics
204              Enables service unit metric service_restart_total
205
206       --collector.systemd.enable-start-time-metrics
207              Enables service unit metric unit_start_time_seconds
208
209       --collector.tapestats.ignored-devices="^$"
210              Regexp of devices to ignore for tapestats.
211
212       --collector.textfile.directory="/var/lib/prometheus/node-exporter"
213              Directory to read text files with metrics from.
214
215       --collector.vmstat.fields="^(oom_kill|pgpg|pswp|pg.*fault).*"
216              Regexp of fields to return for vmstat collector.
217
218       --collector.wifi.fixtures=""
219              test fixtures to use for wifi collector metrics
220
221       --collector.arp
222              Enable the arp collector (default: enabled).
223
224       --collector.bcache
225              Enable the bcache collector (default: enabled).
226
227       --collector.bonding
228              Enable the bonding collector (default: enabled).
229
230       --collector.btrfs
231              Enable the btrfs collector (default: enabled).
232
233       --collector.buddyinfo
234              Enable the buddyinfo collector (default: disabled).
235
236       --collector.cgroups
237              Enable the cgroups collector (default: disabled).
238
239       --collector.conntrack
240              Enable the conntrack collector (default: enabled).
241
242       --collector.cpu
243              Enable the cpu collector (default: enabled).
244
245       --collector.cpufreq
246              Enable the cpufreq collector (default: enabled).
247
248       --collector.diskstats
249              Enable the diskstats collector (default: enabled).
250
251       --collector.dmi
252              Enable the dmi collector (default: enabled).
253
254       --collector.drbd
255              Enable the drbd collector (default: disabled).
256
257       --collector.drm
258              Enable the drm collector (default: disabled).
259
260       --collector.edac
261              Enable the edac collector (default: enabled).
262
263       --collector.entropy
264              Enable the entropy collector (default: enabled).
265
266       --collector.ethtool
267              Enable the ethtool collector (default: disabled).
268
269       --collector.fibrechannel
270              Enable the fibrechannel collector (default: enabled).
271
272       --collector.filefd
273              Enable the filefd collector (default: enabled).
274
275       --collector.filesystem
276              Enable the filesystem collector (default: enabled).
277
278       --collector.hwmon
279              Enable the hwmon collector (default: enabled).
280
281       --collector.infiniband
282              Enable the infiniband collector (default: enabled).
283
284       --collector.interrupts
285              Enable the interrupts collector (default: disabled).
286
287       --collector.ipvs
288              Enable the ipvs collector (default: enabled).
289
290       --collector.ksmd
291              Enable the ksmd collector (default: disabled).
292
293       --collector.lnstat
294              Enable the lnstat collector (default: disabled).
295
296       --collector.loadavg
297              Enable the loadavg collector (default: enabled).
298
299       --collector.logind
300              Enable the logind collector (default: disabled).
301
302       --collector.mdadm
303              Enable the mdadm collector (default: enabled).
304
305       --collector.meminfo
306              Enable the meminfo collector (default: enabled).
307
308       --collector.meminfo_numa
309              Enable the meminfo_numa collector (default: disabled).
310
311       --collector.mountstats
312              Enable the mountstats collector (default: disabled).
313
314       --collector.netclass
315              Enable the netclass collector (default: enabled).
316
317       --collector.netdev
318              Enable the netdev collector (default: enabled).
319
320       --collector.netstat
321              Enable the netstat collector (default: enabled).
322
323       --collector.network_route
324              Enable the network_route collector (default: disabled).
325
326       --collector.nfs
327              Enable the nfs collector (default: enabled).
328
329       --collector.nfsd
330              Enable the nfsd collector (default: enabled).
331
332       --collector.ntp
333              Enable the ntp collector (default: disabled).
334
335       --collector.nvme
336              Enable the nvme collector (default: enabled).
337
338       --collector.os
339              Enable the os collector (default: enabled).
340
341       --collector.perf
342              Enable the perf collector (default: disabled).
343
344       --collector.powersupplyclass
345              Enable the powersupplyclass collector (default: enabled).
346
347       --collector.pressure
348              Enable the pressure collector (default: enabled).
349
350       --collector.processes
351              Enable the processes collector (default: disabled).
352
353       --collector.qdisc
354              Enable the qdisc collector (default: disabled).
355
356       --collector.rapl
357              Enable the rapl collector (default: enabled).
358
359       --collector.runit
360              Enable the runit collector (default: disabled).
361
362       --collector.schedstat
363              Enable the schedstat collector (default: enabled).
364
365       --collector.selinux
366              Enable the selinux collector (default: enabled).
367
368       --collector.slabinfo
369              Enable the slabinfo collector (default: disabled).
370
371       --collector.sockstat
372              Enable the sockstat collector (default: enabled).
373
374       --collector.softnet
375              Enable the softnet collector (default: enabled).
376
377       --collector.stat
378              Enable the stat collector (default: enabled).
379
380       --collector.supervisord
381              Enable the supervisord collector (default: disabled).
382
383       --collector.sysctl
384              Enable the sysctl collector (default: disabled).
385
386       --collector.systemd
387              Enable the systemd collector (default: disabled).
388
389       --collector.tapestats
390              Enable the tapestats collector (default: enabled).
391
392       --collector.tcpstat
393              Enable the tcpstat collector (default: disabled).
394
395       --collector.textfile
396              Enable the textfile collector (default: enabled).
397
398       --collector.thermal_zone
399              Enable the thermal_zone collector (default: enabled).
400
401       --collector.time
402              Enable the time collector (default: enabled).
403
404       --collector.timex
405              Enable the timex collector (default: enabled).
406
407       --collector.udp_queues
408              Enable the udp_queues collector (default: enabled).
409
410       --collector.uname
411              Enable the uname collector (default: enabled).
412
413       --collector.vmstat
414              Enable the vmstat collector (default: enabled).
415
416       --collector.wifi
417              Enable the wifi collector (default: disabled).
418
419       --collector.xfs
420              Enable the xfs collector (default: enabled).
421
422       --collector.zfs
423              Enable the zfs collector (default: enabled).
424
425       --collector.zoneinfo
426              Enable the zoneinfo collector (default: disabled).
427
428       --web.telemetry-path="/metrics"
429              Path under which to expose metrics.
430
431       --web.disable-exporter-metrics
432              Exclude  metrics  about   the   exporter   itself   (promhttp_*,
433              process_*, go_*).
434
435       --web.max-requests=40
436              Maximum number of parallel scrape requests. Use 0 to disable.
437
438       --collector.disable-defaults
439              Set all collectors to disabled by default.
440
441       --runtime.gomaxprocs=1
442              The target number of CPUs Go will run on (GOMAXPROCS)
443
444       --web.systemd-socket
445              Use  systemd socket activation listeners instead of port listen‐
446              ers (Linux only).
447
448       --web.listen-address=:9100
449              Addresses on which to expose metrics and web interface.  Repeat‐
450              able for multiple addresses.
451
452       --web.config.file=""
453              [EXPERIMENTAL] Path to configuration file that can enable TLS or
454              authentication.
455
456       --log.level=info
457              Only log messages with the given severity or above. One of: [de‐
458              bug, info, warn, error]
459
460       --log.format=logfmt
461              Output format of log messages. One of: [logfmt, json]
462
463       --version
464              Show application version.
465
466
467
468version                         node_exporter,     prometheus-node-exporter(1)