Add Kubernetes Resource Monitoring documentation#54134
Open
amadeuszl wants to merge 5 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation and a runnable snippet that explains how to use Microsoft.Extensions.Diagnostics.ResourceMonitoring.Kubernetes to calculate resource monitoring metrics based on Kubernetes Downward API-provided limits/requests.
Changes:
- Added a new “Kubernetes resource monitoring” section to the existing resource monitoring article, including Downward API configuration guidance.
- Added a new runnable snippet project and minimal host-based sample that registers Kubernetes resource monitoring.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| docs/core/diagnostics/diagnostic-resource-monitoring.md | Adds a Kubernetes-focused resource monitoring section, including configuration guidance, metric list, and example output. |
| docs/core/diagnostics/snippets/resource-monitoring-kubernetes/Program.cs | Adds a minimal host-based snippet showing AddKubernetesResourceMonitoring("MY_APP_"). |
| docs/core/diagnostics/snippets/resource-monitoring-kubernetes/resource-monitoring-kubernetes.csproj | Adds a new snippet project referencing the Kubernetes resource monitoring package and hosting/logging dependencies. |
Comment on lines
+291
to
+295
| 1. **Use the Kubernetes package in Kubernetes environments.** Always prefer `AddKubernetesResourceMonitoring()` over `AddResourceMonitoring()` when running in a Kubernetes cluster. It provides accurate resource utilization metrics by reading values directly from the pod specification through environment variables. | ||
|
|
||
| 1. **Expose resource metadata through the Downward API.** Configure your deployment manifests to expose CPU and memory limits and requests as environment variables. This ensures the library has access to the exact values you specified in your pod spec. | ||
|
|
||
| 1. **Test metric accuracy after cluster upgrades.** When upgrading your Kubernetes cluster or OCI runtime (runc, crun), verify that your resource utilization metrics still report expected values, especially if you use the base `AddResourceMonitoring()` method. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…deuszl/docs into alechniak/k8s-rm-docs-update
evgenyfedorov2
approved these changes
Jun 5, 2026
| | `dotnet.process.memory.virtual.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The memory consumption of the running application in range `[0, 1]`. | | ||
|
|
||
| Available starting in: .NET 8. | ||
|
|
Member
There was a problem hiding this comment.
why do we want to remove the information about network metrics?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
It adds documentation about changes implemented due to dotnet/extensions#6496
Internal previews