Provides a configuration guide for the Datadog.yaml file, which is the configuration file for the main settings of the Datadog Agent.
Please see the file All available setup options are: config_template.yaml provided by datadog
※This guide covers Agent v6 and v7 only.
Datadog.yaml file path
The datadog.yaml file can be found in the following paths for each platform.
플랫폼 | 명령어 |
---|---|
AIX |
|
Linux |
|
macOS |
|
Windows |
|
Main setting items
1. Basic Configuration
- Required settings required
Item | Default settings | Environment variables | Explanation |
---|---|---|---|
api_key | DD_API_KEY | Sets the API key of the organization to which the Datadog agent sends collected data (Organization Setting>Api Key). | |
site | datadoghq.com | DD_SITE | Sets the Datadog site where data is collected. US1 : datadoghq.com |
- Main setting items
Item | Basic Settings | Environment Variables | Explanation |
---|---|---|---|
dd_url | DD_DD_URL | When sending data from an agent through a specific server instead of directly to Datadog (e.g., via a proxy), configure the URL and IP/port accordingly. Reference guide for dd_url settings | |
proxy | DD_PROXY_HTTP | Configure this setting when a proxy is required for internet access. Reference guide for proxy settings | |
skip_ssl_validation | false | DD_SKIP_SSL_VALIDATION | Configures whether to skip SSL/TLS certificate validation. |
hostname | DD_HOSTNAME | Specifies the hostname. | |
hostname_fqdn | false | DD_HOSTNAME_FQDN | Configures whether to enable the use of FQDN for the agent hostname. |
- Tag setting
Item | Basic Settings | Environment Variables | Explanation |
---|---|---|---|
env | env: prod | DD_ENV | Sets the execution environment tag for the server where the agent is installed. The env tag must be set. |
tags | tags: | DD_TAGS | Configures tags that are added to metrics, events, logs, traces, and service checks. Additional tags can be freely added if needed for grouped monitoring. (Note: When setting tags, use the format |
reference guide : Tag Getting Started Guide
2. Advanced Configuration.
- Main setting items
Item | Default Settings | Environment Variables | Explanation |
---|---|---|---|
expvar_port | 5000 | DD_EXPVAR_PORT | Sets the port for exposing agent runtime metrics. |
cmd_port | 5001 | DD_CMD_PORT | Sets the port used for sending commands in the agent CLI and GUI, as well as retrieving information from the running agent. |
GUI_port | 5002 | DD_GUI_PORT | Sets the port for providing the GUI server on Windows and macOS. |
check_runners | 4 | DD_CHECK_RUNNERS | Sets the number of concurrent check runners (for service checks, SSH, HTTP, and other check-based processes).
|
enable_gohai | true | DD_ENABLE_GOHAI | Determines whether to collect system information displayed in Host Info under Infrastructure. If set to false, data will not be collected. Reference guide |
3. Log collection Configuration
- Main setting items
Item | Basic Settings | Environment variables | Explanation |
---|---|---|---|
logs_enabled | false | DD_LOGS_ENABLED | Specifies whether to enable log collection. Log Collection Guide |
logs_config: container_collect_all: | false | DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL | Determines whether to collect logs from all containers. (Only used in container environments.) Configuration Guide |
logs_config: logs_dd_url: | DD_LOGS_CONFIG_DD_URL | Defines the endpoint and port for forwarding log data when using a proxy. Must support TCP connections. TCP Agent Proxy Reference | |
logs_config: logs_no_ssl: | false | DD_LOGS_CONFIG_LOGS_NO_SSL | Determines whether to disable SSL encryption. Used only when forwarding logs locally to a proxy. TCP Agent Proxy Reference |
logs_config: processing_rules: | DD_LOGS_CONFIG_PROCESSING_RULES | Sets the RULE for log collection. Supports filtering, scrubbing, multi-line processing, etc. Advanced Log Collection | |
logs_config: open_files_limit: | 500 | DD_LOGS_CONFIG_OPEN_FILES_LIMIT | Sets the maximum number of files that can be collected simultaneously. |
logs_config: file_wildcard_selection_mode: | by_name | DD_LOGS_CONFIG_FILE_WILDCARD_SELECTION_MODE | When collecting multiple files using a folder or wildcard (*), defines the selection criteria when exceeding open_files_limit. Advanced Log Collection |
logs_config: max_message_size_bytes: | 256000 | DD_LOGS_CONFIG_MAX_MESSAGE_SIZE_BYTES | Sets the maximum log message size in bytes. If the size exceeds 1MB (API limit), messages will be discarded. |
For log collection and advanced settings, please refer to the guide below
4. Trace collection Configuration
- Main setting items
Item | Basic Settings | Environment variables | Explanation |
---|---|---|---|
apm_config: | true | DD_APM_ENABLED추적 샘플링 사용사례 참고 | Sets whether to collect APM. |
apm_config: | DD_APM_DD_URL | When using a proxy for APM, define the endpoint and port. Traces are forwarded over TCP, so the proxy must be able to handle TCP connections. | |
apm_config: |
| DD_APM_MAX_TPS | Configure the sampling settings. |
apm_config: |
| DD_APM_MAX_MEMORY | Limit the rate for APM. |
For Tracing(APM) collection and configuration, please refer to the guide below
Application instrumentation guide(Please refer to custom instrumentation in the guide)
5. Process collection Configuration
- Main setting items
Item | Basic Settings | Environment variables | Explanation |
---|---|---|---|
process_config: | false | DD_PROCESS_AGENT_PROCESS_COLLECTION_ENABLED | Sets whether to collect processes. |
process_config: | DD_PROCESS_AGENT_URL | Defines the endpoint and port for the Process when using a proxy. |