Skip to content

docs(dev): document registerSensitiveMethods() in logging.rst - #15705

Open
whoalin1 wants to merge 1 commit into
nextcloud:masterfrom
whoalin1:docs-register-sensitive-methods-logging
Open

whoalin1 wants to merge 1 commit into
nextcloud:masterfrom
whoalin1:docs-register-sensitive-methods-logging

Conversation

@whoalin1

@whoalin1 whoalin1 commented Oct 6, 2026 •

Copy link
Copy Markdown

Summary

Documents IRegistrationContext::registerSensitiveMethods() in developer_manual/basics/logging.rst so app authors know how to keep secrets out of logged exception stack traces.

  • New section after Logging exceptions: register methods that accept secrets during bootstrap; the logger redacts those arguments in stack traces.
  • Short code example using Application::register().
  • Note that this only covers stack traces — never put passwords, tokens, or personal data into a log message yourself.

Closes #15680

Test plan

  • Sphinx build of the developer manual succeeds for the logging page
  • Section documents registerSensitiveMethods() with class + method-name array
  • Note states redaction is stack-trace-only; secrets must not be logged in messages

AI disclosure

This PR was drafted with the help of AI coding assistants (Cursor agents / LLM-based tools), including the description. I am responsible for it and happy to rework anything that doesn't fit.

All commits carry an Assisted-by: Cursor:grok-4.7 trailer.

Assisted-by: Cursor:grok-4.7
Signed-off-by: whoalin1 <[email protected]>
@whoalin1
whoalin1 force-pushed the docs-register-sensitive-methods-logging branch from c348221 to 789e2ae Compare October 9, 2026 14:13

This branch has not been deployed

No deployments
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.

Developer manual: document registerSensitiveMethods() in logging.rst

1 participant