Skip to content

Commit b308748

Browse files
hestonhoffmanhestonhoffman
authored
(DOCS-8223) Move Agent 5/6 configuration (#23903)
* (DOCS-8223) Move Agent configuration commands * Agent 5 commands * Agent 6 commands * log and configuration files * edit * Lotsa updates * But wait, there's more
1 parent 88cd5b0 commit b308748

12 files changed

+469
-234
lines changed

‎content/en/agent/configuration/agent-commands.md‎

Lines changed: 17 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ For Linux based systems where the <code>service</code> wrapper command is not av
2323

2424
List of commands to start the Datadog Agent:
2525

26-
{{< tabs >}}
27-
{{% tab "Agent v6 & v7" %}}
28-
2926
| Platform | Command |
3027
|------------|--------------------------------------------------------------------|
3128
| AIX | `startsrc -s datadog-agent` |
@@ -36,32 +33,10 @@ List of commands to start the Datadog Agent:
3633
| Source | `sudo service datadog-agent start` |
3734
| Windows | See the [Windows Agent documentation][3]. |
3835

39-
[1]: /agent/
40-
[2]: /agent/docker/
41-
[3]: /agent/basic_agent_usage/windows/
42-
{{% /tab %}}
43-
{{% tab "Agent v5" %}}
44-
45-
| Platform | Command |
46-
|----------|-------------------------------------------|
47-
| Linux | `sudo service datadog-agent start` |
48-
| Docker | See the [Docker Agent documentation][1]. |
49-
| macOS | `/usr/local/bin/datadog-agent start` |
50-
| Source | `sudo ~/.datadog-agent/bin/agent start` |
51-
| Windows | See the [Windows Agent documentation][2]. |
52-
53-
[1]: https://github.com/DataDog/docker-dd-agent/blob/master/README.md
54-
[2]: /agent/basic_agent_usage/windows/
55-
{{% /tab %}}
56-
{{< /tabs >}}
57-
5836
### Stop the Agent
5937

6038
List of commands to stop the Datadog Agent:
6139

62-
{{< tabs >}}
63-
{{% tab "Agent v6 & v7" %}}
64-
6540
| Platform | Command |
6641
|------------|----------------------------------------------------------------------------------|
6742
| AIX | `stopsrc -s datadog-agent` |
@@ -70,33 +45,12 @@ List of commands to stop the Datadog Agent:
7045
| Kubernetes | `kubectl delete pod <AGENT POD NAME>`—note: the pod is automatically rescheduled |
7146
| macOS | `launchctl stop com.datadoghq.agent` *or* through the systray app |
7247
| Source | `sudo service datadog-agent stop` |
73-
| Windows | See the [Windows Agent documentation][2]. |
74-
75-
[1]: /agent/
76-
[2]: /agent/basic_agent_usage/windows/
77-
{{% /tab %}}
78-
{{% tab "Agent v5" %}}
79-
80-
| Platform | Command |
81-
|----------|-------------------------------------------|
82-
| Linux | `sudo service datadog-agent stop` |
83-
| Docker | See the [Docker Agent documentation][1]. |
84-
| macOS | `/usr/local/bin/datadog-agent stop` |
85-
| Source | `sudo ~/.datadog-agent/bin/agent stop` |
86-
| Windows | See the [Windows Agent documentation][2]. |
87-
88-
[1]: https://github.com/DataDog/docker-dd-agent/blob/master/README.md
89-
[2]: /agent/basic_agent_usage/windows/
90-
{{% /tab %}}
91-
{{< /tabs >}}
48+
| Windows | See the [Windows Agent documentation][3]. |
9249

9350
### Restart the Agent
9451

9552
List of commands to restart the Datadog Agent:
9653

97-
{{< tabs >}}
98-
{{% tab "Agent v6 & v7" %}}
99-
10054
| Platform | Command |
10155
|------------|----------------------------------------------------------------------------------|
10256
| Linux | See the [Agent documentation][1] for your OS. |
@@ -106,34 +60,13 @@ List of commands to restart the Datadog Agent:
10660
| Source | *unsupported Platform* |
10761
| Windows | See the [Windows Agent documentation][3]. |
10862

109-
[1]: /agent/
110-
[2]: /agent/docker/?tab=standard#setup
111-
[3]: /agent/basic_agent_usage/windows/
112-
{{% /tab %}}
113-
{{% tab "Agent v5" %}}
114-
115-
| Platform | Command |
116-
|----------|-------------------------------------------|
117-
| Linux | `sudo service datadog-agent restart` |
118-
| Docker | See the [Docker Agent documentation][1]. |
119-
| macOS | `/usr/local/bin/datadog-agent restart` |
120-
| Source | `sudo ~/.datadog-agent/bin/agent restart` |
121-
| Windows | See the [Windows Agent documentation][2]. |
122-
123-
[1]: https://github.com/DataDog/docker-dd-agent/blob/master/README.md
124-
[2]: /agent/basic_agent_usage/windows/
125-
{{% /tab %}}
126-
{{< /tabs >}}
12763

12864
## Agent status and information
12965

13066
### Service status
13167

13268
List of commands to display the status of the Datadog Agent:
13369

134-
{{< tabs >}}
135-
{{% tab "Agent v6 & v7" %}}
136-
13770
| Platform | Command |
13871
|-----------------|-------------------------------------------------------------------------------|
13972
| AIX | `lssrc -s datadog-agent` |
@@ -142,50 +75,23 @@ List of commands to display the status of the Datadog Agent:
14275
| Kubernetes | `kubectl exec -it <POD_NAME> -- s6-svstat /var/run/s6/services/agent/` |
14376
| macOS | `launchctl list com.datadoghq.agent` *or* through the systray app |
14477
| Source | `sudo service datadog-agent status` |
145-
| Windows | See the [Windows Agent documentation][2]. |
146-
147-
148-
[1]: /agent/
149-
[2]: /agent/basic_agent_usage/windows/
150-
{{% /tab %}}
151-
{{% tab "Agent v5" %}}
152-
153-
| Platform | Command |
154-
|-----------------|--------------------------------------------------------------------------|
155-
| Linux | `sudo service datadog-agent status` |
156-
| Docker (Debian) | `sudo docker exec -it <CONTAINER_NAME> /etc/init.d/datadog-agent status` |
157-
| Kubernetes | `kubectl exec -it <POD_NAME> -- /etc/init.d/datadog-agent status` |
158-
| macOS | `datadog-agent status` |
159-
| Source | `sudo ~/.datadog-agent/bin/agent status` |
160-
| Windows | See the [Windows Agent documentation][1]. |
161-
162-
[1]: /agent/basic_agent_usage/windows/#status-and-information
163-
{{% /tab %}}
164-
{{% tab "Cluster Agent" %}}
165-
166-
| Platform | Command |
167-
|------------|--------------------------------|
168-
| Kubernetes | `datadog-cluster-agent status` |
169-
170-
{{% /tab %}}
171-
{{< /tabs >}}
78+
| Windows | See the [Windows Agent documentation][5]. |
79+
| Cluster Agent (Kubernetes) | `datadog-cluster-agent status` |
17280

17381
### Agent information
17482

17583
List of commands to display the status of your Datadog Agent and enabled integrations.
17684

177-
{{< tabs >}}
178-
{{% tab "Agent v6 & v7" %}}
179-
18085
| Platform | Command |
18186
|------------|------------------------------------------------------|
18287
| AIX | `datadog-agent status` |
18388
| Linux | `sudo datadog-agent status` |
18489
| Docker | `sudo docker exec -it <CONTAINER_NAME> agent status` |
18590
| Kubernetes | `kubectl exec -it <POD_NAME> -- agent status` |
186-
| macOS | `datadog-agent status` or through the [web GUI][1] |
91+
| macOS | `datadog-agent status` or through the [web GUI][4] |
18792
| Source | `sudo datadog-agent status` |
188-
| Windows | See the [Windows Agent documentation][2]. |
93+
| Windows | See the [Windows Agent documentation][5]. |
94+
| Cluster Agent (Kubernetes) | `datadog-cluster-agent status` |
18995

19096
A properly configured integration is displayed under **Running Checks** with no warnings or errors, as seen below:
19197

@@ -201,48 +107,9 @@ Running Checks
201107
Average Execution Time : 0ms
202108
```
203109

204-
[1]: /agent/basic_agent_usage/#gui
205-
[2]: /agent/basic_agent_usage/windows/#status-and-information
206-
{{% /tab %}}
207-
{{% tab "Agent v5" %}}
208-
209-
| Platform | Command |
210-
|------------|------------------------------------------------------------------------|
211-
| Linux | `sudo service datadog-agent info` |
212-
| Docker | `sudo docker exec -it <CONTAINER_NAME> /etc/init.d/datadog-agent info` |
213-
| Kubernetes | `kubectl exec -it <POD_NAME> -- /etc/init.d/datadog-agent info` |
214-
| macOS | `datadog-agent info` |
215-
| Source | `sudo ~/.datadog-agent/bin/info` |
216-
| Windows | See the [Windows Agent documentation][1]. |
217-
218-
A properly configured integration is displayed under **Checks** with no warnings or errors, as seen below:
219-
220-
```text
221-
Checks
222-
======
223-
network
224-
-------
225-
- instance #0 [OK]
226-
- Collected 15 metrics, 0 events & 1 service check
227-
```
228-
229-
[1]: /agent/basic_agent_usage/windows/#status-and-information
230-
{{% /tab %}}
231-
{{% tab "Cluster Agent" %}}
232-
233-
| Platform | Command |
234-
|------------|--------------------------------|
235-
| Kubernetes | `datadog-cluster-agent status` |
236-
237-
{{% /tab %}}
238-
{{< /tabs >}}
239-
240110
## Other commands
241111

242-
{{< tabs >}}
243-
{{% tab "Agent v6 & v7" %}}
244-
245-
The Agent v6 command line interface is sub-command based. To see the list of available sub-commands, run:
112+
The Agent command-line interface is sub-command based. To see the list of available sub-commands, run:
246113
```shell
247114
<AGENT_BINARY> --help
248115
```
@@ -260,10 +127,10 @@ Some options have flags and options detailed under `--help`. For example, use he
260127
| Subcommand | Notes |
261128
|-------------------|-----------------------------------------------------------------------------|
262129
| `check` | Run the specified check. |
263-
| `config` | [Runtime configuration management][1]. |
130+
| `config` | [Runtime configuration management][6]. |
264131
| `configcheck` | Print all configurations loaded & resolved of a running Agent. |
265132
| `diagnose` | Execute connectivity diagnosis on your system. |
266-
| `flare` | [Collect a flare and send it to Datadog][2]. |
133+
| `flare` | [Collect a flare and send it to Datadog][7]. |
267134
| `health` | Print the current Agent health. |
268135
| `help` | Help about any command. |
269136
| `hostname` | Print the hostname used by the Agent. |
@@ -276,11 +143,14 @@ Some options have flags and options detailed under `--help`. For example, use he
276143
| `stopservice` | Stop the Agent within the service control manager. Windows only. |
277144
| `version` | Print version info. |
278145

279-
[1]: /agent/troubleshooting/config/
280-
[2]: /agent/troubleshooting/send_a_flare/
281-
{{% /tab %}}
282-
{{< /tabs >}}
283-
284146
## Further Reading
285147

286148
{{< partial name="whats-next/whats-next.html" >}}
149+
150+
[1]: /agent/
151+
[2]: /agent/docker/
152+
[3]: /agent/basic_agent_usage/windows/
153+
[4]: /agent/basic_agent_usage/#gui
154+
[5]: /agent/basic_agent_usage/windows/#status-and-information
155+
[6]: /agent/troubleshooting/config/
156+
[7]: /agent/troubleshooting/send_a_flare/

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

Lines changed: 8 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,9 @@ algolia:
1111

1212
---
1313

14-
## Agent main configuration file
14+
## Main configuration file
1515

16-
The Agent v6 configuration file uses **YAML** to better support complex configurations, and to provide a consistent configuration experience, as Checks also use YAML configuration files. Therefore, `datadog.conf` (v5) is retired in favor of `datadog.yaml` (v6).
17-
18-
{{< tabs >}}
19-
{{% tab "Agent v6 & v7" %}}
16+
The location of the Agent configuration file differs depending on the operating system.
2017

2118
| Platform | Command |
2219
|:-------------------------------------|:-------------------------------------|
@@ -25,27 +22,11 @@ The Agent v6 configuration file uses **YAML** to better support complex configur
2522
| macOS | `~/.datadog-agent/datadog.yaml` |
2623
| Windows | `%ProgramData%\Datadog\datadog.yaml` |
2724

28-
{{% /tab %}}
29-
{{% tab "Agent v5" %}}
30-
31-
| Platform | Command |
32-
|:-------------------------------------|:---------------------------------------------------------------------------|
33-
| Linux | `/etc/dd-agent/datadog.conf` |
34-
| macOS | `~/.datadog-agent/datadog.conf` | |
35-
| Windows Server 2008, Vista and newer | `%ProgramData%\Datadog\datadog.conf` |
36-
| Windows Server 2003, XP or older | `\\Documents and Settings\All Users\Application Data\Datadog\datadog.conf` |
37-
38-
{{% /tab %}}
39-
{{< /tabs >}}
40-
41-
See the [sample `config_template.yaml` file][2] for all available configuration options.
25+
See the [sample `config_template.yaml` file][1] for all available configuration options.
4226

4327
## Agent configuration directory
4428

45-
Prior releases of Datadog Agent stored configuration files in `/dd-agent/conf.d/`. Starting with the 6.0 release, configuration files are stored in `/etc/datadog-agent/conf.d/<CHECK_NAME>.d/`.
46-
47-
{{< tabs >}}
48-
{{% tab "Agent v6 & v7" %}}
29+
Configuration files for Agent checks and integrations are stored in the `conf.d` directory. The location of the directory differs depending on the operating system.
4930

5031
| Platform | Command |
5132
|:-------------------------------------|:-------------------------------|
@@ -61,7 +42,7 @@ Prior releases of Datadog Agent stored configuration files in `/dd-agent/conf.d/
6142
| Ubuntu | `/etc/datadog-agent/conf.d/` |
6243
| Windows | `%ProgramData%\Datadog\conf.d` |
6344

64-
### Checks configuration files for Agent 6
45+
### Check configuration files
6546

6647
An example for each Agent check configuration file is found in the `conf.yaml.example` file in the corresponding `<CHECK_NAME>.d/` folder. Rename this file to `conf.yaml` to enable the associated check. **Note**: The Agent loads valid YAML files contained in the folder: `/etc/datadog-agent/conf.d/<CHECK_NAME>.d/`. This allows complex configurations to be broken down into multiple files. For example, a configuration for the `http_check` might look like this:
6748

@@ -83,31 +64,9 @@ Autodiscovery template files are stored in the configuration folder with the `au
8364

8465
For log collection, the Agent does not accept multiple YAML files that point to the same log source to prevent duplicate logs from being sent to Datadog. In the case where there is more than one YAML file that points to the same log source, the Agent considers the files in alphabetical order and uses the first file.
8566

86-
To preserve backwards compatibility, the Agent still picks up configuration files in the form `/etc/dd-agent/conf.d/<CHECK_NAME>.yaml`, but migrating to the new layout is strongly recommended.
87-
88-
{{% /tab %}}
89-
{{% tab "Agent v5" %}}
90-
91-
| Platform | Command |
92-
|:-------------------------------------|:---------------------------------------------------------------------|
93-
| Linux | `/etc/dd-agent/conf.d/` |
94-
| CentOS | `/etc/dd-agent/conf.d/` |
95-
| Debian | `/etc/dd-agent/conf.d/` |
96-
| Fedora | `/etc/dd-agent/conf.d/` |
97-
| macOS | `~/.datadog-agent/conf.d/` |
98-
| RedHat | `/etc/dd-agent/conf.d/` |
99-
| Source | `/etc/dd-agent/conf.d/` |
100-
| Suse | `/etc/dd-agent/conf.d/` |
101-
| Ubuntu | `/etc/dd-agent/conf.d/` |
102-
| Windows Server 2008, Vista and newer | `%ProgramData%\Datadog\conf.d` |
103-
| Windows Server 2003, XP or older | `\\Documents and Settings\All Users\Application Data\Datadog\conf.d` |
104-
105-
{{% /tab %}}
106-
{{< /tabs >}}
107-
10867
## JMX configuration file
10968

110-
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][1].
69+
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].
11170

112-
[1]: /agent/kubernetes/integrations/#configuration
113-
[2]: https://github.com/DataDog/datadog-agent/blob/master/pkg/config/config_template.yaml
71+
[1]: https://github.com/DataDog/datadog-agent/blob/master/pkg/config/config_template.yaml
72+
[2]: /agent/kubernetes/integrations/#configuration

0 commit comments

Comments
 (0)