Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions hugo/content/en/administrators_guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ The [Datadog Agent][2] is open-source and published in GitHub. The Agent GitHub

Here are a few examples:

* [Agent Config Examples][3]
* [Integration Config Specs][4]
* [Fleet Automation][5]

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

[1]: https://learn.datadoghq.com/
[2]: https://github.com/DataDog/datadog-agent
[3]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
[4]: https://github.com/DataDog/integrations-core
[5]: https://app.datadoghq.com/fleet
[6]: /getting_started/tagging/unified_service_tagging/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ algolia:

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

| Platform | Command |
|:-------------------------------------|:-------------------------------------|
| AIX | `/etc/datadog-agent/datadog.yaml` |
| Linux | `/etc/datadog-agent/datadog.yaml` |
| macOS | `/opt/datadog-agent/etc/datadog.yaml` |
| Windows | `%ProgramData%\Datadog\datadog.yaml` |
| Platform | Command | Example config |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose to add a column to the table here so we can link to each OS's file, rather than adding back the single line that was removed: https://github.com/DataDog/documentation/pull/39062/changes#diff-f5905e3ea70b6212accb2b082527190750c0fd8bc3ae5eb309ba82f9b60fc805L26

|:---------|:--------------------------------------|:------------------------------------------|
| AIX | `/etc/datadog-agent/datadog.yaml` | [`datadog.yaml.example`][3] |
| Linux | `/etc/datadog-agent/datadog.yaml` | [`datadog-agent_linux.yaml.example`][4] |
| macOS | `/opt/datadog-agent/etc/datadog.yaml` | [`datadog-agent_darwin.yaml.example`][5] |
| Windows | `%ProgramData%\Datadog\datadog.yaml` | [`datadog-agent_windows.yaml.example`][6] |

## Agent configuration directory

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

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].

[2]: /agent/kubernetes/integrations/#configuration
[2]: /agent/kubernetes/integrations/#configuration
[3]: https://github.com/DataDog/datadog-unix-agent/blob/master/docs/datadog.yaml.example
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
[5]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_darwin.yaml.example
[6]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
1 change: 1 addition & 0 deletions hugo/content/en/agent/configuration/dual-shipping.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,7 @@ and add the relevant settings to `customAgentConfig`.

# agents.customAgentConfig -- Specify custom contents for the datadog agent config (datadog.yaml)
## ref: https://docs.datadoghq.com/agent/configuration/agent-configuration-files/?tab=agentv6
## ref: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
## Note the `agents.useConfigMap` needs to be set to `true` for this parameter to be taken into account.
customAgentConfig:
additional_endpoints:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ The log page displays the Agent logs being output to `agent.log`. Logs can be so

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).

For a full list of available options, see the [example `datadog.yaml` file for Windows][6].

### Checks

#### Manage checks
Expand Down Expand Up @@ -143,3 +145,4 @@ Clicking {{< ui >}}Restart Agent{{< /ui >}} from the left navigation bar restart
[3]: /integrations/
[4]: /help/
[5]: /agent/troubleshooting/send_a_flare/
[6]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
3 changes: 3 additions & 0 deletions hugo/content/en/agent/logs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ logs_config:
force_use_http: true
{{< /code-block >}}

For all available configuration options, see the [example Agent configuration files][6] for your operating system.

<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>

To send logs with **environment variables**, configure the following:
Expand Down Expand Up @@ -255,6 +257,7 @@ For both file and journald tailer types, if an `end` or `beginning` position is
[3]: /containers/kubernetes/log/
[4]: /containers/docker/log/
[5]: /agent/configuration/agent-configuration-files/
[6]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
[7]: /agent/logs/log_transport/
[8]: /agent/configuration/agent-commands/#restart-the-agent
[9]: /agent/configuration/agent-commands/#agent-status-and-information
Expand Down
3 changes: 2 additions & 1 deletion hugo/content/en/agent/supported_platforms/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The Datadog Agent configuration file is located in `/etc/datadog-agent/datadog.y
- `proxy`: HTTP/HTTPS proxy endpoints for outbound traffic (see [Datadog Agent Proxy Configuration][8])
- Default tags, log level, and Datadog configurations

A fully commented reference file, located in `/etc/datadog-agent/datadog.yaml.example`, lists every available option for comparison or to copy and paste.
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.

### Integration files
Configuration files for integrations live in `/etc/datadog-agent/conf.d/`. Each integration has its own sub-directory, `<INTEGRATION>.d/`, that contains:
Expand Down Expand Up @@ -158,3 +158,4 @@ See the instructions on how to [add packages to the embedded Agent][3] for more
[8]: https://docs.datadoghq.com/agent/configuration/proxy/
[9]: /tracing/trace_collection/automatic_instrumentation/single-step-apm/
[10]: /tracing/trace_collection/automatic_instrumentation/single-step-apm/linux
[11]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
3 changes: 2 additions & 1 deletion hugo/content/en/agent/supported_platforms/osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The [Datadog Agent configuration file][7] is located in `/opt/datadog-agent`. Th
- `proxy`: HTTP/HTTPS proxy endpoints for outbound traffic (see [Datadog Agent Proxy Configuration][9])
- Default tags, log levels, and Datadog configurations.

A fully commented reference file, located in `/opt/datadog-agent/etc/datadog.yaml.example`, lists every available option for comparison or copy-paste.
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.

### Integration files
Configuration files for integrations are found in `/opt/datadog-agent/etc/conf.d/`. Each integration has its own sub-directory, `<INTEGRATION>.d/`, which contains:
Expand Down Expand Up @@ -105,4 +105,5 @@ See the instructions on how to [add packages to the embedded Agent][3] for more
[7]: /agent/configuration/agent-configuration-files/#agent-main-configuration-file
[8]: https://app.datadoghq.com/organization-settings/api-keys
[9]: /agent/configuration/proxy/
[10]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_darwin.yaml.example
[11]: https://install.datadoghq.com/scripts/uninstall_mac_os.sh
3 changes: 2 additions & 1 deletion hugo/content/en/agent/supported_platforms/sccm.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Microsoft SCCM (Systems Center Configuration Manager) is a configuration managem

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.

1. Collect your `datadog.yaml` and `conf.yaml` files in a local SCCM machine folder.
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.
1. Create an SCCM Package and select {{< ui >}}Standard program{{< /ui >}}.
1. Select the location that contains the configuration file that you want to deploy to your Agents.
1. Select a [Device collection][5] to deploy the changes to.
Expand All @@ -83,5 +83,6 @@ Restart the Agent service to observe your configuration changes:
[1]: https://learn.microsoft.com/en-us/mem/configmgr/core/servers/deploy/configure/manage-content-and-content-infrastructure
[2]: https://app.datadoghq.com/account/settings/agent/latest?platform=windows
[3]: /agent/basic_agent_usage/windows/?tab=commandline#configuration
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
[5]: https://learn.microsoft.com/en-us/mem/configmgr/core/clients/manage/collections/create-collections#bkmk_create
[6]: /agent/basic_agent_usage/windows/#agent-commands
3 changes: 2 additions & 1 deletion hugo/content/en/agent/supported_platforms/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Set the `/log <FILENAME>` msiexec option to configure an installation log file.
The main Agent configuration file is located at
`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.

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.
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.


Configuration files for integrations are in:
Expand Down Expand Up @@ -285,5 +285,6 @@ After configuration is complete, [restart the Agent][11].
[16]: https://app.datadoghq.com/fleet/install-agent/latest?platform=windows
[17]: /agent/faq/windows-agent-ddagent-user/
[18]: https://docs.datadoghq.com/agent/troubleshooting/
[19]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
[400]: https://windows-agent.datadoghq.com/datadog-agent-7-latest.amd64.msi
[500]: https://app.datadoghq.com/organization-settings/api-keys
3 changes: 3 additions & 0 deletions hugo/content/en/containers/docker/apm.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ Where your `<DATADOG_SITE>` is {{< region-param key="dd_site" code="true" >}} (d

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

For all available options and their defaults, see the `apm_config` section of the [example Agent configuration file][8].

`DD_API_KEY`
: required - _string_
<br/>Your [Datadog API key][1].
Expand Down Expand Up @@ -395,3 +397,4 @@ Refer to the [language-specific APM instrumentation docs][3] for tracer settings
[5]: /tracing/guide/ignoring_apm_resources/
[6]: /tracing/troubleshooting/agent_rate_limits
[7]: /getting_started/site/
[8]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
4 changes: 2 additions & 2 deletions hugo/content/en/containers/guide/operator-eks-addon.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Follow the instructions to set up the Datadog Agent by using the `DatadogAgent`

For all configuration options, see the [Operator configuration spec][6].

**Note:** If access to IMDS v1 is blocked on the node, the Agent cannot resolve the cluster name, and certain features (for example, [Orchestrator Explorer][6]) do not work. Hence, Datadog recommends adding `spec.global.ClusterName` in the `DatadogAgent` manifest. See this [comment][8] on how to configure the Agent to request metadata using IMDS v2.
**Note:** If access to IMDS v1 is blocked on the node, the Agent cannot resolve the cluster name, and certain features (for example, [Orchestrator Explorer][6]) do not work. Hence, Datadog recommends adding `spec.global.ClusterName` in the `DatadogAgent` manifest. For how to configure the Agent to request metadata using IMDS v2, see the `ec2_prefer_imdsv2` parameter in the [example Agent configuration file][8].

4. Deploy the Datadog Agent:
```bash
Expand Down Expand Up @@ -151,6 +151,6 @@ To delete the add-on, run:
[5]: https://app.datadoghq.com/organization-settings/api-keys
[6]: https://github.com/DataDog/datadog-operator/blob/main/docs/configuration.v2alpha1.md
[7]: https://docs.datadoghq.com/infrastructure/containers/orchestrator_explorer/?tab=datadogoperator
[8]: https://github.com/DataDog/datadog-agent/blob/4896a45f586f74de1da2e985f98988f0181afc36/pkg/config/config_template.yaml#L407-L416
[8]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
[9]: https://github.com/DataDog/datadog-operator/issues/654
[10]: /integrations/eks_fargate/#setup
4 changes: 2 additions & 2 deletions hugo/content/en/getting_started/agent/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ The Agent's main configuration file is `datadog.yaml`. The required parameters a
- Your [Datadog API key][16], which is used to associate the Agent's data with your organization.
- Your [Datadog site][41] ({{< region-param key="dd_site" code="true" >}}).

You can adjust the Agent configuration files to take advantage of other Datadog features.

For all available configuration options, see the [example Agent configuration files][23] for your operating system. You can adjust the Agent configuration files to take advantage of other Datadog features.

## Installation

Expand Down Expand Up @@ -282,6 +281,7 @@ For help troubleshooting the Agent:
[20]: https://app.datadoghq.com/event/explorer
[21]: /extend/service_checks/#visualize-your-service-check-in-datadog
[22]: https://app.datadoghq.com/metric/summary
[23]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example
[24]: /getting_started/tagging/
[25]: /agent/configuration/agent-configuration-files/#agent-main-configuration-file
[26]: /agent/configuration/agent-commands/#restart-the-agent
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kubernetes_kubeconfig_path: /path/to/file
[1]: https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod
[2]: https://kubernetes.io/docs/concepts/configuration/secret
[3]: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig
[4]: https://github.com/DataDog/datadog-agent/blob/a9e0c4f534482170817300edb3cce01df9abea4a/pkg/config/config_template.yaml#L687-L692
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Note: The old host in the Infrastructure List takes time before disappearing.
[1]: https://docs.datadoghq.com/integrations/vsphere/
[2]: https://app.datadoghq.com/infrastructure
[3]: https://github.com/DataDog/integrations-core/blob/21a90b00f603b00250c4baa6534e47ee5529ed3c/vsphere/datadog_checks/vsphere/data/conf.yaml.example#L301-L308
[4]: https://github.com/DataDog/datadog-agent/blob/6ba10dc8cd0c1aa89adcebe6b5941571caf25d50/pkg/config/config_template.yaml#L56-L61
[4]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The protected settings include:
This example shows how to specify a configuration for the Datadog Agent to use.
The Datadog Agent configuration URI must be an Azure blob storage URI.
The Datadog Windows Agent Azure Extension checks that the `agentConfiguration` URI comes from the `.blob.core.windows.net` domain.
The Datataog Agent configuration should be created from the `%PROGRAMDATA%\Datadog` folder.
The Datataog Agent configuration should be created from the `%PROGRAMDATA%\Datadog` folder (see the [example Agent configuration file for Windows][101] for all available configuration options).

<div class="alert alert-info">
To reuse the configuration of an existing Agent:
Expand Down Expand Up @@ -173,6 +173,7 @@ Set-AzVMExtension -Name "DatadogAgent" -Publisher "Datadog.Agent" -Type "Datadog
{{< /code-block >}}

[100]: https://learn.microsoft.com/powershell/module/az.compute/set-azvmextension
[101]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_windows.yaml.example
{{% /tab %}}
{{% tab "Linux" %}}

Expand Down Expand Up @@ -206,7 +207,7 @@ The protected settings include:
This example shows how to specify a configuration for the Datadog Agent to use.
- The Datadog Agent configuration URI must be an Azure blob storage URI.
- The Datadog Linux Agent Azure Extension checks that the `agentConfiguration` URI comes from the `.blob.core.windows.net` domain.
- The Datataog Agent configuration should be created from the `/etc/datadog-agent/` folder.
- The Datataog Agent configuration should be created from the `/etc/datadog-agent/` folder (see the [example Agent configuration file for Linux][201] for all available configuration options).

<div class="alert alert-info">
To reuse the configuration of an existing Agent by saving its <code>/etc/datadog-agent</code> folder as a ZIP file:
Expand All @@ -230,6 +231,7 @@ az vm extension set --publisher "Datadog.Agent" --name "DatadogLinuxAgent" --ver


[200]: https://learn.microsoft.com/cli/azure/vm/extension
[201]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
{{% /tab %}}
{{< /tabs >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ logs_config:

For containerized environments you can set the `DD_LOGS_CONFIG_OPEN_FILES_LIMIT` environment variable.

The default value varies depending on the Agent version and operating system. To check the default value for your Agent version, see the [config_template.yaml file][1] in the Datadog Agent repository. Be sure to select the tag corresponding to your Agent version to see the correct defaults.
The default value varies depending on the Agent version and operating system. To check the default value for your Agent version, see the [example Agent configuration files][1] in the Datadog Agent repository. Open the file for your operating system. Be sure to select the tag corresponding to your Agent version to see the correct defaults.

**Note**: Increasing the tailed logs files limit might increase the resource consumption of the Agent.

[1]: https://github.com/DataDog/datadog-agent/blob/369a8dbb39dc6e8601d82c8f43caaaf88d6a0a55/pkg/config/config_template.yaml#L987-L993
[1]: https://github.com/DataDog/datadog-agent/tree/main/pkg/config/example

5 changes: 2 additions & 3 deletions hugo/content/en/metrics/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,10 @@ If you send `X` values for a HISTOGRAM metric `<METRIC_NAME>` in a given time in
**Notes**:

- Configure which aggregations you want to send to Datadog with the `histogram_aggregates` parameter in your [`datadog.yaml` configuration file][1]. By default, only `max`, `median`, `avg`, and `count` aggregations are sent to Datadog. `sum` and `min` are also available.
- Configure which percentile aggregation you want to send to Datadog with the `histogram_percentiles` parameter in your [`datadog.yaml` configuration file][2]. By default, only the `95percentile` is sent to Datadog.
- Configure which percentile aggregation you want to send to Datadog with the `histogram_percentiles` parameter in your [`datadog.yaml` configuration file][1]. By default, only the `95percentile` is sent to Datadog.


[1]: https://github.com/DataDog/datadog-agent/blob/04d8ae9dd4bc6c7a64a8777e8a38127455ae3886/pkg/config/config_template.yaml#L106-L114
[2]: https://github.com/DataDog/datadog-agent/blob/04d8ae9dd4bc6c7a64a8777e8a38127455ae3886/pkg/config/config_template.yaml#L116-L121
[1]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
{{% /tab %}}
{{% tab "DISTRIBUTION" %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ clusterAgent:
#
datadog_cluster_yaml:

# See here for all `network_devices.autodiscovery` configs: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/example/datadog-agent_linux.yaml.example
autodiscovery:
workers: 2
discovery_interval: 10
Expand Down
Loading
Loading