README
¶
DCGM Exporter
DCGM Exporter exposes NVIDIA GPU telemetry from NVIDIA Data Center GPU Manager (DCGM) in the Prometheus text format. This repository contains the exporter source, container and package builds, Helm chart, tests, and dashboards.
Documentation
Use the official NVIDIA documentation for user guidance:
- Install DCGM Exporter
- Configure Prometheus for DCGM Exporter
dcgm-exportercommand reference- DCGM Exporter Metrics
- DCGM Exporter Release Notes
The installation guide covers deployment, configuration, verification, administration, and troubleshooting.
Version compatibility
Run DCGM Exporter with the DCGM version paired with that exporter release. See Version Compatibility for supported package and remote-connection combinations.
Repository resources
- Helm chart configuration and troubleshooting
- Contribution requirements and development workflow
- Kubernetes integration and end-to-end tests
- Container tests and image examples
- Default metric collectors
Dashboards
- NVIDIA DCGM Exporter dashboard for Grafana
- Checked-in Grafana dashboard:
grafana/dcgm-exporter-dashboard.json - Community OpenObserve dashboard and integration guide
Contributing and support
Read CONTRIBUTING.md before submitting a change. For community support, open an issue.
Report potential security vulnerabilities through the NVIDIA Product Security process, not through a public issue. See SECURITY.md for reporting details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dcgm-exporter
command
|
|
|
e2e
command
Package main provides the e2e validation CLI entrypoint.
|
Package main provides the e2e validation CLI entrypoint. |
|
hack
|
|
|
bump-go-dcgm
command
|
|
|
licenses
command
Command generate creates third-party notice bundles for the shipping binary and assembles those notices with package legal files for the distroless image.
|
Command generate creates third-party notice bundles for the shipping binary and assembles those notices with package legal files for the distroless image. |
|
internal
|
|
|
e2e/capability
Package capability records host, cluster, and remote DCGM readiness.
|
Package capability records host, cluster, and remote DCGM readiness. |
|
e2e/cli
Package cli provides the e2e validation command tree.
|
Package cli provides the e2e validation command tree. |
|
e2e/cluster
Package cluster implements operational Kubernetes/k3d commands for e2e.
|
Package cluster implements operational Kubernetes/k3d commands for e2e. |
|
e2e/config
Package config contains parsed e2e CLI options.
|
Package config contains parsed e2e CLI options. |
|
e2e/exec
Package exec defines the command-runner seam used by e2e orchestration.
|
Package exec defines the command-runner seam used by e2e orchestration. |
|
e2e/image
Package image parses complete Docker/OCI image references used by e2e.
|
Package image parses complete Docker/OCI image references used by e2e. |
|
e2e/installdeps
Package installdeps installs or verifies host tools used by e2e runs.
|
Package installdeps installs or verifies host tools used by e2e runs. |
|
e2e/marker
Package marker formats NVIDIA test result markers.
|
Package marker formats NVIDIA test result markers. |
|
e2e/mig
Package mig prepares and restores host MIG state for e2e cluster runs.
|
Package mig prepares and restores host MIG state for e2e cluster runs. |
|
e2e/scenario
Package scenario owns the e2e scenario catalog and selector metadata.
|
Package scenario owns the e2e scenario catalog and selector metadata. |
|
e2e/suite
Package suite builds and runs e2e suite test binaries.
|
Package suite builds and runs e2e suite test binaries. |
|
mocks/pkg/collector
Package collector is a generated GoMock package.
|
Package collector is a generated GoMock package. |
|
mocks/pkg/dcgmprovider
Package dcgmprovider is a generated GoMock package.
|
Package dcgmprovider is a generated GoMock package. |
|
mocks/pkg/deviceinfo
Package deviceinfo is a generated GoMock package.
|
Package deviceinfo is a generated GoMock package. |
|
mocks/pkg/devicewatcher
Package devicewatcher is a generated GoMock package.
|
Package devicewatcher is a generated GoMock package. |
|
mocks/pkg/devicewatchlistmanager
Package devicewatchlistmanager is a generated GoMock package.
|
Package devicewatchlistmanager is a generated GoMock package. |
|
mocks/pkg/nvmlprovider
Package nvmlprovider is a generated GoMock package.
|
Package nvmlprovider is a generated GoMock package. |
|
mocks/pkg/os
Package os is a generated GoMock package.
|
Package os is a generated GoMock package. |
|
mocks/pkg/transformation
Package transformation is a generated GoMock package.
|
Package transformation is a generated GoMock package. |
|
mocks/pkg/transformations
Package transformation is a generated GoMock package.
|
Package transformation is a generated GoMock package. |
|
pkg/benchmarktest
Package benchmarktest provides deterministic inputs shared by CPU-only benchmark boundaries.
|
Package benchmarktest provides deterministic inputs shared by CPU-only benchmark boundaries. |
|
pkg/capabilities
Package capabilities provides Linux capability checking functionality for dcgm-exporter.
|
Package capabilities provides Linux capability checking functionality for dcgm-exporter. |
|
pkg/watcher
Package watcher provides interfaces and implementations for monitoring resources and triggering actions on changes.
|
Package watcher provides interfaces and implementations for monitoring resources and triggering actions on changes. |
|
pkg
|
|
|
tests
|
|
|
cmd/e2e-dcgm-probe
command
Command e2e-dcgm-probe reports the numeric field/entity contract exposed by an injected DCGM instance.
|
Command e2e-dcgm-probe reports the numeric field/entity contract exposed by an injected DCGM instance. |
|
container
Package container contains container-runtime integration tests.
|
Package container contains container-runtime integration tests. |
|
internal/dcgmprobe
Package dcgmprobe defines the private JSON contract shared by the DCGM e2e probe and its callers.
|
Package dcgmprobe defines the private JSON contract shared by the DCGM e2e probe and its callers. |
|
internal/nvmlinjection
Package nvmlinjection defines the temporary contract produced by the direct DCGM probe and consumed by black-box host integration tests.
|
Package nvmlinjection defines the temporary contract produced by the direct DCGM probe and consumed by black-box host integration tests. |
|
internal/nvsdmmock
Package nvsdmmock defines the temporary contract produced by the direct DCGM probe and consumed by black-box NVSDM mock host tests.
|
Package nvsdmmock defines the temporary contract produced by the direct DCGM probe and consumed by black-box NVSDM mock host tests. |
|
internal/resultmarker
Package resultmarker emits machine-readable result markers for Ginkgo specs.
|
Package resultmarker emits machine-readable result markers for Ginkgo specs. |
Click to show internal directories.
Click to hide internal directories.