Skip to content

Commit

Permalink
Add note that monitor command may truncate logs (#13079)
Browse files Browse the repository at this point in the history
* Add note that monitor command may truncate logs

* Apply suggestions from code review

Co-authored-by: Nick Cabatoff <[email protected]>

Co-authored-by: Nick Cabatoff <[email protected]>
  • Loading branch information
mladlow and ncabatoff authored Nov 8, 2021
1 parent ceea50b commit 33a140a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions website/content/api-docs/system/monitor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ description: The `/sys/monitor` endpoint is used to receive streaming logs from

The `/sys/monitor` endpoint is used to receive streaming logs from the Vault server.

If Vault is emitting log messages faster than a receiver can process them, the
some log lines will be dropped.

## Monitor system logs

This endpoint streams logs back to the client from Vault. Note that unlike most API endpoints in Vault, this one
Expand Down
3 changes: 3 additions & 0 deletions website/content/docs/commands/monitor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Note that this command is designed to run indefinitely. It is similar to
it encounters an unexpected error. As a user, you must terminate this
process yourself to shut it down.

If Vault is emitting log messages faster than a receiver can process them, the
some log lines will be dropped.

## Examples

Monitor server logs at the `debug` log level:
Expand Down

0 comments on commit 33a140a

Please sign in to comment.