Add comprehensive logged events documentation for management-api#166
Draft
Add comprehensive logged events documentation for management-api#166
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Co-authored-by: phev8 <13927969+phev8@users.noreply.github.com>
Co-authored-by: phev8 <13927969+phev8@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Provide a list of all logged events in management API
Add comprehensive logged events documentation for management-api
Nov 17, 2025
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.
The management-api lacked documentation of its logged events, making monitoring setup and debugging inefficient.
Changes
LOGGED_EVENTS.md: Comprehensive reference documenting all 350 unique log events across 9 source files, organized by file and log level (Info/Warn/Error/Debug) with source line numbersREADME.md: Added link to logged events documentation.gitignore: Added patterns for compiled service binariesDocumentation Structure
Events are categorized by source file and log level for quick reference:
Each event includes its source line number and contextual logging attributes (instanceID, userID, studyKey, etc.) are documented for log aggregation and filtering.
The documentation was auto-generated from source code to ensure accuracy and completeness.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.