Skip to content

Commit 48a3a1c

Browse files
Update integrations-core digest to b383598 (#54919)
This PR contains the following updates: | Package | Update | Change | |---|---|---| | integrations-core ([changelog](https://redirect.github.com/DataDog/integrations-core/compare/3bce68335dbbf693c3dde72d6fe0792b3e742f33..b383598fb85f73824847106f856eefb7c89b47bf)) | digest | `3bce683` → `b383598` | --- > [!WARNING] > Some dependencies could not be looked up. Check the [Dependency Dashboard](../issues/33469) for more information. --- ### Configuration 📅 **Schedule**: (in timezone Europe/Paris) - Branch creation - Between 02:00 AM and 06:59 AM, only on Monday and Wednesday (`* 2-6 * * 1,3`) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/DataDog/datadog-agent). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4yOS41IiwidXBkYXRlZEluVmVyIjoiNDQuMjkuNSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiY2hhbmdlbG9nL25vLWNoYW5nZWxvZyIsImRlcGVuZGVuY2llcyIsInFhL25vLWNvZGUtY2hhbmdlIl19--> Co-authored-by: AAraKKe <juanpedro.araque@datadoghq.com> fec92d8
1 parent bf13400 commit 48a3a1c

64 files changed

Lines changed: 415 additions & 415 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

agent-schema/cli/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3996,7 +3996,7 @@
39963996

39973997

39983998

3999-
<h1 id="cli-commands-dda-inv-schema">CLI Commands (<code>dda inv schema.*</code>)<a class="headerlink" href="#cli-commands-dda-inv-schema" title="Permanent link">&para;</a></h1>
3999+
<h1 id="cli-commands-dda-inv-schema">CLI Commands (<code>dda inv schema.*</code>)</h1>
40004000
<p>The schema tooling is exposed through a set of <code>dda inv schema.*</code> invoke tasks
40014001
(defined in <code>tasks/schema/</code>). This page documents each command, its arguments,
40024002
and when you would run it.</p>
@@ -4005,7 +4005,7 @@ <h1 id="cli-commands-dda-inv-schema">CLI Commands (<code>dda inv schema.*</code>
40054005
pipelines, so you rarely need to invoke them by hand — but they are useful when
40064006
adding or editing settings, debugging schema problems, or regenerating output
40074007
locally.</p>
4008-
<h2 id="how-the-commands-fit-together">How the commands fit together<a class="headerlink" href="#how-the-commands-fit-together" title="Permanent link">&para;</a></h2>
4008+
<h2 id="how-the-commands-fit-together">How the commands fit together</h2>
40094009
<p>The schema files under <code>pkg/config/schema/yaml/</code> are the source of truth and are
40104010
edited by hand (or through <code>schema.add-setting</code>). Everything else is derived from
40114011
them:</p>
@@ -4021,7 +4021,7 @@ <h2 id="how-the-commands-fit-together">How the commands fit together<a class="he
40214021
external consumers.</li>
40224022
<li><code>schema.locate</code> finds where a setting is declared.</li>
40234023
</ul>
4024-
<h2 id="schemaadd-setting"><code>schema.add-setting</code><a class="headerlink" href="#schemaadd-setting" title="Permanent link">&para;</a></h2>
4024+
<h2 id="schemaadd-setting"><code>schema.add-setting</code></h2>
40254025
<p>Interactive wizard to add a new setting to the schema. It prompts for the
40264026
setting name (dotted path), type, default, visibility, and description, then
40274027
inserts the node into the correct schema file under <code>pkg/config/schema/yaml/</code>
@@ -4051,7 +4051,7 @@ <h2 id="schemaadd-setting"><code>schema.add-setting</code><a class="headerlink"
40514051
public with a description. It runs <code>schema.lint</code> at the end so any remaining
40524052
problems are visible.</p>
40534053
<hr />
4054-
<h2 id="schemalint"><code>schema.lint</code><a class="headerlink" href="#schemalint" title="Permanent link">&para;</a></h2>
4054+
<h2 id="schemalint"><code>schema.lint</code></h2>
40554055
<p>Validate the schema against the schema quality rules and exit
40564056
non-zero on any violation.</p>
40574057
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>dda<span class="w"> </span>inv<span class="w"> </span>schema.lint
@@ -4081,7 +4081,7 @@ <h2 id="schemalint"><code>schema.lint</code><a class="headerlink" href="#schemal
40814081
</tbody>
40824082
</table>
40834083
<hr />
4084-
<h2 id="schematemplate"><code>schema.template</code><a class="headerlink" href="#schematemplate" title="Permanent link">&para;</a></h2>
4084+
<h2 id="schematemplate"><code>schema.template</code></h2>
40854085
<p>Render a single config template (one build type, one OS) from the schema file. Useful for inspecting what a setting will
40864086
look like in the generated example without running the whole build.</p>
40874087
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>dda<span class="w"> </span>inv<span class="w"> </span>schema.template<span class="w"> </span><span class="se">\</span>
@@ -4125,7 +4125,7 @@ <h2 id="schematemplate"><code>schema.template</code><a class="headerlink" href="
41254125
template sections are included; the OS target controls which platform-specific
41264126
defaults and <code>platform_only</code> settings are emitted.</p>
41274127
<hr />
4128-
<h2 id="schemalocate"><code>schema.locate</code><a class="headerlink" href="#schemalocate" title="Permanent link">&para;</a></h2>
4128+
<h2 id="schemalocate"><code>schema.locate</code></h2>
41294129
<p>Find where a setting or section is defined in the schema source and print its
41304130
node plus the exact file and line.</p>
41314131
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>dda<span class="w"> </span>inv<span class="w"> </span>--<span class="w"> </span>schema.locate<span class="w"> </span>apm_config.enabled
@@ -4153,7 +4153,7 @@ <h2 id="schemalocate"><code>schema.locate</code><a class="headerlink" href="#sch
41534153
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>dda<span class="w"> </span>inv<span class="w"> </span>--<span class="w"> </span>schema.locate<span class="w"> </span><span class="s1">&#39;apm_config\..*enabled&#39;</span><span class="w"> </span>--json
41544154
</span></code></pre></div>
41554155
<hr />
4156-
<h2 id="typical-workflows">Typical workflows<a class="headerlink" href="#typical-workflows" title="Permanent link">&para;</a></h2>
4156+
<h2 id="typical-workflows">Typical workflows</h2>
41574157
<p><strong>I edited a setting in the schema and want the Go code to reflect it:</strong></p>
41584158
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>dda<span class="w"> </span>inv<span class="w"> </span>schema.lint<span class="w"> </span><span class="c1"># validate the schema</span>
41594159
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>dda<span class="w"> </span>inv<span class="w"> </span>schema.codegen<span class="w"> </span><span class="c1"># regenerate pkg/config/setup from it</span>
@@ -4167,7 +4167,7 @@ <h2 id="typical-workflows">Typical workflows<a class="headerlink" href="#typical
41674167
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>dda<span class="w"> </span>inv<span class="w"> </span>--<span class="w"> </span>schema.locate<span class="w"> </span>apm_config.enabled<span class="w"> </span><span class="c1"># exact: node + file:line</span>
41684168
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>dda<span class="w"> </span>inv<span class="w"> </span>--<span class="w"> </span>schema.locate<span class="w"> </span><span class="s1">&#39;*enabled&#39;</span><span class="w"> </span><span class="c1"># pattern: all paths ending in &quot;enabled&quot;</span>
41694169
</span></code></pre></div>
4170-
<h2 id="see-also">See also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
4170+
<h2 id="see-also">See also</h2>
41714171
<ul>
41724172
<li><a href="../">Introduction</a> — what the schema is and why it exists.</li>
41734173
<li><a href="../keywords/">Keyword Reference</a> — the keywords these commands read and write.</li>

agent-schema/examples/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3908,12 +3908,12 @@
39083908

39093909

39103910

3911-
<h1 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h1>
3911+
<h1 id="examples">Examples</h1>
39123912
<p>This page walks through three annotated examples taken from or inspired by the
39133913
real schema files. Each example builds on the concepts introduced in the
39143914
<a href="../keywords/">Keyword Reference</a>.</p>
39153915
<hr />
3916-
<h2 id="example-1-simple-public-setting-node-api_key">Example 1 — Simple public setting node (<code>api_key</code>)<a class="headerlink" href="#example-1-simple-public-setting-node-api_key" title="Permanent link">&para;</a></h2>
3916+
<h2 id="example-1-simple-public-setting-node-api_key">Example 1 — Simple public setting node (<code>api_key</code>)</h2>
39173917
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">api_key</span><span class="p">:</span>
39183918
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">node_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">setting</span><span class="w"> </span><span class="c1"># (1)</span>
39193919
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">string</span><span class="w"> </span><span class="c1"># (2)</span>
@@ -3945,7 +3945,7 @@ <h2 id="example-1-simple-public-setting-node-api_key">Example 1 — Simple publi
39453945
and public documentation. Without this, the setting is considered internal.</li>
39463946
</ol>
39473947
<hr />
3948-
<h2 id="example-2-section-node-with-mixed-children-apm_config">Example 2 — Section node with mixed children (<code>apm_config</code>)<a class="headerlink" href="#example-2-section-node-with-mixed-children-apm_config" title="Permanent link">&para;</a></h2>
3948+
<h2 id="example-2-section-node-with-mixed-children-apm_config">Example 2 — Section node with mixed children (<code>apm_config</code>)</h2>
39493949
<p>This example shows a section node taken from <code>pkg/config/schema/core_schema.yaml</code>
39503950
with several child setting nodes, including one with a <code>platform_default</code>.</p>
39513951
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">apm_config</span><span class="p">:</span>
@@ -4009,7 +4009,7 @@ <h2 id="example-2-section-node-with-mixed-children-apm_config">Example 2 — Sec
40094009
is known, eg. setting a value for <code>other</code> which is Darwin specific when you already have a value for Linux and Windows.</li>
40104010
</ol>
40114011
<hr />
4012-
<h2 id="example-3-complex-nested-type-cel_workload_exclude">Example 3 — Complex nested type (<code>cel_workload_exclude</code>)<a class="headerlink" href="#example-3-complex-nested-type-cel_workload_exclude" title="Permanent link">&para;</a></h2>
4012+
<h2 id="example-3-complex-nested-type-cel_workload_exclude">Example 3 — Complex nested type (<code>cel_workload_exclude</code>)</h2>
40134013
<p>This example shows how JSON Schema's composable
40144014
validation handles a non-trivial type. <code>cel_workload_exclude</code> corresponds to
40154015
the following Go struct:</p>

agent-schema/faq/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3974,9 +3974,9 @@
39743974

39753975

39763976

3977-
<h1 id="faq">FAQ<a class="headerlink" href="#faq" title="Permanent link">&para;</a></h1>
3977+
<h1 id="faq">FAQ</h1>
39783978
<hr />
3979-
<h2 id="how-do-i-add-a-new-setting">How do I add a new setting?<a class="headerlink" href="#how-do-i-add-a-new-setting" title="Permanent link">&para;</a></h2>
3979+
<h2 id="how-do-i-add-a-new-setting">How do I add a new setting?</h2>
39803980
<ol>
39813981
<li>
39823982
<p><strong>Determine the node type.</strong> If the setting holds a value (string, number,
@@ -4019,12 +4019,12 @@ <h2 id="how-do-i-add-a-new-setting">How do I add a new setting?<a class="headerl
40194019
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Enables the new feature.</span>
40204020
</span></code></pre></div>
40214021
<hr />
4022-
<h2 id="how-do-i-deprecate-a-setting">How do I deprecate a setting?<a class="headerlink" href="#how-do-i-deprecate-a-setting" title="Permanent link">&para;</a></h2>
4022+
<h2 id="how-do-i-deprecate-a-setting">How do I deprecate a setting?</h2>
40234023
<blockquote>
40244024
<p><strong>Note:</strong> [WIP] Automated solution coming soon.</p>
40254025
</blockquote>
40264026
<hr />
4027-
<h2 id="how-do-i-make-a-setting-public">How do I make a setting public?<a class="headerlink" href="#how-do-i-make-a-setting-public" title="Permanent link">&para;</a></h2>
4027+
<h2 id="how-do-i-make-a-setting-public">How do I make a setting public?</h2>
40284028
<ol>
40294029
<li>
40304030
<p><strong>Write a <code>description</code></strong> that explains what the setting does, what the default means, and any caveats. Every public
@@ -4057,7 +4057,7 @@ <h2 id="how-do-i-make-a-setting-public">How do I make a setting public?<a class=
40574057
<p>The setting will appear in the configuration examples (ex: <code>datadog.yaml.example</code>) the next time the file is
40584058
regenerated.</p>
40594059
<hr />
4060-
<h2 id="how-do-i-document-a-public-setting">How do I document a public setting?<a class="headerlink" href="#how-do-i-document-a-public-setting" title="Permanent link">&para;</a></h2>
4060+
<h2 id="how-do-i-document-a-public-setting">How do I document a public setting?</h2>
40614061
<ol>
40624062
<li><strong>Write a clear <code>description</code></strong> covering:</li>
40634063
<li>What the setting does.</li>
@@ -4082,13 +4082,13 @@ <h2 id="how-do-i-document-a-public-setting">How do I document a public setting?<
40824082
<li><strong>Set <code>visibility: public</code></strong> to include the setting in generated output.</li>
40834083
</ol>
40844084
<hr />
4085-
<h2 id="how-do-i-generate-datadogyamlexample">How do I generate <code>datadog.yaml.example</code>?<a class="headerlink" href="#how-do-i-generate-datadogyamlexample" title="Permanent link">&para;</a></h2>
4085+
<h2 id="how-do-i-generate-datadogyamlexample">How do I generate <code>datadog.yaml.example</code>?</h2>
40864086
<p>The generation of <code>datadog.yaml.example</code> from the schema is wired into the
40874087
Agent's build pipeline and runs automatically. Developers do not normally need
40884088
to trigger it manually.</p>
40894089
<p>If you want to validate the generated example you can use <code>dda inv schema.template-all</code> command.</p>
40904090
<hr />
4091-
<h2 id="what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample">What is the difference between <code>datadog.yaml.example</code> and <code>system-probe.yaml.example</code>?<a class="headerlink" href="#what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample" title="Permanent link">&para;</a></h2>
4091+
<h2 id="what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample">What is the difference between <code>datadog.yaml.example</code> and <code>system-probe.yaml.example</code>?</h2>
40924092
<p>Each configuration file has its own schema and its own generated example file:</p>
40934093
<ul>
40944094
<li>

agent-schema/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3870,19 +3870,19 @@
38703870

38713871

38723872

3873-
<h1 id="agent-configuration-schema">Agent Configuration Schema<a class="headerlink" href="#agent-configuration-schema" title="Permanent link">&para;</a></h1>
3873+
<h1 id="agent-configuration-schema">Agent Configuration Schema</h1>
38743874
<p>The Datadog Agent configuration schema is a YAML-based
38753875
<a href="https://json-schema.org/">JSON Schema</a> that centrally describes every
38763876
configuration setting for the Agent. It is written in YAML for readability but
38773877
is fully compatible with JSON Schema tooling.</p>
3878-
<h2 id="why-it-exists">Why it exists<a class="headerlink" href="#why-it-exists" title="Permanent link">&para;</a></h2>
3878+
<h2 id="why-it-exists">Why it exists</h2>
38793879
<p>Previously, Agent configuration was defined through a combination of imperative Go code (<code>BindEnvAndSetDefault</code> calls in
38803880
<code>pkg/config/setup</code>), YAML example files maintained by-hand, and scattered validation logic. This made it hard to
38813881
understand what a setting does, what values it accepts, or what its default is — without reading source code.</p>
38823882
<p>The schema replaces this with a <strong>single source of truth</strong>. All information
38833883
about a setting — its type, default value, documentation, environment variables,
38843884
validation rules, and visibility — lives in one place.</p>
3885-
<h2 id="what-it-enables">What it enables<a class="headerlink" href="#what-it-enables" title="Permanent link">&para;</a></h2>
3885+
<h2 id="what-it-enables">What it enables</h2>
38863886
<ul>
38873887
<li><strong>Config validation without running the Agent</strong> — any JSON Schema library can
38883888
validate a customer's <code>datadog.yaml</code> against the schema.</li>
@@ -3896,15 +3896,15 @@ <h2 id="what-it-enables">What it enables<a class="headerlink" href="#what-it-ena
38963896
<li><strong>Runtime validation</strong> — The user configuration can be validate at runtime by the Agent allowing automatic fallback
38973897
to default upon an invalid value.</li>
38983898
</ul>
3899-
<h2 id="terminology">Terminology<a class="headerlink" href="#terminology" title="Permanent link">&para;</a></h2>
3899+
<h2 id="terminology">Terminology</h2>
39003900
<ul>
39013901
<li><strong>Path</strong> — a string of terms separated by dots (<code>"."</code>) that represents a series of nodes in the config tree.</li>
39023902
<li><strong>Setting</strong> — a configurable value that can be located using a path (example <code>apm_config.enabled</code>)</li>
39033903
<li><strong>Section</strong> — a groupping of settings under a common name (example <code>apm_config</code>)</li>
39043904
<li><strong>Object</strong> — a data type of key-value pairs. Also called a map (in Go) or dict (in Python), but called an object in JSON Schema since it comes from JavaScript.</li>
39053905
<li><strong>Default</strong> — the value that will be retrieved for a given setting if none is specified by the user's file-based configuration or environment variable (or other source).</li>
39063906
</ul>
3907-
<h2 id="node-types">Node types<a class="headerlink" href="#node-types" title="Permanent link">&para;</a></h2>
3907+
<h2 id="node-types">Node types</h2>
39083908
<p>The schema tree is composed of two types of nodes:</p>
39093909
<ul>
39103910
<li><strong>Setting nodes</strong> represent individual settings. They have a type and a value.
@@ -3917,7 +3917,7 @@ <h2 id="node-types">Node types<a class="headerlink" href="#node-types" title="Pe
39173917
<p>The distinction matters when a setting's value is an object. For example, <code>docker_labels_as_tags</code> is a <code>type: object</code>
39183918
setting node — its value is a dict of strings, but that dict is the setting's <em>value</em>, not a group of child settings. It
39193919
is a setting node, and <strong>not</strong> a section node.</p>
3920-
<h2 id="one-schema-per-configuration-file">One schema per configuration file<a class="headerlink" href="#one-schema-per-configuration-file" title="Permanent link">&para;</a></h2>
3920+
<h2 id="one-schema-per-configuration-file">One schema per configuration file</h2>
39213921
<p>The Agent ships with multiple configuration files, each with its own schema:</p>
39223922
<table>
39233923
<thead>
@@ -3938,12 +3938,12 @@ <h2 id="one-schema-per-configuration-file">One schema per configuration file<a c
39383938
</tbody>
39393939
</table>
39403940
<p>All schemas share the same keyword set described in this documentation.</p>
3941-
<h2 id="json-schema-foundation">JSON Schema foundation<a class="headerlink" href="#json-schema-foundation" title="Permanent link">&para;</a></h2>
3941+
<h2 id="json-schema-foundation">JSON Schema foundation</h2>
39423942
<p>The Agent schema builds on <a href="https://json-schema.org/">JSON Schema draft 2020-12</a>.
39433943
This documentation focuses on how keywords are used in the Agent schema
39443944
specifically. For a general introduction to JSON Schema, see
39453945
<a href="https://json-schema.org/understanding-json-schema">Understanding JSON Schema</a>.</p>
3946-
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
3946+
<h2 id="next-steps">Next steps</h2>
39473947
<ul>
39483948
<li><a href="keywords/">Keyword Reference</a> — complete reference for all supported keywords.</li>
39493949
<li><a href="examples/">Examples</a> — annotated, real-world examples from the schema.</li>

0 commit comments

Comments
 (0)