open-nomad/website/pages/docs/commands/monitor.mdx

57 lines
1.7 KiB
Plaintext
Raw Normal View History

---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: monitor'
sidebar_title: monitor
description: |
Stream the logs of a running nomad agent.
---
# Command: monitor
The `nomad monitor` command streams log messages for a given agent.
## Usage
```plaintext
nomad monitor [options]
```
2019-11-05 19:24:52 +00:00
The nomad monitor command can be used to stream the logs of a
running Nomad agent. Monitor will follow logs and exit when
interrupted or until the remote agent quits.
2019-11-05 19:24:52 +00:00
The power of the monitor command is that it allows you to log
the agent at a relatively high log level (such as "warn"),
but still access debug logs and watch the debug logs if necessary.
The monitor command also allows you to specify a single client node id to follow.
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
## Monitor Options
2019-11-05 19:24:52 +00:00
- `-log-level`: The log level to use for log streaming. Defaults to `info`.
2020-02-06 23:45:31 +00:00
Possible values include `trace`, `debug`, `info`, `warn`, `error`
2019-11-05 19:24:52 +00:00
- `-node-id`: Specifies the client node-id to stream logs from. If no
2020-02-06 23:45:31 +00:00
node-id is given the nomad server from the -address flag will be used.
- `-server-id`: Specifies the nomad server id to stream logs from. Accepts
2020-02-06 23:45:31 +00:00
server names from `nomad server members` and also a special `leader` option
which will target the current leader.
- `-json`: Stream logs in json format
## Examples
```shell
$ nomad monitor -log-level=DEBUG -node-id=a57b2adb-1a30-2dda-8df0-25abb0881952
2019-11-04T12:22:08.528-0500 [DEBUG] http: request complete: method=GET path=/v1/agent/health?type=server duration=1.445739ms
2019-11-04T12:22:09.892-0500 [DEBUG] nomad: memberlist: Stream connection from=127.0.0.1:53628
$ nomad monitor -log-level=DEBUG -json=true
{"@level":"debug","@message":"request complete"...}
```