CLI Commands (dda inv schema.*)¶

The schema tooling is exposed through a set of dda inv schema.* invoke tasks (defined in tasks/schema/). This page documents each command, its arguments, and when you would run it.

These commands are aimed at Agent developers and AI tooling running on the repository. Most of them run automatically as part of the build and CI pipelines, so you rarely need to invoke them by hand — but they are useful when adding or editing settings, debugging schema problems, or regenerating output locally.

How the commands fit together¶

schema.generate¶

Generate the enriched schema files for the core Agent and system-probe.

dda inv schema.generate --agent-bin=./bin/agent/agent

The command:

1. Runs the Agent binary (createschema) to produce the base schemas for both the core and system-probe targets.
2. Enriches them with documentation pulled from pkg/config/config_template.yaml and pkg/config/system-probe_template.yaml.
3. Applies OS-specific fixes and code-extracted comments.
4. Writes the result to pkg/config/schema/yaml/ — large top-level sections of the core schema are split into sibling <section>.yaml files referenced via $ref.

!!! warning "Build the Agent first" schema.generate runs the Agent binary to extract the live configuration. If the binary is missing it exits with an error pointing you to dda inv agent.build. Rebuild after changing any pkg/config/setup code so the schema reflects your changes.

schema.lint¶

Validate the schema against the schema quality rules and exit non-zero on any violation. This is the check enforced in CI (generate_config_schema-linux).

dda inv schema.lint

schema.template¶

Render a single config template (one build type, one OS) from the schema file. Useful for inspecting what a setting will look like in the generated example without running the whole build.

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

Only nodes with visibility: public are rendered. The build type selects which template sections are included; the OS target controls which platform-specific defaults and platform_only settings are emitted.

schema.template-all¶

Render every combination of build type × OS target from the core and system-probe schemas at once. This is what the build pipeline uses to keep the shipped *.yaml.example files in sync.

dda inv schema.template-all \
  --core-schema=./pkg/config/schema/yaml/core_schema.yaml \
  --sysprobe-schema=./pkg/config/schema/yaml/system-probe_schema.yaml \
  --output-dir=/tmp/templates

schema.locate¶

Find where a setting or section is defined in the schema source and print its node plus the exact file and line.

dda inv -- schema.locate apm_config.enabled

| Argument | Required | Description | | --- | --- | --- | --- | | setting | yes | A dotted config path (api_key, proxy.https, apm_config.enabled) or a pattern (see below). Positional — use -- so invoke does not treat a leading - or * as a flag. | | --target | no | Restrict the search to a single schema: core or system-probe. | | --json | no | Emit a JSON array of {schema, path, file, line, node} instead of human-readable text. |

Exact paths print the full node with a [<schema>] <file>:<line> header. A setting inside a split section (e.g. apm_config.enabled) is reported in its sub-file (pkg/config/schema/yaml/apm_config.yaml:<line>) — the file you would edit. A bare split section is reported at its $ref: line in core_schema.yaml, with its properties collapsed to the sorted list of child key names.

Patterns — any argument containing a character outside [A-Za-z0-9_.] is matched against every full dotted path in the schema instead of looked up exactly. The pattern is treated as a regular expression (re.search); if it is not valid regex it falls back to shell-style glob (fnmatch). Pattern matches print as a compact, sorted [<schema>] <path> -> <file>:<line> list (one line per match); use --json for the full node array.

# Exact: setting inside a split section → resolves into the sub-file
dda inv -- schema.locate apm_config.enabled

# Pattern (glob): every setting whose full path ends with "enabled"
dda inv -- schema.locate '*enabled'

# Pattern (regex): every path under apm_config ending in "enabled", as JSON
dda inv -- schema.locate 'apm_config\..*enabled' --json

Typical workflows¶

I edited a setting in pkg/config/setup and want the schema to reflect it:

dda inv agent.build                                  # rebuild the binary
dda inv schema.generate --agent-bin=./bin/agent/agent  # regenerate the schema
dda inv schema.lint                                  # validate it

I want to preview the generated example for one platform:

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

I want to find where a setting is defined, or list every setting matching a pattern:

dda inv -- schema.locate apm_config.enabled   # exact: node + file:line
dda inv -- schema.locate '*enabled'           # pattern: all paths ending in "enabled"

See also¶

• Introduction — what the schema is and why it exists.
• Keyword Reference — the keywords these commands read and write.
• FAQ — adding, documenting, and publishing settings.