Skip to content

Commit e9cb305

Browse files
authored
[DOCS-15417] Point to new example Agent config files (DataDog#39331)
* [DOCS-15417] Add back removed references, and update per-OS config references * Replace pinned-version and -line-number links to old config-template file * A few more from DataDog#39062
1 parent 5a19c3c commit e9cb305

24 files changed

Lines changed: 58 additions & 34 deletions

File tree

hugo/content/en/administrators_guide/getting_started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ The [Datadog Agent][2] is open-source and published in GitHub. The Agent GitHub
9494

9595
Here are a few examples:
9696

97+
* [Agent Config Examples][3]
9798
* [Integration Config Specs][4]
9899
* [Fleet Automation][5]
99100

@@ -108,6 +109,7 @@ To successfully create a new Datadog installation, review the [plan][11] page. Y
108109

109110
[1]: https://learn.datadoghq.com/
110111
[2]: https://github.com/DataDog/datadog-agent
112+
[3]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
111113
[4]: https://github.com/DataDog/integrations-core
112114
[5]: https://app.datadoghq.com/fleet
113115
[6]: /getting_started/tagging/unified_service_tagging/

hugo/content/en/agent/configuration/agent-configuration-files.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ algolia:
1616

1717
The location of the Agent configuration file differs depending on the operating system.
1818

19-
| Platform | Command |
20-
|:-------------------------------------|:-------------------------------------|
21-
| AIX | `/etc/datadog-agent/datadog.yaml` |
22-
| Linux | `/etc/datadog-agent/datadog.yaml` |
23-
| macOS | `/opt/datadog-agent/etc/datadog.yaml` |
24-
| Windows | `%ProgramData%\Datadog\datadog.yaml` |
19+
| Platform | Command | Example config |
20+
|:---------|:--------------------------------------|:------------------------------------------|
21+
| AIX | `/etc/datadog-agent/datadog.yaml` | [`datadog.yaml.example`][3] |
22+
| Linux | `/etc/datadog-agent/datadog.yaml` | [`datadog-agent_linux.yaml.example`][4] |
23+
| macOS | `/opt/datadog-agent/etc/datadog.yaml` | [`datadog-agent_darwin.yaml.example`][5] |
24+
| Windows | `%ProgramData%\Datadog\datadog.yaml` | [`datadog-agent_windows.yaml.example`][6] |
2525

2626
## Agent configuration directory
2727

@@ -69,4 +69,8 @@ For log collection, the Agent does not accept multiple YAML files that point to
6969

7070
JMX Agent checks have an additional `metrics.yaml` file in their configuration folder. It is a list of all the beans that the Datadog Agent collects by default. This way, you do not need to list all of the beans manually when you configure a check through [Docker labels or k8s annotations][2].
7171

72-
[2]: /agent/kubernetes/integrations/#configuration
72+
[2]: /agent/kubernetes/integrations/#configuration
73+
[3]: https://github.com/DataDog/datadog-unix-agent/blob/master/docs/datadog.yaml.example
74+
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
75+
[5]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_darwin.yaml.example
76+
[6]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example

hugo/content/en/agent/configuration/dual-shipping.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,7 @@ and add the relevant settings to `customAgentConfig`.
424424

425425
# agents.customAgentConfig -- Specify custom contents for the datadog agent config (datadog.yaml)
426426
## ref: https://docs.datadoghq.com/agent/configuration/agent-configuration-files/?tab=agentv6
427+
## ref: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
427428
## Note the `agents.useConfigMap` needs to be set to `true` for this parameter to be taken into account.
428429
customAgentConfig:
429430
additional_endpoints:

hugo/content/en/agent/guide/datadog-agent-manager-windows.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ The log page displays the Agent logs being output to `agent.log`. Logs can be so
115115

116116
The settings page displays the contents of the Agent's main configuration file `datadog.yaml`. You can edit this file directly from the Datadog Agent Manager. After making a change, click {{< ui >}}Save{{< /ui >}} in the upper right then [restart the Agent](#restart-agent).
117117

118+
For a full list of available options, see the [example `datadog.yaml` file for Windows][6].
119+
118120
### Checks
119121

120122
#### Manage checks
@@ -143,3 +145,4 @@ Clicking {{< ui >}}Restart Agent{{< /ui >}} from the left navigation bar restart
143145
[3]: /integrations/
144146
[4]: /help/
145147
[5]: /agent/troubleshooting/send_a_flare/
148+
[6]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example

hugo/content/en/agent/logs/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ logs_config:
3939
force_use_http: true
4040
{{< /code-block >}}
4141

42+
For all available configuration options, see the [example Agent configuration files][6] for your operating system.
43+
4244
<div class="alert alert-info">Starting with Agent v6.19+/v7.19+, HTTPS transport is the default transport used. For more details, see <a href="/agent/logs/log_transport/">Agent transport</a>.</div>
4345

4446
To send logs with **environment variables**, configure the following:
@@ -255,6 +257,7 @@ For both file and journald tailer types, if an `end` or `beginning` position is
255257
[3]: /containers/kubernetes/log/
256258
[4]: /containers/docker/log/
257259
[5]: /agent/configuration/agent-configuration-files/
260+
[6]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
258261
[7]: /agent/logs/log_transport/
259262
[8]: /agent/configuration/agent-commands/#restart-the-agent
260263
[9]: /agent/configuration/agent-commands/#agent-status-and-information

hugo/content/en/agent/supported_platforms/linux.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The Datadog Agent configuration file is located in `/etc/datadog-agent/datadog.y
5858
- `proxy`: HTTP/HTTPS proxy endpoints for outbound traffic (see [Datadog Agent Proxy Configuration][8])
5959
- Default tags, log level, and Datadog configurations
6060

61-
A fully commented reference file, located in `/etc/datadog-agent/datadog.yaml.example`, lists every available option for comparison or to copy and paste.
61+
A fully commented reference file, located in `/etc/datadog-agent/datadog.yaml.example`, lists every available option for comparison or to copy and paste. Alternatively, see the [example Agent configuration file for Linux][11] on GitHub.
6262

6363
### Integration files
6464
Configuration files for integrations live in `/etc/datadog-agent/conf.d/`. Each integration has its own sub-directory, `<INTEGRATION>.d/`, that contains:
@@ -158,3 +158,4 @@ See the instructions on how to [add packages to the embedded Agent][3] for more
158158
[8]: https://docs.datadoghq.com/agent/configuration/proxy/
159159
[9]: /tracing/trace_collection/automatic_instrumentation/single-step-apm/
160160
[10]: /tracing/trace_collection/automatic_instrumentation/single-step-apm/linux
161+
[11]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example

hugo/content/en/agent/supported_platforms/osx.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The [Datadog Agent configuration file][7] is located in `/opt/datadog-agent`. Th
6565
- `proxy`: HTTP/HTTPS proxy endpoints for outbound traffic (see [Datadog Agent Proxy Configuration][9])
6666
- Default tags, log levels, and Datadog configurations.
6767

68-
A fully commented reference file, located in `/opt/datadog-agent/etc/datadog.yaml.example`, lists every available option for comparison or copy-paste.
68+
A fully commented reference file, located in `/opt/datadog-agent/etc/datadog.yaml.example`, lists every available option for comparison or copy-paste. Alternatively, see the [example Agent configuration file for macOS][10] on GitHub.
6969

7070
### Integration files
7171
Configuration files for integrations are found in `/opt/datadog-agent/etc/conf.d/`. Each integration has its own sub-directory, `<INTEGRATION>.d/`, which contains:
@@ -105,4 +105,5 @@ See the instructions on how to [add packages to the embedded Agent][3] for more
105105
[7]: /agent/configuration/agent-configuration-files/#agent-main-configuration-file
106106
[8]: https://app.datadoghq.com/organization-settings/api-keys
107107
[9]: /agent/configuration/proxy/
108+
[10]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_darwin.yaml.example
108109
[11]: https://install.datadoghq.com/scripts/uninstall_mac_os.sh

hugo/content/en/agent/supported_platforms/sccm.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Microsoft SCCM (Systems Center Configuration Manager) is a configuration managem
6161

6262
SCCM packages allow you to deploy configuration files to your Datadog Agents, overwriting their default settings. An Agent configuration consists of a `datadog.yaml` configuration file and optional `conf.yaml` files for each integration. You must create a package for each configuration file you want to deploy.
6363

64-
1. Collect your `datadog.yaml` and `conf.yaml` files in a local SCCM machine folder.
64+
1. Collect your `datadog.yaml` and `conf.yaml` files in a local SCCM machine folder. See the [example Agent configuration file for Windows][4] for all available configuration options.
6565
1. Create an SCCM Package and select {{< ui >}}Standard program{{< /ui >}}.
6666
1. Select the location that contains the configuration file that you want to deploy to your Agents.
6767
1. Select a [Device collection][5] to deploy the changes to.
@@ -83,5 +83,6 @@ Restart the Agent service to observe your configuration changes:
8383
[1]: https://learn.microsoft.com/en-us/mem/configmgr/core/servers/deploy/configure/manage-content-and-content-infrastructure
8484
[2]: https://app.datadoghq.com/account/settings/agent/latest?platform=windows
8585
[3]: /agent/basic_agent_usage/windows/?tab=commandline#configuration
86+
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
8687
[5]: https://learn.microsoft.com/en-us/mem/configmgr/core/clients/manage/collections/create-collections#bkmk_create
8788
[6]: /agent/basic_agent_usage/windows/#agent-commands

hugo/content/en/agent/supported_platforms/windows.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Set the `/log <FILENAME>` msiexec option to configure an installation log file.
108108
The main Agent configuration file is located at
109109
`C:\ProgramData\Datadog\datadog.yaml`. This file is used for host-wide settings such as the API key, selected Datadog site, proxy parameters, host tags, and log level.
110110

111-
There is also a `datadog.yaml.example` file in the same directory, which is a fully commented reference with all available configuration options, useful for reference and copying specific settings.
111+
There is also a `datadog.yaml.example` file in the same directory, which is a fully commented reference with all available configuration options, useful for reference and copying specific settings. Alternatively, see the [example Agent configuration file for Windows][19] on GitHub.
112112

113113

114114
Configuration files for integrations are in:
@@ -285,5 +285,6 @@ After configuration is complete, [restart the Agent][11].
285285
[16]: https://app.datadoghq.com/fleet/install-agent/latest?platform=windows
286286
[17]: /agent/faq/windows-agent-ddagent-user/
287287
[18]: https://docs.datadoghq.com/agent/troubleshooting/
288+
[19]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
288289
[400]: https://windows-agent.datadoghq.com/datadog-agent-7-latest.amd64.msi
289290
[500]: https://app.datadoghq.com/organization-settings/api-keys

hugo/content/en/containers/docker/apm.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ Where your `<DATADOG_SITE>` is {{< region-param key="dd_site" code="true" >}} (d
7777

7878
Use the following environment variables to configure tracing for the Docker Agent.
7979

80+
For all available options and their defaults, see the `apm_config` section of the [example Agent configuration file][8].
81+
8082
`DD_API_KEY`
8183
: required - _string_
8284
<br/>Your [Datadog API key][1].
@@ -395,3 +397,4 @@ Refer to the [language-specific APM instrumentation docs][3] for tracer settings
395397
[5]: /tracing/guide/ignoring_apm_resources/
396398
[6]: /tracing/troubleshooting/agent_rate_limits
397399
[7]: /getting_started/site/
400+
[8]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example

0 commit comments

Comments
 (0)