Validate and generate schema output¶

Use these workflows after changing an Agent configuration setting. The schema overview explains how the generated artifacts relate to the source, and the CLI reference lists command arguments.

Validate changes and regenerate Go code¶

After editing the schema, validate it and regenerate the Go files that register settings:

dda inv schema.lint
dda inv schema.codegen

Generate configuration examples¶

The Agent build generates configuration examples automatically. To validate all generated examples locally, run:

dda inv schema.template-all

To preview the example for one platform without running the whole build, render it to a temporary file:

dda inv schema.template \
  --schema=./pkg/config/schema/yaml/core_schema.yaml \
  --build-type=datadog-agent \
  --os-target=linux \
  --output=/tmp/datadog.yaml.example

Choose an output path suitable for your operating system. See the template command reference for supported build types and platforms.

Locate a setting¶

Find a setting's schema node and the source file and line where it is declared:

dda inv -- schema.locate apm_config.enabled

To list every setting whose path ends in enabled, use a pattern:

dda inv -- schema.locate '*enabled'

See the lookup command reference for regular expressions, schema selection, and JSON output.