Skip to content

Commit

Permalink
minor text edits and update includes to use shared partials for log l…
Browse files Browse the repository at this point in the history
…evel and log format (#28771)
  • Loading branch information
schavis authored Oct 25, 2024
1 parent f439a1e commit cccad7d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 42 deletions.
51 changes: 26 additions & 25 deletions website/content/docs/commands/monitor.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: 'monitor - Vault CLI'
description: |-
Display the server logs of a Vault server in real time.
description: >-
Use vault monitor to stream server logs to stdout in real time.
---

# `monitor`
Expand All @@ -21,56 +21,57 @@ $ vault monitor [-help | -h]

## Description

`vault monitor` command shows a real time display of the server logs of a Vault
server. This command accepts a log level as an argument, which can be different
from the log level that the Vault server was started with.
`vault monitor` streams Vault server logs to `stdout` in real time based on the
address stored in `VAULT_ADDR` or passed through `-address`. Use the
`-log-level` flag to override the default log level set for the Vault server.

`vault monitor` honors the `VAULT_ADDR` environment variable. The address
specified determines the target server that will be monitored.
<Tip title="Related API endpoints">

### Limitations and warnings
MonitorLogs - [`GET: /sys/monitor`](/vault/api-docs/system/monitor)

- Note that this command is designed to run indefinitely. It is similar to
`tail -f` in the Unix world. This command will not exit on its own unless
it encounters an unexpected error. As a user, you must terminate this
process yourself to shut it down.
</Tip>

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

<Tip title="Related API endpoints">
### Limitations and warnings

- `vault monitor` runs indefinitely and only exits if an unexpected error occurs.

- `vault monitor` may drop log lines if Vault is emitting log messages faster
than the receiver can process the input.

MonitorLogs - [`GET: /sys/monitor`](/vault/api-docs/system/monitor)

</Tip>

## Command arguments

- None
None.

## Command options

- None
None.

## Command flags

<br />

@include 'cli/monitor/flags/log-level.mdx'
@include 'cli/shared/flags/log-level.mdx'

<br /><hr /><br />

@include 'cli/shared/flags/log-format.mdx'


<br />
<hr />
<br />

@include 'cli/monitor/flags/log-format.mdx'

## Standard flags

@include 'cli/standard-settings/all-standard-flags.mdx'




## Examples

Monitor server logs at the `debug` log level:
Stream server logs at the `debug` log level:

```shell-session
$ vault monitor -log-level=debug
Expand Down
8 changes: 0 additions & 8 deletions website/content/partials/cli/monitor/flags/log-format.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions website/content/partials/cli/monitor/flags/log-level.mdx

This file was deleted.

0 comments on commit cccad7d

Please sign in to comment.