Add Kubernetes Resource Monitoring documentation#54134
Open
amadeuszl wants to merge 9 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. |
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
Author
|
@tommcdon can you please review? |
Author
|
@dotnet/docs can you please review? |
BillWagner
reviewed
Jun 18, 2026
BillWagner
left a comment
BillWagner
left a comment
Member
There was a problem hiding this comment.
Hi @amadeuszl
I added a few comments, and then this is ready to merge.
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>net8.0</TargetFramework> |
Member
There was a problem hiding this comment.
Is there a reason for .NET 8 instead of .NET 10?
| @@ -0,0 +1,13 @@ | |||
| // <setup> | |||
Member
There was a problem hiding this comment.
nit, but because you include the entire file, you don't need the snippet tags:
Suggested change
| // <setup> |
|
|
||
| In your application code, call <xref:Microsoft.Extensions.DependencyInjection.KubernetesResourceQuotaServiceCollectionExtensions.AddKubernetesResourceMonitoring*> with the environment variable prefix that matches your Kubernetes manifest: | ||
|
|
||
| :::code source="snippets/resource-monitoring-kubernetes/Program.cs" id="setup"::: |
Member
There was a problem hiding this comment.
If you make the changes I suggested in program.cs, you can remove the id here:
Suggested change
| :::code source="snippets/resource-monitoring-kubernetes/Program.cs" id="setup"::: | |
| :::code source="snippets/resource-monitoring-kubernetes/Program.cs"::: |
| .Build(); | ||
|
|
||
| await app.RunAsync(); | ||
| // </setup> |
Member
There was a problem hiding this comment.
to match:
Suggested change
| // </setup> |
|
|
||
| When you run your application inside a Kubernetes pod with the environment variables configured, the metrics produce values such as: | ||
|
|
||
| ``` |
Member
There was a problem hiding this comment.
Add the language tag for proper formatting:
Suggested change
| ``` | |
| ```console |
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