node_exporter

(★ 13,711)

Exporter for machine metrics

File Explorer

  • .dockerignore
  • .gitignore
  • .golangci.yml
  • .promu-cgo.yml
  • .promu.yml
  • .yamllint
  • AGENTS.md
  • CHANGELOG.md
  • checkmetrics.sh
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile.distroless
  • end-to-end-test.sh
  • example-rules.yml
  • go.mod
  • go.sum
  • LICENSE
  • MAINTAINERS.md
  • Makefile
  • Makefile.common
  • node_exporter.go
  • node_exporter_test.go
  • NOTICE
  • README.md
  • SECURITY.md
  • staticcheck.conf
  • test_image.sh
  • tls_config_noAuth.bad.yml
  • ttar
  • VERSION

# Installation Guide

go
Prerequisites

Setup Steps

docker run -d --net="host" --pid="host" -v "/:/host:ro,rslave" quay.io/prometheus/node-exporter:latest --path.rootfs=/host

Run node_exporter in the background using Docker for host system monitoring.

Key Commands

docker run -d --net="host" --pid="host" -v "/:/host:ro,rslave" quay.io/prometheus/node-exporter:latest --path.rootfs=/host

Run the node_exporter container with permissions and volumes configured to access the host root filesystem.

When deploying as a container, --net="host" and --pid="host" flags are required to access host namespaces.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Release Timeline

Actively Maintained

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

docker run

View Details ▼

This command is an alias of `docker container run`.

tldr docker container run

View documentation for the original command:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

netstat

View Details ▼

Display network-related information such as open connections, open socket ports, etc.
See also: `ss`.

netstat {{[-a|--all]}}

List all ports:

netstat -p {{protocol}}

Display the PID and program name listening on a specific protocol:

netstat

Display active TCP connections:

🔍

ethtool

View Details ▼

Display and modify Network Interface Controller (NIC) parameters.

ethtool {{eth0}}

Display the current settings for an interface:

ethtool {{[-i|--driver]}} {{eth0}}

Display the driver information for an interface:

ethtool {{[-k|--show-features]}} {{eth0}}

Display all supported features for an interface:

🔍

perf

View Details ▼

Framework for Linux performance counter measurements.

perf stat {{gcc hello.c}}

Display basic performance counter stats for a command:

sudo perf top

Display system-wide real-time performance counter profile:

sudo perf record {{command}}

Run a command and record its profile into `perf.data`:

🔍

sysctl

View Details ▼

List and change kernel runtime variables.

sysctl {{[-a|--all]}}

Show all available variables and their values:

sysctl -a

Show all available variables and their values:

sysctl {{[-w|--write]}} {{section.tunable}}={{value}}

Set a changeable kernel state variable:

🔍

pmset

View Details ▼

Configure macOS power management settings, as one might do in System Preferences > Energy Saver.
Commands that modify settings must begin with `sudo`.

pmset -g

Display the current power management settings:

pmset -g batt

Display the current power source and battery levels:

pmset displaysleepnow

Put display to sleep immediately:

🔍

nfsstat

View Details ▼

Display or reset the number of calls made to the NFS server.

nfsstat

Display the recorded number of calls made to the NFS server:

nfsstat -z

Reset the recorded number of calls made to the NFS server:

# Project Badges

  • Build Status Build Status Visit
  • bsd workflow bsd workflow
  • golangci-lint workflow golangci-lint workflow
// repository documentation