Add note that monitor command may truncate logs (#13079)

* Add note that monitor command may truncate logs * Apply suggestions from code review Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com> Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>
hashicorp · Nov 8, 2021 · 09a96e2 · 09a96e2
1 parent 110bba1
commit 09a96e2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/website/content/api-docs/system/monitor.mdx b/website/content/api-docs/system/monitor.mdx
@@ -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

diff --git a/website/content/docs/commands/monitor.mdx b/website/content/docs/commands/monitor.mdx
@@ -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: