Skip to content

Updating container guidance for diag tools #45821

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 17, 2025
Merged

Updating container guidance for diag tools #45821

merged 2 commits into from
Apr 17, 2025

Conversation

noahfalk
Copy link
Member

@noahfalk noahfalk commented Apr 16, 2025 •
edited by github-actions bot
Loading

  • Removed info about installation which is already covered in individual tool docs and has been unchanged for years
  • Add considerations about resource limits, security permissions, container size, and attack surface
  • Add information about the newer --diagnostic-port CLI option which doesn't require process namespace or /tmp sharing
  • Add warnings that tools (dotnet-dump especially) could cause containers with insufficient memory to be killed.
  • Warn that dotnet-dump writes out the dump relative to the target container file system view
  • Remove the weird recommendation that suggested perfcollect was only intended for pre-.NET Core 3.0 apps.
  • The text was unnecessarily refering to Docker. This guidance is likely to apply to any Linux container runtime, not just Docker.

Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/diagnostics-in-containers.md Collect diagnostics in Linux containers

@noahfalk
Updating container guidance for diag tools
143cfe6 
- Removed info about installation which is already covered in individual tool docs and has been unchanged for years
- Add considerations about resource limits, security permissions, container size, and attack surface
- Add information about the newer --diagnostic-port CLI option which doesn't require process namespace or /tmp sharing
- Add warnings that tools (dotnet-dump especially) could cause containers with insufficient memory to be killed.
- Warn that dotnet-dump writes out the dump relative to the target container file system view
- Remove the weird recommendation that suggested perfcollect was only intended for pre-.NET Core 3.0 apps.
- The text was unnecessarily refering to Docker. This guidance is likely to apply to any Linux container runtime, not just Docker.
@noahfalk noahfalk requested review from tommcdon and a team as code owners April 16, 2025 10:08
@dotnetrepoman dotnetrepoman bot added this to the April 2025 milestone Apr 16, 2025
@noahfalk
Copy link
Member Author

fyi @dotnet/dotnet-diag @brianrob

@CamSoper @gewarren - Please take a look when one of you gets the chance. Thanks!

@noahfalk noahfalk enabled auto-merge (squash) April 16, 2025 10:21
@BillWagner BillWagner requested a review from CamSoper April 16, 2025 13:18
CamSoper
CamSoper suggested changes Apr 16, 2025
View reviewed changes
Copy link
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

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

Overall, LGTM @noahfalk. I added some formatting in my suggestions.

@noahfalk @CamSoper
Apply suggestions from code review
f964827 
Co-authored-by: Cam Soper <cam.soper@microsoft.com>
@noahfalk
Copy link
Member Author

Thanks @CamSoper! All suggestions applied.

@noahfalk noahfalk merged commit 4bd8a91 into dotnet:main Apr 17, 2025
8 checks passed
@noahfalk noahfalk mentioned this pull request Apr 17, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CamSoper CamSoper CamSoper approved these changes

@tommcdon tommcdon Awaiting requested review from tommcdon tommcdon is a code owner

Assignees
No one assigned
Labels
dotnet-fundamentals/svc
Projects
None yet
Milestone
April 2025
Development

Successfully merging this pull request may close these issues.
2 participants
@noahfalk @CamSoper