Skip to content

Commit 649b53a

Browse files
authored
Merge pull request DataDog#7516 from DataDog/sarina/containerized-tagging
Refactor of Tagging Section
2 parents cd3d403 + db9f19f commit 649b53a

File tree

118 files changed

+1872
-1387
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+1872
-1387
lines changed

config/_default/menus/menus.en.yaml

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -39,48 +39,55 @@ main:
3939
url: getting_started/tracing/
4040
parent: getting_started
4141
weight: 5
42+
- name: Tags
43+
identifier: tagging_
44+
url: getting_started/tagging/
45+
parent: getting_started
46+
weight: 6
47+
- name: Assigning Tags
48+
identifier: assigning_tags
49+
url: getting_started/tagging/assigning_tags
50+
parent: tagging_
51+
weight: 601
52+
- name: Unified Service Tagging
53+
identifier: unified_service_tagging
54+
url: getting_started/tagging/unified_service_tagging
55+
parent: tagging_
56+
weight: 602
57+
- name: Using Tags
58+
identifier: using_tags
59+
url: getting_started/tagging/using_tags
60+
parent: tagging_
61+
weight: 603
4262
- name: API
4363
identifier: getting_started_api
4464
url: getting_started/api/
4565
parent: getting_started
46-
weight: 6
66+
weight: 7
4767
- name: Synthetics
4868
identifier: getting_started_synthetics
4969
url: getting_started/synthetics/
5070
parent: getting_started
51-
weight: 7opl
71+
weight: 8
5272
- name: Private Location
5373
identifier: getting_started_private_location
5474
url: getting_started/synthetics/private_location
5575
parent: getting_started_synthetics
56-
weight: 701
76+
weight: 801
5777
- name: Browser Test
5878
identifier: getting_started_browser_test
5979
url: getting_started/synthetics/browser_test
6080
parent: getting_started_synthetics
61-
weight: 702
81+
weight: 802
6282
- name: API Test
6383
identifier: getting_started_api_test
6484
url: getting_started/synthetics/api_test
6585
parent: getting_started_synthetics
66-
weight: 703
86+
weight: 803
6787
- name: Learning Center
6888
url: getting_started/learning_center/
6989
parent: getting_started
70-
weight: 8
71-
- name: Tagging
72-
url: tagging/
73-
pre: nav_tagging
74-
identifier: tagging_
75-
weight: 20000
76-
- name: Assigning tags
77-
url: tagging/assigning_tags/
78-
parent: tagging_
79-
weight: 1
80-
- name: Using tags
81-
url: tagging/using_tags/
82-
parent: tagging_
83-
weight: 2
90+
weight: 9
8491
- name: Agent
8592
url: agent/
8693
pre: nav_agent

content/en/account_management/billing/alibaba.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For technical questions, contact [Datadog support][4].
2626
For billing questions, contact your [Customer Success][5] Manager.
2727

2828
[1]: https://app.datadoghq.com/account/settings#integrations/alibaba-cloud
29-
[2]: /tagging/using_tags/#integrations
29+
[2]: /getting_started/tagging/using_tags/#integrations
3030
[3]: /infrastructure/
3131
[4]: /help/
3232
[5]: mailto:success@datadoghq.com

content/en/account_management/billing/aws.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For technical questions, contact [Datadog support][4].
3030
For billing questions, contact your [Customer Success][5] Manager.
3131

3232
[1]: https://app.datadoghq.com/account/settings#integrations/amazon_web_services
33-
[2]: /tagging/using_tags/#integrations
33+
[2]: /getting_started/tagging/using_tags/#integrations
3434
[3]: /infrastructure/
3535
[4]: /help/
3636
[5]: mailto:success@datadoghq.com

content/en/account_management/billing/azure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ kind: documentation
77

88
Datadog bills for all [Azure Virtual Machines being monitored in Datadog][1]. These machines are billable regardless of whether the Datadog Agent is installed. You are not billed twice if you are running the Agent on an Azure VM picked up by the Azure integration.
99

10-
Additionally, Datadog also counts the nodes inside of Azure App Service Plans as billable hosts. Note that any Shared, Dynamic, or Free tier App Service Plans do not have any associated node counts and will not impact your Datadog bill.
10+
Additionally, Datadog also counts the nodes inside of Azure App Service Plans as billable hosts. Note that any Shared, Dynamic, or Free tier App Service Plans do not have any associated node counts and will not impact your Datadog bill.
1111
The Azure integration will collect metrics for all other Azure resources (Azure SQL DB, Azure Redis Cache, Azure Load Balancer, etc.) without any impact on monthly billing.
1212

1313
## Azure VM exclusion
@@ -31,5 +31,5 @@ For technical questions, contact [Datadog support][2].
3131
For billing questions, contact your [Customer Success][3] Manager.
3232

3333
[1]: https://app.datadoghq.com/account/settings#integrations/azure
34-
[2]: /tagging/using_tags/#integrations
34+
[2]: /getting_started/tagging/using_tags/#integrations
3535
[3]: /infrastructure/

content/en/account_management/billing/google_cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For technical questions, contact [Datadog support][4].
2626
For billing questions, contact your [Customer Success][5] Manager.
2727

2828
[1]: https://app.datadoghq.com/account/settings#integrations/google_cloud_platform
29-
[2]: /tagging/using_tags/#integrations
29+
[2]: /getting_started/tagging/using_tags/#integrations
3030
[3]: /infrastructure/
3131
[4]: /help/
3232
[5]: mailto:success@datadoghq.com

content/en/account_management/billing/usage_attribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,4 @@ The table below shows a sample daily report for Custom Metrics usage two tags: `
8383
When using multiple tags, both the Daily and Monthly Usage Attribution reports contain data for all possible combinations of those tags, and are suitable to use as base datasets for further data analysis tasks. For instance, you can use grouping or pivoting to produce views focused on a subset of the tags, or to perform aggregations across custom date ranges.
8484

8585
[1]: https://docs.datadoghq.com/api/#get-daily-usage-attribution-available-files
86-
[2]: https://docs.datadoghq.com/tagging/#defining-tags
86+
[2]: https://docs.datadoghq.com/getting_started/tagging/#defining-tags

content/en/agent/cluster_agent/clusterchecks.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,20 @@ ad.datadoghq.com/service.instances: '[<INSTANCE_CONFIG>]'
131131
132132
The `%%host%%` [template variable][7] is supported and is replaced by the service's IP. The `kube_namespace` and `kube_service` tags are automatically added to the instance.
133133

134+
### Template Source: Standard Labels
135+
136+
```yaml
137+
tags.datadoghq.com/env: "<ENV>"
138+
tags.datadoghq.com/service: "<SERVICE>"
139+
tags.datadoghq.com/version: "<VERSION>"
140+
```
141+
142+
The `tags.datadoghq.com` labels set the `env`, `service`, and even `version` as tags on data generated by the check.
143+
These standard labels are part of [Unified Service Tagging][8].
144+
134145
#### Example: HTTP check on an NGINX-backed service
135146

136-
The following Service definition exposes the Pods from the `my-nginx` deployment and runs an [HTTP check][8] to measure the latency of the load balanced service:
147+
The following Service definition exposes the Pods from the `my-nginx` deployment and runs an [HTTP check][9] to measure the latency of the load balanced service:
137148

138149
```yaml
139150
apiVersion: v1
@@ -142,6 +153,9 @@ metadata:
142153
name: my-nginx
143154
labels:
144155
run: my-nginx
156+
tags.datadoghq.com/env: "prod"
157+
tags.datadoghq.com/service: "my-nginx"
158+
tags.datadoghq.com/version: "1.19.0"
145159
annotations:
146160
ad.datadoghq.com/service.check_names: '["http_check"]'
147161
ad.datadoghq.com/service.init_configs: '[{}]'
@@ -161,7 +175,7 @@ spec:
161175
run: my-nginx
162176
```
163177

164-
In addition, each pod should be monitored with the [NGINX check][9], as it enables the monitoring of each worker as well as the aggregated service.
178+
In addition, each pod should be monitored with the [NGINX check][10], as it enables the monitoring of each worker as well as the aggregated service.
165179

166180
## Troubleshooting
167181

@@ -300,5 +314,6 @@ The Agent `status` command should show the check instance running and reporting
300314
[5]: /developers/write_agent_check/
301315
[6]: /integrations/mysql/
302316
[7]: /agent/faq/template_variables/
303-
[8]: /integrations/http_check/
304-
[9]: /integrations/nginx/
317+
[8]: /getting_started/tagging/unified_service_tagging
318+
[9]: /integrations/http_check/
319+
[10]: /integrations/nginx/

content/en/agent/cluster_agent/commands.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ The following environment variables are supported:
3737
|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3838
| `DD_API_KEY` | Your [Datadog API key][1]. |
3939
| `DD_HOSTNAME` | Hostname to use for the Datadog Cluster Agent. |
40+
| `DD_ENV` | Sets the `env` tag for data emitted by the Cluster Agent. Recommended only if the Cluster Agent monitors services within a single environment.
41+
|
4042
| `DD_CLUSTER_AGENT_CMD_PORT` | Port for the Datadog Cluster Agent to serve. Defaults to `5005`. |
4143
| `DD_USE_METADATA_MAPPER` | Enables cluster level metadata mapping. Defaults to `true`. |
4244
| `DD_COLLECT_KUBERNETES_EVENTS` | Configures the Agent to collect Kubernetes events. Defaults to `false`. See the [Event collection documentation][2] for more details. |

content/en/agent/cluster_agent/endpointschecks.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,20 @@ ad.datadoghq.com/endpoints.logs: '[<LOGS_CONFIG>]'
132132

133133
The `%%host%%` [template variable][7] is supported and is replaced by the endpoints' IPs. The `kube_namespace`, `kube_service`, and `kube_endpoint_ip` tags are automatically added to the instances.
134134
135+
### Template Source: Standard Labels
136+
137+
```yaml
138+
tags.datadoghq.com/env: "<ENV>"
139+
tags.datadoghq.com/service: "<SERVICE>"
140+
tags.datadoghq.com/version: "<VERSION>"
141+
```
142+
143+
The `tags.datadoghq.com` labels set the `env`, `service`, and even `version` as tags on data generated by the check.
144+
These standard labels are part of [Unified Service Tagging][8].
145+
135146
#### Example: HTTP check on an NGINX-backed service with NGINX check on the service's endpoints
136147

137-
The following service definition exposes the pods from the `my-nginx` deployment. It then runs an [HTTP check][8] to measure the latency of the load-balanced service and an [NGINX check][9] on the pod(s) that back the endpoint(s) of the service to collect `NGINX` metrics and service checks on the pod level:
148+
The following service definition exposes the pods from the `my-nginx` deployment. It then runs an [HTTP check][9] to measure the latency of the load-balanced service and an [NGINX check][10] on the pod(s) that back the endpoint(s) of the service to collect `NGINX` metrics and service checks on the pod level:
138149

139150
```yaml
140151
apiVersion: v1
@@ -143,6 +154,9 @@ metadata:
143154
name: my-nginx
144155
labels:
145156
run: my-nginx
157+
tags.datadoghq.com/env: "prod"
158+
tags.datadoghq.com/service: "my-nginx"
159+
tags.datadoghq.com/version: "1.19.0"
146160
annotations:
147161
ad.datadoghq.com/service.check_names: '["http_check"]'
148162
ad.datadoghq.com/service.init_configs: '[{}]'
@@ -174,7 +188,7 @@ spec:
174188

175189
## Troubleshooting
176190

177-
Troubleshooting endpoints checks is similar to [troubleshooting cluster checks][10]—the only difference is on the node-based Agents, where scheduled endpoints checks appear alongside the cluster check.
191+
Troubleshooting endpoints checks is similar to [troubleshooting cluster checks][11]—the only difference is on the node-based Agents, where scheduled endpoints checks appear alongside the cluster check.
178192

179193
**Note**: Endpoints checks are scheduled by Agents that run on the same node as the pod(s) that back the endpoint(s) of the service. If an endpoint is not backed by a pod, the Cluster Agent converts the check into a cluster check. This cluster check can be run by any node Agent.
180194

@@ -268,6 +282,7 @@ State: dispatched to gke-cluster-default-pool-4658d5d4-qfnt
268282
[5]: /agent/guide/agent-commands/
269283
[6]: /agent/kubernetes/integrations/?tab=kubernetes#template-source-kubernetes-pod-annotations
270284
[7]: /agent/kubernetes/integrations/?tab=kubernetes#supported-template-variables
271-
[8]: /integrations/http_check/
272-
[9]: /integrations/nginx/
273-
[10]: /agent/cluster_agent/troubleshooting/
285+
[8]: /getting_started/tagging/unified_service_tagging
286+
[9]: /integrations/http_check/
287+
[10]: /integrations/nginx/
288+
[11]: /agent/cluster_agent/troubleshooting/

content/en/agent/cluster_agent/setup.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,9 @@ After having set up the Datadog Cluster Agent, configure your Datadog Agent to c
174174

175175
5. In the `agent.yaml` manifest, add the environment variable `DD_CLUSTER_AGENT_ENABLED` and set it to `true`.
176176

177-
6. Create the DaemonSet with this command: `kubectl apply -f agent.yaml`
177+
6. (Optional) If your cluster encompasses a single environment, you can also set `<DD_ENV>` in the `agent.yaml`.
178+
179+
7. Create the DaemonSet with this command: `kubectl apply -f agent.yaml`
178180

179181
### Verification
180182

0 commit comments

Comments
 (0)