Skip to content

Commit

Permalink
Doc Review #1
Browse files Browse the repository at this point in the history
Mostly moved "documentation" inside the URL.
  • Loading branch information
alai97 authored Aug 11, 2021
1 parent 02551f9 commit 40c1eb1
Show file tree
Hide file tree
Showing 33 changed files with 72 additions and 72 deletions.
4 changes: 2 additions & 2 deletions content/en/agent/amazon_ecs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This page covers Amazon ECS setup with the [Datadog Container Agent v6][1]. For

## Setup

To begin setup, run the [Datadog Agent][5] on every EC2 instance in your ECS cluster. If you don't have a working EC2 Container Service cluster configured, review the [Getting Started section in the ECS][6] documentation to set up and configure a cluster. Once configured, follow the setup instructions below.
To begin setup, run the [Datadog Agent][5] on every EC2 instance in your ECS cluster. If you don't have a working EC2 Container Service cluster configured, review the [Getting Started section in the ECS documentation][6] to set up and configure a cluster. Once configured, follow the setup instructions below.

1. [Create and add an ECS Task](#create-an-ecs-task)
2. [Create or modify your IAM Policy](#create-or-modify-your-iam-policy)
Expand All @@ -55,7 +55,7 @@ If you're [using APM][8], [DogStatsD][9], or [log management][10], set the appro

**Note**: To enable DogStatsD metrics collection from other containers, ensure the `DD_DOGSTATSD_NON_LOCAL_TRAFFIC` environment variable is set to `true`.

- If you are using log management, see the [Log collection][10] documentation.
- If you are using log management, see the [Log collection documentation][10].

Double check the security group settings on your EC2 instances. Make sure these ports are not open to the public. Datadog uses the private IP to route to the Agent from the containers.

Expand Down
4 changes: 2 additions & 2 deletions content/en/agent/amazon_ecs/apm.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ const axios = require('axios');
})();
```

For more examples of setting the Agent hostname in other languages, see the [change Agent hostname][1] documentation.
For more examples of setting the Agent hostname in other languages, see the [change Agent hostname documentation][1].


[1]: https://docs.datadoghq.com/tracing/setup/nodejs/#change-agent-hostname
Expand Down Expand Up @@ -196,7 +196,7 @@ Copy this script into the `entryPoint` field of your ECS task definition, updati
]
```
For more examples of setting the Agent hostname in other languages, see the [change Agent hostname][1] documentation.
For more examples of setting the Agent hostname in other languages, see the [change Agent hostname documentation][1].
[1]: https://docs.datadoghq.com/tracing/setup/java/#change-agent-hostname
Expand Down
4 changes: 2 additions & 2 deletions content/en/agent/amazon_ecs/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ To collect all logs written by running applications in your ECS containers and s
#### Configuration file
If your container writes any logs to files, follow the [Custom Log Collection][1] documentation to tail files for logs.
If your container writes any logs to files, follow the [Custom Log Collection documentation][1] to tail files for logs.
To gather logs from your `<APP_NAME>` application stored in `<PATH_LOG_FILE>/<LOG_FILE_NAME>.log` create a `<APP_NAME>.d/conf.yaml` file at the root of your [Agent's configuration directory][2] with the following content:
Expand All @@ -176,7 +176,7 @@ logs:

With Agent v7.25.0+/6.25.0+, it is possible to enable file tailing by using a container label so the logs collected receive the tags of the container on which the label was set. See this [example][4] that details the exact label to use.

**Note**: The file paths are always relative to the Agent. So, this requires extra configuration for involved ECS tasks to share a directory between the container writing to the file and the Agent container. See the [AWS Bind mounts][5] documentation for additional details on volume management with ECS.
**Note**: The file paths are always relative to the Agent. So, this requires extra configuration for involved ECS tasks to share a directory between the container writing to the file and the Agent container. See the [AWS Bind mounts documentation][5] for additional details on volume management with ECS.

## Activate log integrations

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/amazon_ecs/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The Datadog Agent can create and assign tags to all metrics, traces, and logs em

## Unified service tagging

As a best practice in containerized environments, Datadog recommends using unified service tagging when assigning tags. Unified service tagging ties Datadog telemetry together through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the [Amazon ECS unified service tagging][1] documentation.
As a best practice in containerized environments, Datadog recommends using unified service tagging when assigning tags. Unified service tagging ties Datadog telemetry together through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the [Amazon ECS unified service tagging documentation][1].

## Resource tag collection

Expand Down
4 changes: 2 additions & 2 deletions content/en/agent/basic_agent_usage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ Note: If you want to manually update one specific Agent integration see the [Int

### Configuration files

See the [Agent configuration files][9] documentation.
See the [Agent configuration files documentation][9].

### Datadog site

Expand All @@ -341,7 +341,7 @@ site: {{< region-param key="dd_site" >}}
### Log location
See the [Agent log files][11] documentation.
See the [Agent log files documentation][11].
## Further Reading
Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/amazonlinux.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][3] documentation.
See the [Agent Troubleshooting documentation][3].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/fedora.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/redhat.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][2] documentation.
See the [Agent Troubleshooting documentation][2].

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/suse.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][3] documentation.
See the [Agent Troubleshooting documentation][3].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/basic_agent_usage/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Configuration files for [Integrations][1]:

## Troubleshooting

See the [Agent Troubleshooting][3] documentation.
See the [Agent Troubleshooting documentation][3].

## Working with the embedded Agent

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/cluster_agent/clusterchecks.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Starting with version 1.2.0, the Datadog Cluster Agent extends the Autodiscovery
3. The recommended leader election lease duration is 15 seconds. Set it with the `DD_LEADER_LEASE_DURATION` environment variable.
4. If the service name is different from the default `datadog-cluster-agent`, ensure the `DD_CLUSTER_AGENT_KUBERNETES_SERVICE_NAME` environment variable reflects the service name.

The following two configuration sources are supported. They are described in the [Autodiscovery][1] documentation:
The following two configuration sources are supported. They are described in the [Autodiscovery documentation][1]:

- You can mount YAML files from a ConfigMap in the `/conf.d` folder. They are automatically imported by the image's entrypoint.
- Kubernetes Service Annotations require setting both the `DD_EXTRA_CONFIG_PROVIDERS` and `DD_EXTRA_LISTENERS` environment variables to `kube_services`.
Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/cluster_agent/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The following environment variables are supported:
: Enables cluster level metadata mapping. Defaults to `true`.

`DD_COLLECT_KUBERNETES_EVENTS`
: Configures the Agent to collect Kubernetes events. Defaults to `false`. See the [Event collection][2] documentation for more details.
: Configures the Agent to collect Kubernetes events. Defaults to `false`. See the [Event collection documentation][2] for more details.

`DD_LEADER_ELECTION`
: Activates leader election. Set `DD_COLLECT_KUBERNETES_EVENTS` to `true` to activate this feature. Defaults to `false`.
Expand Down
4 changes: 2 additions & 2 deletions content/en/agent/cluster_agent/external_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ As of v1.0.0, the Custom Metrics Server in the Datadog Cluster Agent implements
### Requirements

1. Running Kubernetes >v1.10 in order to be able to register the External Metrics Provider resource against the API server.
2. Having the aggregation layer enabled. See the [Kubernetes aggregation layer configuration][3] documentation.
2. Having the aggregation layer enabled. See the [Kubernetes aggregation layer configuration documentation][3].

## Set up the Cluster Agent external metric server

Expand Down Expand Up @@ -144,7 +144,7 @@ Note in this manifest that:
- The maximum number of replicas created is `3`, and the minimum is `1`.
- The metric used is `nginx.net.request_per_s`, and the scope is `kube_container_name: nginx`. This metric format corresponds to the Datadog one.

Every 30 seconds, Kubernetes queries the Datadog Cluster Agent to get the value of this metric and autoscales proportionally if necessary. For advanced use cases, it is possible to have several metrics in the same HPA. As you can see in the [Kubernetes horizontal pod autoscaling][5] documentation, the largest of the proposed values is the one chosen.
Every 30 seconds, Kubernetes queries the Datadog Cluster Agent to get the value of this metric and autoscales proportionally if necessary. For advanced use cases, it is possible to have several metrics in the same HPA. As you can see in the [Kubernetes horizontal pod autoscaling documentation][5], the largest of the proposed values is the one chosen.

**Note**: Running multiple Cluster Agents raises API usage. The Datadog Cluster Agent completes 120 calls per hour for approximately 45 HPA objects in Kubernetes. Running more than 45 HPAs increases the number of calls when fetching metrics from within the same org.

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/cluster_agent/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This environment variable must be configured (using the same setup) when [Config
echo -n '<Your API key>' | base64
```
3. In the `secrets-application-key.yaml` manifest, replace `PUT_YOUR_BASE64_ENCODED_APP_KEY_HERE` with [your Datadog Application key][11] encoded in base64.
4. The `cluster-agent-deployment.yaml` manifest refers to the token created previously in the `Secret` `datadog-cluster-agent` by *default*. If you are storing this token in an *alternative* way, configure your `DD_CLUSTER_AGENT_AUTH_TOKEN` environment variable accordingly.
4. By default, the `cluster-agent-deployment.yaml` manifest refers to the token created previously in the `Secret` `datadog-cluster-agent`. If you are storing this token in an alternative way, configure your `DD_CLUSTER_AGENT_AUTH_TOKEN` environment variable accordingly.
5. Deploy these resources for the Cluster Agent Deployment to use:
```shell
kubectl apply -f agent-services.yaml
Expand Down
4 changes: 2 additions & 2 deletions content/en/agent/docker/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Starting with Agent v6.4.0 (and v6.5.0 for the Trace Agent), you can override th
| `DD_PROXY_HTTPS` | An HTTPS URL to use as a proxy for `https` requests. |
| `DD_PROXY_NO_PROXY` | A space-separated list of URLs for which no proxy should be used. |

For more information about proxy settings, see the [Agent v6 Proxy][12] documentation.
For more information about proxy settings, see the [Agent v6 Proxy documentation][12].

### Optional collection Agents

Expand Down Expand Up @@ -191,7 +191,7 @@ See the [Docker Tag Extraction][23] documentation to learn more.

### Using secret files

Integration credentials can be stored in Docker or Kubernetes secrets and used in Autodiscovery templates. For more information, see the [Secrets Management][24] documentation.
Integration credentials can be stored in Docker or Kubernetes secrets and used in Autodiscovery templates. For more information, see the [Secrets Management documentation][24].

### Ignore containers

Expand Down
8 changes: 4 additions & 4 deletions content/en/agent/docker/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ further_reading:
---

<div class="alert alert-info">
See the <a href="/getting_started/agent/autodiscovery">Autodiscovery Getting Started</a> documentation to discover the concepts behind this feature.
See the <a href="/getting_started/agent/autodiscovery">Autodiscovery Getting Started documentation</a> to discover the concepts behind this feature.
</div>

This page covers how to configure Autodiscovery for integrations with Docker. If you are using Kubernetes, see the [Kubernetes Integrations Autodiscovery][1] documentation.
This page covers how to configure Autodiscovery for integrations with Docker. If you are using Kubernetes, see the [Kubernetes Integrations Autodiscovery documentation][1].

The goal of Autodiscovery is to apply a Datadog integration configuration when running an Agent check against a given container. See how to [configure Agent integrations][2] when running the Agent on a host for more context on this logic.

Expand Down Expand Up @@ -243,7 +243,7 @@ instances:
password: "%%env_REDIS_PASSWORD%%"
```

**Note**: The `"%%env_<ENV_VAR>%%"` template variable logic is used to avoid storing the password in plain text, hence the `REDIS_PASSWORD` environment variable must be passed to the Agent. See the [Autodiscovery template variable][3] documentation.
**Note**: The `"%%env_<ENV_VAR>%%"` template variable logic is used to avoid storing the password in plain text, hence the `REDIS_PASSWORD` environment variable must be passed to the Agent. See the [Autodiscovery template variable documentation][3].

[1]: https://github.com/DataDog/integrations-core/blob/master/redisdb/datadog_checks/redisdb/data/auto_conf.yaml
[2]: /agent/guide/ad_identifiers/
Expand All @@ -262,7 +262,7 @@ etcdctl set /datadog/check_configs/redis/instances '[{"host": "%%host%%","port":

Notice that each of the three values is a list. Autodiscovery assembles list items into the integration configurations based on shared list indexes. In this case, it composes the first (and only) check configuration from `check_names[0]`, `init_configs[0]` and `instances[0]`.

**Note**: The `"%%env_<ENV_VAR>%%"` template variable logic is used to avoid storing the password in plain text, hence the `REDIS_PASSWORD` environment variable must be passed to the Agent. See the [Autodiscovery template variable][1] documentation.
**Note**: The `"%%env_<ENV_VAR>%%"` template variable logic is used to avoid storing the password in plain text, hence the `REDIS_PASSWORD` environment variable must be passed to the Agent. See the [Autodiscovery template variable documentation][1].

Unlike auto-conf files, **key-value stores may use the short OR long image name as container identifiers**, for example: `redis` OR `redis:latest`.

Expand Down
10 changes: 5 additions & 5 deletions content/en/agent/docker/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The commands related to log collection are:
{{% tab "Host Agent with Custom Logging" %}}

1. Install the [latest version of the Agent][1] on your host.
2. Follow the [Custom Log Collection][2] documentation to tail files for logs.
2. Follow the [Custom Log Collection documentation][2] to tail files for logs.

To gather logs from your `<APP_NAME>` application stored in `<PATH_LOG_FILE>/<LOG_FILE_NAME>.log` create a `<APP_NAME>.d/conf.yaml` file at the root of your [Agent's configuration directory][3] with the following content:

Expand Down Expand Up @@ -157,7 +157,7 @@ The commands related to log collection are:

- Logs coming from container `Stderr` have a default status of `Error`.

- If using the _journald_ logging driver instead of Docker's default json-file logging driver, see the [journald integration][2] documentation for details regarding the setup for containerized environments. See the [journald filter units][2] documentation for more information on parameters for filtering.
- If using the _journald_ logging driver instead of Docker's default json-file logging driver, see the [journald integration documentation][2] for details regarding the setup for containerized environments. See the [journald filter units documentation][2] for more information on parameters for filtering.

## Docker container log collection from file

Expand Down Expand Up @@ -212,7 +212,7 @@ Add the following label as a run command:

Where `<LOG_CONFIG>` is the log collection configuration you would find inside an integration configuration file. [See log collection configuration to learn more][5].

**Note**: When configuring the `service` value through docker labels, Datadog recommends using unified service tagging as a best practice. Unified service tagging ties all Datadog telemetry together, including logs, through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the [unified service tagging][6] documentation.
**Note**: When configuring the `service` value through docker labels, Datadog recommends using unified service tagging as a best practice. Unified service tagging ties all Datadog telemetry together, including logs, through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the [unified service tagging documentation][6].

### Examples

Expand Down Expand Up @@ -255,7 +255,7 @@ labels:
com.datadoghq.ad.logs: '[{"source": "java", "service": "myapp", "log_processing_rules": [{"type": "multi_line", "name": "log_start_with_date", "pattern" : "\\d{4}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])"}]}]'
```

See the [multi-line processing rule][1] documentation to get more pattern examples.
See the [multi-line processing rule documentation][1] to get more pattern examples.


[1]: /agent/logs/advanced_log_collection/?tab=docker#multi-line-aggregation
Expand Down Expand Up @@ -311,7 +311,7 @@ For a Docker environment, the Agent receives container updates in real time thro

Since Agent v6.14+, the Agent collects logs for all containers (running or stopped) which means that short lived containers logs that have started and stopped in the past second are still collected as long as they are not removed.

For Kubernetes environments, see the [Kubernetes short lived container][11] documentation.
For Kubernetes environments, see the [Kubernetes short lived container documentation][11].

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion content/en/agent/docker/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The Agent can autodiscover and attach tags to all data emitted by containers. Th

### Unified service tagging

As a best practice in containerized environments, Datadog recommends using unified service tagging when assigning tags. Unified service tagging ties Datadog telemetry together through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the dedicated [unified service tagging][2] documentation.
As a best practice in containerized environments, Datadog recommends using unified service tagging when assigning tags. Unified service tagging ties Datadog telemetry together through the use of three standard tags: `env`, `service`, and `version`. To learn how to configure your environment with unified tagging, see the dedicated [unified service tagging documentation][2].

## Extract labels as tags

Expand Down
Loading

0 comments on commit 40c1eb1

Please sign in to comment.