Implement logs websocket #23016
Merged
Implement logs websocket #23016
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 6863bc7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
br41nslug
reviewed
Jul 15, 2024
There was a problem hiding this comment.
Couple of initial thoughts looking at this PR :)
Since this WS endpoint will only have a single purpose we could simplify the handler a bit:
- require authentication mode
strictand admin only - instead of recreating a subscription model the connection itself can be a subscription where a successful connection is "subscribed" and a closed connection "unsubscribed"
And as extra thought, do we want to buffer some logs so there is some backlog to be fetched/rendered? Or do we want to keep it fully ephemeral
* simplify logging handler * enforce strict mode * Update logs handler * Update docs --------- Co-authored-by: ian <[email protected]>
br41nslug
reviewed
Jul 16, 2024
br41nslug
reviewed
Aug 28, 2024
br41nslug
approved these changes
Aug 29, 2024
u12206050
pushed a commit
to u12206050/directus
that referenced
this pull request
Sep 5, 2024
* Implement logs websocket * Update docs * Remove commented test code * fixed controller shared logic * fixed controller type * Added shutdown callback * Expose allowed log levels * Use a different event * Add log level filtering * Return log_level when subscribed * Remove unused import * Limit logs websocket to `strict` auth mode (directus#23023) * simplify logging handler * enforce strict mode * Update logs handler * Update docs --------- Co-authored-by: ian <[email protected]> * Add unique nodeId as uid * Create logStream only when required * Add admin requirement check * Extract isValidLogLevel as util * Remove authentication and path from server info * Remove hostname and pid from logs if not raw * Fix nodeId implementation * Support custom log levels * Fix build * Fix test * Remove unused constants and util * Display websocket logs details in server info for admins only * Expose log level value in server info * Stream raw logs to websocket * Retain hostname and pid field in raw logs * Add separate env var for logs streaming * Reset attempts after reconnection failure * Remove obsolete accountability refreshing * Run handler only when enabled * Add changeset * Allow wss protocol * Rename to logs-stream * Add unit tests * Add explicit check for the remaining client * Updated json stringification in log-streaming * prettier --------- Co-authored-by: Brainslug <[email protected]> Co-authored-by: Brainslug <[email protected]>
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.
Scope
What's changed:
Potential Risks / Drawbacks
Review Notes / Questions
TODO
Fixes #22482