-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[CXP-2151] Updates to Processes and Containers documentation #29409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
0976b6a
92e3b9e
eefb105
6b599ae
25b945a
4983b64
78edd92
ea3381d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,23 +35,25 @@ Coupled with [Docker][2], [Kubernetes][3], [ECS][4], and other container technol | |
|
||
## Setup | ||
|
||
To display data on the Containers view, enable the Process Agent. | ||
To display data on the Containers view, enable container collection. | ||
|
||
{{< tabs >}} | ||
{{% tab "Docker" %}} | ||
|
||
Set the `DD_PROCESS_AGENT_ENABLED` env variable to `true`. | ||
The Datadog Agent enables container collection in Docker environments by default. | ||
|
||
For verification, ensure that `DD_PROCESS_CONFIG_CONTAINER_COLLECTION_ENABLED` is set to `true`. | ||
|
||
For example: | ||
|
||
``` | ||
-v /etc/passwd:/etc/passwd:ro | ||
-e DD_PROCESS_AGENT_ENABLED=true | ||
-e DD_PROCESS_CONFIG_CONTAINER_COLLECTION_ENABLED=true | ||
``` | ||
{{% /tab %}} | ||
{{% tab "Datadog Operator" %}} | ||
|
||
The Datadog Operator enables the Process Agent by default. | ||
The Datadog Operator enables container collection by default. | ||
|
||
For verification, ensure that `features.liveContainerCollection.enabled` is set to `true` in your `datadog-agent.yaml`: | ||
|
||
|
@@ -73,38 +75,40 @@ spec: | |
{{% /tab %}} | ||
{{% tab "Helm" %}} | ||
|
||
If you are using the [official Helm chart][1], enable the `processAgent.enabled` parameter in your [`values.yaml`][2] file: | ||
If you are using the [official Helm chart][1], container collection is enabled by default. | ||
|
||
For verification, ensure that the `processAgent.containerCollection` parameter is set to `true` in your [`values.yaml`][2] file: | ||
|
||
```yaml | ||
datadog: | ||
# (...) | ||
processAgent: | ||
enabled: true | ||
containerCollection: true | ||
``` | ||
|
||
Then, upgrade your Helm chart. | ||
|
||
In some setups, the Process Agent and Cluster Agent cannot automatically detect a Kubernetes cluster name. If this happens, the feature does not start, and the following warning displays in the Cluster Agent log: `Orchestrator explorer enabled but no cluster name set: disabling.` In this case, you must set `datadog.clusterName` to your cluster name in `values.yaml`. | ||
In some setups, the Cluster Agent cannot automatically detect a Kubernetes cluster name. If this happens, the feature does not start, and the following warning displays in the Cluster Agent log: `Orchestrator explorer enabled but no cluster name set: disabling.` In this case, you must set `datadog.clusterName` to your cluster name in `values.yaml`. | ||
|
||
```yaml | ||
datadog: | ||
#(...) | ||
clusterName: <YOUR_CLUSTER_NAME> | ||
#(...) | ||
processAgent: | ||
enabled: true | ||
containerCollection: true | ||
``` | ||
|
||
[1]: https://github.com/DataDog/helm-charts | ||
[2]: https://github.com/DataDog/helm-charts/blob/master/charts/datadog/values.yaml | ||
{{% /tab %}} | ||
{{% tab "Amazon ECS" %}} | ||
|
||
Update your Task Definitions with the following environment variable: | ||
Update your task definitions with the following environment variable: | ||
|
||
```json | ||
{ | ||
"name": "DD_PROCESS_AGENT_ENABLED", | ||
"name": "DD_PROCESS_CONFIG_CONTAINER_COLLECTION_ENABLED", | ||
"value": "true" | ||
} | ||
``` | ||
|
@@ -169,14 +173,13 @@ ECS containers are tagged by: | |
Kubernetes containers are tagged by: | ||
|
||
* `pod_name` | ||
* `kube_pod_ip` | ||
* `kube_service` | ||
* `kube_namespace` | ||
* `kube_replica_set` | ||
* `kube_daemon_set` | ||
* `kube_job` | ||
* `kube_deployment` | ||
* `kube_cluster` | ||
* `kube_cluster_name` | ||
|
||
If you have a configuration for [Unified Service Tagging][7] in place, Datadog automatically picks up `env`, `service`, and `version` tags. Having these tags available lets you tie together APM, logs, metrics, and container data. | ||
|
||
|
@@ -194,7 +197,7 @@ You can switch between the "Scatter Plot" and "Timeseries" tabs in the collapsib | |
|
||
By default, the graph groups by the `short_image` tag key. The size of each dot represents the number of containers in that group, and clicking on a dot displays the individual containers and hosts that contribute to the group. | ||
|
||
The query at the top of the scatter plot analytic allows you to control your scatter plot analytic: | ||
The options at the top of the graph allow you to control your scatter plot analytic: | ||
|
||
* Selection of metrics to display. | ||
* Selection of the aggregation method for both metrics. | ||
|
@@ -226,7 +229,7 @@ You can see indexed logs that you have chosen to index and persist by selecting | |
|
||
{{< img src="infrastructure/livecontainers/errorlogs.png" alt="Preview Logs Side panel" style="width:100%;">}} | ||
|
||
## Notes and known issues | ||
## Additional information | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Neither of these seem like issues, so updating the section title to match the one on the Processes page: https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows#additional-information |
||
|
||
* Real-time (2s) data collection is turned off after 30 minutes. To resume real-time collection, refresh the page. | ||
* RBAC settings can restrict Kubernetes metadata collection. See the [RBAC entities for the Datadog Agent][14]. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,11 +39,11 @@ You can generate a new process-based metric directly from queries in the [**Live | |
|
||
{{< img src="infrastructure/process/process2metrics_create.png" alt="Create a process-based metric" style="width:80%;">}} | ||
|
||
1. **Select tags to filter your query**: The query syntax is the same as for [Live Processes][2]. Only processes matching the scope of your filters are considered for aggregation. Text search filters are supported only on the Live Processes page. | ||
1. **Select tags to filter your query**: The available tags are the same as for [Live Processes][2]. Only processes matching the scope of your filters are considered for aggregation. Text search filters are supported only on the Live Processes page. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The query syntax is not the same. Boolean operators are not supported here, unlike in the Processes page. |
||
2. **Select the measure you would like to track**: Enter a measure such as `Total CPU %` to aggregate a numeric value and create its corresponding `count`, `min`, `max`, `sum`, and `avg` aggregated metrics. | ||
3. **Add tags to `group by`**: Select tags to be added as dimensions to your metrics, so they can be filtered, aggregated, and compared. By default, metrics generated from processes do not have any tags unless explicitly added. Any tag available for Live Processes queries can be used in this field. | ||
4. **Name your metric**: Fill in the name of your metric. Process-based metrics always have the prefix _proc._ and suffix _[measure_selection]_. | ||
5. **Add percentile aggregations**: Select the _Include percentile aggregations_ checkbox to generate p50, p75, p90, p95, and p99 percentiles. Percentile metrics are also considered customer metrics, and billed accordingly. | ||
5. **Add percentile aggregations**: Select the _Include percentile aggregations_ checkbox to generate p50, p75, p90, p95, and p99 percentiles. Percentile metrics are also considered custom metrics, and billed accordingly. | ||
|
||
You can create multiple metrics using the same query by selecting the **Create Another** checkbox at the bottom of the metric creation modal. When selected, the modal remains open after your metric has been created, with the filters and aggregation groups already filled in. | ||
|
||
|
@@ -67,7 +67,7 @@ To change the metric type or name, a new metric must be created. | |
|
||
{{< img src="infrastructure/process/process2metrics_dashboard_widget.png" alt="Graphing process distribution metrics in dashboards" style="width:80%;">}} | ||
|
||
Once created, you can use process distribution aggregate and percentile metrics like any other in Datadog. For instance: | ||
Once created, you can use process-based metrics like any other in Datadog. For instance: | ||
|
||
- Graph process-based metrics in dashboards and notebooks to track the historical resource consumption of important workloads | ||
- Create threshold or anomaly-based monitors on top of process-based metrics to detect when CPU or RSS memory dips or spikes unexpectedly | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove mention of dedicated process agent as container collection functionality no longer runs in process agent by default