Skip to content

[CONTP-1795] Add agent performance metrics to agent telemetry page#38045

Open
Mathew-Estafanous wants to merge 2 commits into
masterfrom
mathew.estafanous/agent-performance-coat
Open

[CONTP-1795] Add agent performance metrics to agent telemetry page#38045
Mathew-Estafanous wants to merge 2 commits into
masterfrom
mathew.estafanous/agent-performance-coat

Conversation

@Mathew-Estafanous

@Mathew-Estafanous Mathew-Estafanous commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

  • Add the Agent Performance metric group to the Data Security Agent metrics table.
  • Document restart, termination, memory usage, and memory limit metrics for the Datadog Cluster Agent and Cluster Checks Runner pods.

Relates to DataDog/datadog-agent#53321

Merge readiness

  • Agent version 7.82 is released

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Additional notes

@Mathew-Estafanous Mathew-Estafanous requested a review from a team as a code owner July 8, 2026 14:56
@Mathew-Estafanous Mathew-Estafanous changed the title Add agent performance metrics to agent telemetry page [CONTP-1795] Add agent performance metrics to agent telemetry page Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@buraizu buraizu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, I've left a couple of suggestions.

Additionally, the new "Agent Performance" category name may be broader than its actual scope. Since all four new rows are Kubernetes pod-level resource metrics specifically for the Cluster Agent and Cluster Checks Runner pods, would something like "Cluster Agent Performance" be a more precise header? Or potentially folding these rows into the existing Cluster Agent category directly above — similar to how other categories on this page (Service Discovery, GPU Monitoring) are named for their exact scope.

Let me know what you think!

Comment thread content/en/data_security/agent.md Outdated
| appsec_injector.sidecar_mutations | Number of AppSec injector sidecar admission outcomes (pod mutation and deletion) |
| **Agent Performance** | |
| kubernetes_agent.containers_restarts | Sum of container restart counts for Datadog Cluster Agent and Cluster Checks Runner pods |
| kubernetes_agent.containers_terminated | Sum of kubelet container terminated-state metrics for Datadog Cluster Agent and Cluster Checks Runner pods, preserving the `reason` tag |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| kubernetes_agent.containers_terminated | Sum of kubelet container terminated-state metrics for Datadog Cluster Agent and Cluster Checks Runner pods, preserving the `reason` tag |
| kubernetes_agent.containers_terminated | Sum of container terminations for Datadog Cluster Agent and Cluster Checks Runner pods, tagged by reason` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion to follow the established pattern for describing a tag dimension on a metric — see line 171 ("Count of HTTP connectivity retry attempts, tagged by status (success or failure)"). "Preserving the reason tag" doesn't match that convention and is less clear about what the tag represents.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. I'll make the change.

@datadog-datadog-prod-us1-2

This comment has been minimized.

@Mathew-Estafanous Mathew-Estafanous requested a review from buraizu July 9, 2026 19:09

@buraizu buraizu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Mathew-Estafanous thanks for applying that feedback! I've left a couple of additional minor suggestions, mainly for consistency, and a question. Let me know if you have any questions or feedback!

| kubernetes_agent.containers_terminated | Sum of kubelet container terminated-state metrics for Datadog Cluster Agent and Cluster Checks Runner pods, preserving the `reason` tag |
| kubernetes_agent.memory_usage | Sum of container runtime memory usage for Datadog Cluster Agent and Cluster Checks Runner pods |
| kubernetes_agent.memory_limit | Sum of container runtime memory limits for Datadog Cluster Agent and Cluster Checks Runner pods |
| agent_performance.containers_restarts | Sum of container restart counts for Datadog Cluster Agent and Cluster Checks Runner pods |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| agent_performance.containers_restarts | Sum of container restart counts for Datadog Cluster Agent and Cluster Checks Runner pods |
| agent_performance.containers_restarts | Number of container restarts for the Cluster Agent and Cluster Checks Runner pods |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking another look, I've realized that the other entries in this table all use Number of or Total for similar descriptions. Suggesting to update this for consistency.

Also suggesting to drop:

  • counts for redundancy
  • Datadog as being unnecessary given the context (the table section title itself is just "Cluster Agent"

| kubernetes_agent.memory_usage | Sum of container runtime memory usage for Datadog Cluster Agent and Cluster Checks Runner pods |
| kubernetes_agent.memory_limit | Sum of container runtime memory limits for Datadog Cluster Agent and Cluster Checks Runner pods |
| agent_performance.containers_restarts | Sum of container restart counts for Datadog Cluster Agent and Cluster Checks Runner pods |
| agent_performance.containers_terminated | Sum of container terminations for Datadog Cluster Agent and Cluster Checks Runner pods, tagged by reason |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| agent_performance.containers_terminated | Sum of container terminations for Datadog Cluster Agent and Cluster Checks Runner pods, tagged by reason |
| agent_performance.containers_terminated | Number of container terminations for Cluster Agent and Cluster Checks Runner pods, tagged by reason |

Comment on lines +237 to +238
| agent_performance.memory_usage | Sum of container runtime memory usage for Datadog Cluster Agent and Cluster Checks Runner pods |
| agent_performance.memory_limit | Sum of container runtime memory limits for Datadog Cluster Agent and Cluster Checks Runner pods |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Sum of" or "count of" for these metrics is a bit confusing in the absence of a unit to measure by. For example, the pymem.inuse metric on line 156 in this table uses byte:

Total container runtime memory usage, in bytes, for the Datadog Cluster Agent and Cluster Checks Runner pods

Would it be possible to update these descriptions accordingly, with whatever units are applicable for these metrics?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants