mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 23:21:08 +02:00
ad55f8aaa3
* Restructure and add partial * Update website/content/docs/commands/monitor.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/commands/monitor.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-format.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-format.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-format.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-level.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-level.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/partials/cli/monitor/flags/log-level.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Address feedback --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
78 lines
1.6 KiB
Plaintext
78 lines
1.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'monitor - Vault CLI'
|
|
description: |-
|
|
Display the server logs of a Vault server in real time.
|
|
---
|
|
|
|
# `monitor`
|
|
|
|
Stream Vault server logs in real-time to `stdout`.
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ vault monitor [flags]
|
|
|
|
$ vault monitor [-help | -h]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## 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` honors the `VAULT_ADDR` environment variable. The address
|
|
specified determines the target server that will be monitored.
|
|
|
|
### Limitations and warnings
|
|
|
|
- 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.
|
|
|
|
- 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">
|
|
|
|
MonitorLogs - [`GET: /sys/monitor`](/vault/api-docs/system/monitor)
|
|
|
|
</Tip>
|
|
|
|
## Command arguments
|
|
|
|
- None
|
|
|
|
## Command options
|
|
|
|
- None
|
|
|
|
## Command flags
|
|
|
|
<br />
|
|
|
|
@include 'cli/monitor/flags/log-level.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:
|
|
|
|
```shell-session
|
|
$ vault monitor -log-level=debug
|
|
```
|