2015-09-15 00:40:49 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: 'Commands: agent-info'
|
|
|
|
|
description: |
|
2015-09-15 00:40:49 +00:00
|
|
|
Display information and status of a running agent.
|
|
|
|
|
---
|
|
|
|
|
|
2015-09-15 01:04:56 +00:00
|
|
|
# Command: agent-info
|
2015-09-15 00:40:49 +00:00
|
|
|
|
|
|
|
|
The `agent-info` command dumps metrics and status information of a running
|
2016-03-15 18:28:31 +00:00
|
|
|
agent. The information displayed pertains to the specific agent the CLI
|
2015-09-24 21:37:32 +00:00
|
|
|
is connected to. This is useful for troubleshooting and performance monitoring.
|
2015-09-15 00:40:49 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2015-09-15 00:40:49 +00:00
|
|
|
nomad agent-info [options]
|
|
|
|
|
```
|
|
|
|
|
|
2020-11-19 21:38:08 +00:00
|
|
|
When ACLs are enabled, this command requires a token with the `agent:read`
|
|
|
|
|
capability.
|
|
|
|
|
|
2015-09-15 00:40:49 +00:00
|
|
|
## General Options
|
|
|
|
|
|
2020-11-19 18:02:48 +00:00
|
|
|
@include 'general_options_no_namespace.mdx'
|
2015-09-15 00:40:49 +00:00
|
|
|
|
2021-01-13 14:42:46 +00:00
|
|
|
## Agent Info Options
|
|
|
|
|
|
|
|
|
|
- `-json` : Output agent info in its JSON format.
|
|
|
|
|
- `-t` : Format and display agent info using a Go template.
|
|
|
|
|
|
2015-09-15 00:40:49 +00:00
|
|
|
## Output
|
|
|
|
|
|
|
|
|
|
Depending on the agent queried, information from different subsystems is
|
|
|
|
|
returned. These subsystems are described below:
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
- client - Status of the local Nomad client
|
|
|
|
|
- nomad - Status of the local Nomad server
|
|
|
|
|
- serf - Gossip protocol metrics and information
|
|
|
|
|
- raft - Status information about the Raft consensus protocol
|
2019-10-22 13:44:00 +00:00
|
|
|
- runtime - Various metrics from the runtime environment
|
2015-09-15 00:40:49 +00:00
|
|
|
|
2015-09-15 03:24:04 +00:00
|
|
|
## Examples
|
2015-09-15 00:40:49 +00:00
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ nomad agent-info
|
2015-09-15 00:40:49 +00:00
|
|
|
raft
|
|
|
|
|
commit_index = 0
|
|
|
|
|
fsm_pending = 0
|
|
|
|
|
last_contact = never
|
|
|
|
|
last_snapshot_term = 0
|
|
|
|
|
state = Follower
|
|
|
|
|
term = 0
|
|
|
|
|
applied_index = 0
|
|
|
|
|
last_log_index = 0
|
|
|
|
|
last_log_term = 0
|
|
|
|
|
last_snapshot_index = 0
|
|
|
|
|
num_peers = 0
|
|
|
|
|
runtime
|
|
|
|
|
cpu_count = 4
|
|
|
|
|
goroutines = 43
|
|
|
|
|
kernel.name = darwin
|
|
|
|
|
max_procs = 4
|
|
|
|
|
version = go1.5
|
|
|
|
|
arch = amd64
|
|
|
|
|
serf
|
|
|
|
|
intent_queue = 0
|
|
|
|
|
member_time = 1
|
|
|
|
|
query_queue = 0
|
|
|
|
|
event_time = 1
|
|
|
|
|
event_queue = 0
|
|
|
|
|
failed = 0
|
|
|
|
|
left = 0
|
|
|
|
|
members = 1
|
|
|
|
|
query_time = 1
|
|
|
|
|
encrypted = false
|
|
|
|
|
client
|
|
|
|
|
heartbeat_ttl = 0
|
|
|
|
|
known_servers = 0
|
|
|
|
|
last_heartbeat = 9223372036854775807
|
|
|
|
|
num_allocations = 0
|
|
|
|
|
nomad
|
|
|
|
|
bootstrap = false
|
|
|
|
|
known_regions = 1
|
|
|
|
|
leader = false
|
|
|
|
|
server = true
|
|
|
|
|
```
|
