prometheus-node-exporter(1)
Hey bestie π this is prometheus-node-exporter(1), version 1.12.1 β the manual for the Prometheus Node-Exporter. Yes, the header repeats the manual name and weβre folding that in like a good little group chat. Letβs get into it. π
πΈ NAME
prometheus-node-exporter β The Prometheus Node-Exporter. Thatβs it, thatβs the name. Short, iconic, and already telling you whatβs up. π
β¨ SYNOPSIS
Run it with flags like this, no cap:
prometheus-node-exporter [<flags>]
π DESCRIPTION
This section is empty in the original β literally zero description text. The actual tea is in OPTIONS, so keep scrolling. π«Ά
π OPTIONS
Okay bestie, buckle up: every flag from this part is below, with its exact name, default, and mutual-exclusion drama preserved. β¨
-h,--helpβ Shows context-sensitive help. Also try--help-longand--help-man, because this help has range. π--collector.arp.device-include=COLLECTOR.ARP.DEVICE-INCLUDEβ Regexp of arp devices to include. Heads up: this is mutually exclusive withdevice-exclude.--collector.arp.device-exclude=COLLECTOR.ARP.DEVICE-EXCLUDEβ Regexp of arp devices to exclude. Mutually exclusive withdevice-include.--collector.arp.netlinkβ Use netlink to gather stats instead of/proc/net/arp. Netlink era, slay. π¦--collector.bcache.priorityStatsβ Exposes the expensive priority stats. Itβs giving luxury scrape. πΈ--collector.cpu.guestβ Enables metricnode_cpu_guest_seconds_total.--collector.cpu.infoβ Enables metriccpu_info.--collector.cpu.info.flags-include=COLLECTOR.CPU.INFO.FLAGS-INCLUDEβ Filters theflagsfield incpuInfowith a value that must be a regular expression. Regex girlies rise. π§--collector.cpu.info.bugs-include=COLLECTOR.CPU.INFO.BUGS-INCLUDEβ Filters thebugsfield incpuInfowith a value that must be a regular expression.--collector.diskstats.device-exclude="^(z?ram|loop|fd|(h|s|v|xv)d[a-z]|nvme\d+n\d+p)\d+$"β Regexp of diskstats devices to exclude. Mutually exclusive withdevice-include. That default regex is doing the absolute most, ngl.--collector.diskstats.device-include=COLLECTOR.DISKSTATS.DEVICE-INCLUDEβ Regexp of diskstats devices to include. Mutually exclusive withdevice-exclude.--collector.ethtool.device-include=COLLECTOR.ETHTOOL.DEVICE-INCLUDEβ Regexp of ethtool devices to include. Mutually exclusive withdevice-exclude.--collector.ethtool.device-exclude=COLLECTOR.ETHTOOL.DEVICE-EXCLUDEβ Regexp of ethtool devices to exclude. Mutually exclusive withdevice-include.--collector.ethtool.metrics-include=".*"β Regexp of ethtool stats to include. Default is the very inclusive.*. π«Ά--collector.filesystem.mount-points-exclude="^/(dev|proc|run|sys|mnt|media|var/lib/docker/.+|var/lib/containers/storage/.+)($|/)"β Regexp of mount points to exclude for filesystem collector. Mutually exclusive withmount-points-include. That default regex is long af but itβs right there.--collector.filesystem.mount-points-include=COLLECTOR.FILESYSTEM.MOUNT-POINTS-INCLUDEβ Regexp of mount points to include for filesystem collector. Mutually exclusive withmount-points-exclude.--collector.filesystem.fs-types-exclude="^(autofs|binfmt_misc|bpf|cgroup2?|configfs|debugfs|devpts|devtmpfs|fusectl|hugetlbfs|iso9660|mqueue|nsfs|overlay|proc|procfs|pstore|rpc_pipefs|securityfs|selinuxfs|squashfs|erofs|sysfs|tracefs)$"β Regexp of filesystem types to exclude for filesystem collector. Mutually exclusive withfs-types-include. Default list is huge and yes, itβs exact.--collector.filesystem.fs-types-include=COLLECTOR.FILESYSTEM.FS-TYPES-INCLUDEβ Regexp of filesystem types to include for filesystem collector. Mutually exclusive withfs-types-exclude.--collector.hwmon.chip-include=COLLECTOR.HWMON.CHIP-INCLUDEβ Regexp of hwmon chip to include. Mutually exclusive withdevice-exclude.--collector.hwmon.chip-exclude=COLLECTOR.HWMON.CHIP-EXCLUDEβ Regexp of hwmon chip to exclude. Mutually exclusive withdevice-include.--collector.hwmon.sensor-include=COLLECTOR.HWMON.SENSOR-INCLUDEβ Regexp of hwmon sensor to include. Mutually exclusive withsensor-exclude.--collector.hwmon.sensor-exclude=COLLECTOR.HWMON.SENSOR-EXCLUDEβ Regexp of hwmon sensor to exclude. Mutually exclusive withsensor-include.--collector.infiniband.device-include=COLLECTOR.INFINIBAND.DEVICE-INCLUDEβ Regexp of infiniband devices to include. Mutually exclusive withdevice-exclude.--collector.infiniband.device-exclude=COLLECTOR.INFINIBAND.DEVICE-EXCLUDEβ Regexp of infiniband devices to exclude. Mutually exclusive withdevice-include.--collector.interrupts.name-include=COLLECTOR.INTERRUPTS.NAME-INCLUDEβ Regexp of interrupts name to include. Mutually exclusive with--collector.interrupts.name-exclude.--collector.interrupts.name-exclude=COLLECTOR.INTERRUPTS.NAME-EXCLUDEβ Regexp of interrupts name to exclude. Mutually exclusive with--collector.interrupts.name-include.--collector.interrupts.include-zerosβ Include interrupts that have a zero value. Zero is still data, bestie. π--collector.ipvs.backend-labels="local_address,local_port,remote_address,remote_port,proto,local_mark"β Comma separated list for IPVS backend stats labels. Default is that whole string, exactly.--collector.netclass.ignored-devices="^$"β Regexp of net devices to ignore for netclass collector.--collector.netclass.ignore-invalid-speedβ Ignore devices where the speed is invalid. This will be the default behavior in 2.x. Future-default alert π¨--collector.netclass.netlinkβ Use netlink to gather stats instead of/proc/net/dev.--collector.netclass_rtnl.with-statsβ Expose the statistics for each network device, replacing netdev collector. It says what it says. π--collector.netdev.device-include=COLLECTOR.NETDEV.DEVICE-INCLUDEβ Regexp of net devices to include. Mutually exclusive withdevice-exclude.--collector.netdev.device-exclude=COLLECTOR.NETDEV.DEVICE-EXCLUDEβ Regexp of net devices to exclude. Mutually exclusive withdevice-include.--collector.netdev.address-infoβ Collect address-info for every device.--collector.netdev.enable-detailed-metricsβ Use (incompatible) metric names that provide more detailed stats on Linux. Incompatible, bestie β not a drill.--collector.netdev.netlinkβ Use netlink to gather stats instead of/proc/net/dev.--collector.netdev.label-ifaliasβ Add ifAlias label.--collector.netstat.fields="^(.*_(InErrors|InErrs)|Ip_Forwarding|Ip(6|Ext)_(InOctets|OutOctets)|Icmp6?_(InMsgs|OutMsgs)|TcpExt_(Listen.*|Syncookies.*|TCPSynRetrans|TCPTimeouts|TCPOFOQueue|TCPRcvQDrop)|Tcp_(ActiveOpens|InSegs|OutSegs|OutRsts|PassiveOpens|RetransSegs|CurrEstab)|Udp6?_(InDatagrams|OutDatagrams|NoPorts|RcvbufErrors|SndbufErrors))$"β Regexp of fields to return for netstat collector. That default regex is a whole mood. π₯--collector.ntp.server="127.0.0.1"β NTP server to use for ntp collector.--collector.ntp.server-port=123β UDP port number to connect to on NTP server.--collector.ntp.protocol-version=4β NTP protocol version.--collector.ntp.server-is-localβ Certify thatcollector.ntp.serveraddress is not a public ntp server. Itβs giving trust issues but make it explicit.--collector.ntp.ip-ttl=1β IP TTL to use while sending NTP query.--collector.ntp.max-distance=3.46608sβ Max accumulated distance to the root.--collector.ntp.local-offset-tolerance=1msβ Offset between local clock and local ntpd time to tolerate.--path.procfs="/proc"β procfs mountpoint.--path.sysfs="/sys"β sysfs mountpoint.--path.rootfs="/"β rootfs mountpoint.--path.udev.data="/run/udev/data"β udev data path.--collector.pcidevice.idsfile=COLLECTOR.PCIDEVICE.IDSFILEβ Path topci.idsfile to use for PCI device identification.--collector.pcidevice.namesβ Enable PCI device name resolution (requirespci.idsfile).--collector.perf.cpus=""β List of CPUs from which perf metrics should be collected. Default is the empty string.--collector.perf.tracepoint=COLLECTOR.PERF.TRACEPOINTβ perf tracepoint that should be collected.--collector.perf.disable-hardware-profilersβ disable perf hardware profilers.--collector.perf.hardware-profilers=COLLECTOR.PERF.HARDWARE-PROFILERSβ perf hardware profilers that should be collected.--collector.perf.disable-software-profilersβ disable perf software profilers.--collector.perf.software-profilers=COLLECTOR.PERF.SOFTWARE-PROFILERSβ perf software profilers that should be collected.--collector.perf.disable-cache-profilersβ disable perf cache profilers.--collector.perf.cache-profilers=COLLECTOR.PERF.CACHE-PROFILERSβ perf cache profilers that should be collected.--collector.powersupply.ignored-supplies="^$"β Regexp of power supplies to ignore for powersupplyclass collector.--collector.qdisc.fixtures=""β test fixtures to use for qdisc collector end-to-end testing.--collector.qdisc.device-include=COLLECTOR.QDISC.DEVICE-INCLUDEβ Regexp of qdisc devices to include. Mutually exclusive withdevice-exclude.--collector.qdisc.device-exclude=COLLECTOR.QDISC.DEVICE-EXCLUDEβ Regexp of qdisc devices to exclude. Mutually exclusive withdevice-include.--collector.rapl.enable-zone-labelβ Enables service unit metricunit_start_time_seconds.--collector.runit.servicedir="/etc/service"β Path to runit service directory.--collector.slabinfo.slabs-include=".*"β Regexp of slabs to include in slabinfo collector.--collector.slabinfo.slabs-exclude=""β Regexp of slabs to exclude in slabinfo collector.--collector.stat.softirqβ Export softirq calls per vector.--collector.supervisord.url="http://localhost:9001/RPC2"β XML RPC endpoint.--collector.sysctl.include=COLLECTOR.SYSCTL.INCLUDEβ Select sysctl metrics to include.--collector.sysctl.include-info=COLLECTOR.SYSCTL.INCLUDE-INFOβ Select sysctl metrics to include as info metrics.--collector.systemd.unit-include=".+"β Regexp of systemd units to include. Units must both match include and not match exclude to be included. Double filter, no cap.--collector.systemd.unit-exclude=".+\.(automount|device|mount|scope|slice|target)"β Regexp of systemd units to exclude. Units must both match include and not match exclude to be included.--collector.systemd.enable-task-metricsβ Enables service unit tasks metricsunit_tasks_currentandunit_tasks_max.--collector.systemd.enable-restarts-metricsβ Enables service unit metricservice_restart_total.--collector.systemd.enable-start-time-metricsβ Enables service unit metricunit_start_time_seconds.--collector.tapestats.ignored-devices="^$"β Regexp of devices to ignore for tapestats.--collector.textfile.directory=/var/lib/prometheus/node-exporterβ Directory to read text files with metrics from, supports glob matching. (repeatable)--collector.vmstat.fields="^(oom_kill|pgpg|pswp|pg.*fault).*"β Regexp of fields to return for vmstat collector.--collector.wifi.fixtures=""β test fixtures to use for wifi collector metrics.--collector.arpβ Enable the arp collector. Default: enabled.--collector.bcacheβ Enable the bcache collector. Default: enabled.
...and the collector keep-going continues, bestie π
every single one of these is just on or off out of the box, no cap:
--collector.bcachefsβ turns on thebcachefscollector (default: enabled).--collector.bondingβ turns on thebondingcollector (default: enabled).--collector.btrfsβ turns on thebtrfscollector (default: enabled).--collector.buddyinfoβ turns on thebuddyinfocollector (default: disabled).--collector.cgroupsβ turns on thecgroupscollector (default: disabled).--collector.conntrackβ turns on theconntrackcollector (default: enabled).--collector.cpuβ turns on thecpucollector (default: enabled).--collector.cpu_vulnerabilitiesβ turns on thecpu_vulnerabilitiescollector (default: disabled).--collector.cpufreqβ turns on thecpufreqcollector (default: enabled).--collector.diskstatsβ turns on thediskstatscollector (default: enabled).--collector.dmiβ turns on thedmicollector (default: enabled).--collector.dmmultipathβ turns on thedmmultipathcollector (default: enabled).--collector.drbdβ turns on thedrbdcollector (default: disabled).--collector.drmβ turns on thedrmcollector (default: disabled).--collector.edacβ turns on theedaccollector (default: enabled).--collector.entropyβ turns on theentropycollector (default: enabled).--collector.ethtoolβ turns on theethtoolcollector (default: disabled).--collector.fibrechannelβ turns on thefibrechannelcollector (default: enabled).--collector.filefdβ turns on thefilefdcollector (default: enabled).--collector.filesystemβ turns on thefilesystemcollector (default: enabled).--collector.hwmonβ turns on thehwmoncollector (default: enabled).--collector.infinibandβ turns on theinfinibandcollector (default: enabled).--collector.interruptsβ turns on theinterruptscollector (default: disabled).--collector.ipvsβ turns on theipvscollector (default: enabled).--collector.kernel_hungβ turns on thekernel_hungcollector (default: enabled).--collector.ksmdβ turns on theksmdcollector (default: disabled).--collector.lnstatβ turns on thelnstatcollector (default: disabled).--collector.loadavgβ turns on theloadavgcollector (default: enabled).--collector.logindβ turns on thelogindcollector (default: disabled).--collector.mdadmβ turns on themdadmcollector (default: enabled).--collector.meminfoβ turns on thememinfocollector (default: enabled).--collector.meminfo_numaβ turns on thememinfo_numacollector (default: disabled).--collector.mountstatsβ turns on themountstatscollector (default: disabled).--collector.netclassβ turns on thenetclasscollector (default: enabled).--collector.netdevβ turns on thenetdevcollector (default: enabled).--collector.netstatβ turns on thenetstatcollector (default: enabled).--collector.network_routeβ turns on thenetwork_routecollector (default: disabled).--collector.nfsβ turns on thenfscollector (default: enabled).--collector.nfsdβ turns on thenfsdcollector (default: enabled).--collector.ntpβ turns on thentpcollector (default: disabled).--collector.nvmeβ turns on thenvmecollector (default: enabled).--collector.nvmesubsystemβ turns on thenvmesubsystemcollector (default: disabled).--collector.osβ turns on theoscollector (default: enabled).--collector.pcideviceβ turns on thepcidevicecollector (default: disabled).--collector.perfβ turns on theperfcollector (default: disabled).--collector.powersupplyclassβ turns on thepowersupplyclasscollector (default: enabled).--collector.pressureβ turns on thepressurecollector (default: enabled).--collector.processesβ turns on theprocessescollector (default: disabled).--collector.qdiscβ turns on theqdisccollector (default: disabled).--collector.raplβ turns on theraplcollector (default: enabled).--collector.runitβ turns on therunitcollector (default: disabled).--collector.schedstatβ turns on theschedstatcollector (default: enabled).--collector.selinuxβ turns on theselinuxcollector (default: enabled).--collector.slabinfoβ turns on theslabinfocollector (default: disabled).--collector.sockstatβ turns on thesockstatcollector (default: enabled).--collector.softirqsβ turns on thesoftirqscollector (default: disabled).--collector.softnetβ turns on thesoftnetcollector (default: enabled).--collector.statβ turns on thestatcollector (default: enabled).--collector.supervisordβ turns on thesupervisordcollector (default: disabled).--collector.swapβ turns on theswapcollector (default: disabled).--collector.sysctlβ turns on thesysctlcollector (default: disabled).--collector.systemdβ turns on thesystemdcollector (default: enabled).--collector.tapestatsβ turns on thetapestatscollector (default: enabled).--collector.tcpstatβ turns on thetcpstatcollector (default: disabled).--collector.textfileβ turns on thetextfilecollector (default: enabled).--collector.thermal_zoneβ turns on thethermal_zonecollector (default: enabled).--collector.timeβ turns on thetimecollector (default: enabled).--collector.timexβ turns on thetimexcollector (default: enabled).--collector.udp_queuesβ turns on theudp_queuescollector (default: enabled).--collector.unameβ turns on theunamecollector (default: enabled).--collector.vmstatβ turns on thevmstatcollector (default: enabled).--collector.watchdogβ turns on thewatchdogcollector (default: enabled).--collector.wifiβ turns on thewificollector (default: disabled).--collector.xfrmβ turns on thexfrmcollector (default: disabled).--collector.xfsβ turns on thexfscollector (default: enabled).--collector.zfsβ turns on thezfscollector (default: enabled).--collector.zoneinfoβ turns on thezoneinfocollector (default: disabled).
okay now the web/server vibes, aka where your metrics actually live π¦
--web.telemetry-path="/metrics"β the path where your metrics get exposed. The default is"/metrics", iconic, don't touch it if you don't have to.--web.disable-exporter-metricsβ excludes the metrics about the exporter itself β that's thepromhttp_*,process_*, andgo_*families. literally "no thoughts about myself" mode π--web.max-requests=40β the maximum number of parallel scrape requests. default is40. and bestie, use0to disable it entirely.--collector.disable-defaultsβ sets all collectors to disabled by default. full reset, start from zero, main character energy π₯--runtime.gomaxprocs=1β the target number of CPUs Go will run on (GOMAXPROCS). default is1.--web.systemd-socketβ uses systemd socket activation listeners instead of port listeners. Linux only, so if you're on anything else, this is not your moment π«Ά--web.listen-address=:9100β the addresses where the metrics and web interface get exposed. It's repeatable for multiple addresses! Examples::9100or[::1]:9100for http, andvsock://:9100for vsock. ngl, that's several vibes.--web.config.file=""β path to a configuration file that can enable TLS or authentication. default is"". See this doc for the deets:
https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
--log.level=infoβ only log messages with this severity or above. one of:[debug, info, warn, error]. default isinfo.--log.format=logfmtβ output format of log messages. one of:[logfmt, json]. default islogfmt.--versionβ show application version. slay, that's it.
π and that's the whole page, bestie β you ate π
the footer down there keeps the version deets and the date, and it very cutely says node_exporter sits alongside prometheus-node-exporter(1), so likeβ¦ that's the source info + version + date, all wrapped up in the bottom line the way the classic manpages do it. periodt. πΈ
π¦ where this page comes from
- epel 9: node-exporter 1.12.1-1.el9 Β· Apache-2.0 AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND MIT AND MPL-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms