Skip to content

Commit e3a0ca0

Browse files
mbertroneclaude
andcommitted
fix(gpu): document enable_ebpf_probes in the system-probe config
With the probes off by default, the gpu_monitoring docs were wrong on two counts: they said enabling the module loads the eBPF programs, and they never mentioned the flag that now controls them. A user following the deprecation note could not find enable_ebpf_probes in their config file, because the setting was not public and so never rendered into the template. - describe the module in terms of the NVML metrics it always collects - expose enable_ebpf_probes as a public setting, marked deprecated, so it appears in the generated system-probe.yaml pkg/config/system-probe_template.yaml is the source the schema enrichment reads (schema.generate -> parse_template), and check_config_templates.sh asserts both render identically, so the two files move together. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 0794237 commit e3a0ca0

2 files changed

Lines changed: 21 additions & 8 deletions

File tree

pkg/config/schema/yaml/system-probe_schema.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,8 +1273,8 @@ properties:
12731273
type: object
12741274
visibility: public
12751275
description: |-
1276-
Configuration for the GPU Monitoring module, which uses eBPF probes to collect
1277-
per-process GPU metrics on Linux hosts (kernel 5.8+).
1276+
Configuration for the GPU Monitoring module, which collects per-process GPU
1277+
metrics on Linux hosts.
12781278
Required for GPU monitoring on non-containerized Linux hosts alongside
12791279
gpu.enabled: true in datadog.yaml.
12801280
tags: []
@@ -1285,8 +1285,8 @@ properties:
12851285
default: false
12861286
visibility: public
12871287
description: |-
1288-
Set to true to enable the GPU Monitoring module. This loads the eBPF programs
1289-
that collect per-process GPU utilization, memory, and performance metrics.
1288+
Set to true to enable the GPU Monitoring module, which collects per-process
1289+
GPU utilization, memory, and performance metrics through NVML.
12901290
Must be used together with gpu.enabled: true in datadog.yaml.
12911291
attacher_detailed_logs:
12921292
node_type: setting
@@ -1318,6 +1318,11 @@ properties:
13181318
node_type: setting
13191319
type: boolean
13201320
default: false
1321+
visibility: public
1322+
description: |-
1323+
Set to true to additionally load the GPU Monitoring eBPF probes, which collect
1324+
the gpu.process.core.usage metric. Requires Linux kernel 5.8 or later.
1325+
These probes are deprecated and are disabled by default.
13211326
enable_fatbin_parsing:
13221327
node_type: setting
13231328
type: boolean

pkg/config/system-probe_template.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,21 +242,29 @@
242242
########################################
243243

244244
## @param gpu_monitoring - custom object - optional
245-
## Configuration for the GPU Monitoring module, which uses eBPF probes to collect
246-
## per-process GPU metrics on Linux hosts (kernel 5.8+).
245+
## Configuration for the GPU Monitoring module, which collects per-process GPU
246+
## metrics on Linux hosts.
247247
## Required for GPU monitoring on non-containerized Linux hosts alongside
248248
## gpu.enabled: true in datadog.yaml.
249249
#
250250
# gpu_monitoring:
251251

252252
# # @param enabled - boolean - optional - default: false
253253
# # @env DD_GPU_MONITORING_ENABLED - boolean - optional - default: false
254-
# # Set to true to enable the GPU Monitoring module. This loads the eBPF programs
255-
# # that collect per-process GPU utilization, memory, and performance metrics.
254+
# # Set to true to enable the GPU Monitoring module, which collects per-process
255+
# # GPU utilization, memory, and performance metrics through NVML.
256256
# # Must be used together with gpu.enabled: true in datadog.yaml.
257257
#
258258
# enabled: false
259259

260+
# # @param enable_ebpf_probes - boolean - optional - default: false
261+
# # @env DD_GPU_MONITORING_ENABLE_EBPF_PROBES - boolean - optional - default: false
262+
# # Set to true to additionally load the GPU Monitoring eBPF probes, which collect
263+
# # the gpu.process.core.usage metric. Requires Linux kernel 5.8 or later.
264+
# # These probes are deprecated and are disabled by default.
265+
#
266+
# enable_ebpf_probes: false
267+
260268
{{- if (eq .OS "windows") }}
261269

262270
##################################################

0 commit comments

Comments
 (0)