Skip to content

Conversation

@noahfalk
Copy link
Member

@noahfalk noahfalk commented Feb 7, 2025

Fixes dotnet/diagnostics#4375

  • The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace. I added that information as well as a more complete description of the ptrace access checking.

  • There was no link to the FAQ in the TOC so I added one.

  • I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.


Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/dumps.md Dumps
docs/core/diagnostics/faq-dumps.yml FAQ for dumps
docs/navigate/tools-diagnostics/toc.yml docs/navigate/tools-diagnostics/toc

Fixes dotnet/diagnostics#4375

- The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace.
I added that information as well as a more complete description of the ptrace access checking.

- I replaced faq-dumps.yml with dump-faq.md. The yml file included markdown style links but that content was not properly
rendered in the html page. Maybe there was a way to make that work as-is but it seemed simpler to use markdown similar
to all the other pages in this part of the docs. I redirected links to the new page but left the old .yml page for now in case
there were external direct links to it.

- There was no link to the FAQ in the TOC so I added one.

- I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.
@noahfalk noahfalk marked this pull request as ready for review February 7, 2025 08:35
@noahfalk noahfalk requested review from a team and tommcdon as code owners February 7, 2025 08:35
@noahfalk
Copy link
Member Author

noahfalk commented Feb 7, 2025

@hoyosjs - could you take a look?

@gewarren
Copy link
Contributor

@noahfalk - A couple of preliminary comments:

  1. It looks like the FAQ was removed from the TOC in this PR: https://github.com/dotnet/docs/pull/35727/files#diff-b145b47b58321afe32381e792b9078f298017444a9ec9823d775e1324c28c6e0
  2. The Learn platform guide wants us to create FAQ docs as YAML files for search result optimization (see [the internal only doc] https://review.learn.microsoft.com/en-us/help/patterns/level4/article-structured-faq?branch=main#what-is-this-pattern)

@noahfalk
Copy link
Member Author

The Learn platform guide wants us to create FAQ docs as YAML files

OK, when I change it back to YAML should I strip the links out of the questions? Previously those links weren't rendering properly.

It looks like the FAQ was removed from the TOC in this PR

Do you think I should leave it out of the TOC? I was under the impression that all content was recommended to be in the TOC.

@gewarren
Copy link
Contributor

OK, when I change it back to YAML should I strip the links out of the questions? Previously those links weren't rendering properly.

Yes, I don't think you can have links in the questions.

Do you think I should leave it out of the TOC? I was under the impression that all content was recommended to be in the TOC.

No, it should absolutely be in the TOC. I'm just pointing out that it was probably accidentally dropped during that reorganization of the TOC.

Copy link
Member

@hoyosjs hoyosjs left a comment

Choose a reason for hiding this comment

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

Discussed feedback offline.

@hoyosjs
Copy link
Member

hoyosjs commented Feb 11, 2025

Part of me feels that YML FAQ optimization is nice, but the links are essential to this particular doc. Is there a strong opinion on it having to be yml?

@noahfalk
Copy link
Member Author

Part of me feels that YML FAQ optimization is nice, but the links are essential to this particular doc. Is there a strong opinion on it having to be yml?

We don't need to remove all the links, just I think two of them that show up in the question text itself.

@gewarren
Copy link
Contributor

gewarren commented Feb 11, 2025

Part of me feels that YML FAQ optimization is nice, but the links are essential to this particular doc. Is there a strong opinion on it having to be yml?

Could you do something like this, basically move the links to the answer?

  - question: |
      Why do I only get dumps on Linux if dotnet-dump or my crashing process is running elevated?
    answer: | 
      On Linux-based systems, you only get dumps if [dotnet-dump](dotnet-dump.md) or the [crashing process](dumps.md#collect-dumps-on-crash) runs elevated because `/proc/sys/kernel/ptrace_scope` controls who can call `ptrace` and what processes they can trace. We recommend setting it to `1` - meaning only processes in the same ancestry chain can use traced. Any value higher than this requires elevation or might disable `ptrace` altogether.  

@noahfalk
Copy link
Member Author

I updated the PR back to yml and removed the links from the question. I didn't wind up adding the links to the answer either because in the revised text the links didn't fit as naturally. I don't think those two particular links were high importance.

Co-authored-by: Genevieve Warren <[email protected]>
@noahfalk noahfalk merged commit 7774020 into dotnet:main Feb 13, 2025
8 checks passed
@noahfalk
Copy link
Member Author

Thanks @gewarren and @hoyosjs for the review and feedback!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

dotnet-dump not working when process run as user

3 participants