github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/docs/commands/agent-info.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: agent-info'
     4  sidebar_title: agent-info
     5  description: |
     6    Display information and status of a running agent.
     7  ---
     8  
     9  # Command: agent-info
    10  
    11  The `agent-info` command dumps metrics and status information of a running
    12  agent. The information displayed pertains to the specific agent the CLI
    13  is connected to. This is useful for troubleshooting and performance monitoring.
    14  
    15  ## Usage
    16  
    17  ```plaintext
    18  nomad agent-info [options]
    19  ```
    20  
    21  When ACLs are enabled, this command requires a token with the `agent:read`
    22  capability.
    23  
    24  ## General Options
    25  
    26  @include 'general_options_no_namespace.mdx'
    27  
    28  ## Agent Info Options
    29  
    30  - `-json` : Output agent info in its JSON format.
    31  - `-t` : Format and display agent info using a Go template.
    32  
    33  ## Output
    34  
    35  Depending on the agent queried, information from different subsystems is
    36  returned. These subsystems are described below:
    37  
    38  - client - Status of the local Nomad client
    39  - nomad - Status of the local Nomad server
    40  - serf - Gossip protocol metrics and information
    41  - raft - Status information about the Raft consensus protocol
    42  - runtime - Various metrics from the runtime environment
    43  
    44  ## Examples
    45  
    46  ```shell-session
    47  $ nomad agent-info
    48  raft
    49    commit_index = 0
    50    fsm_pending = 0
    51    last_contact = never
    52    last_snapshot_term = 0
    53    state = Follower
    54    term = 0
    55    applied_index = 0
    56    last_log_index = 0
    57    last_log_term = 0
    58    last_snapshot_index = 0
    59    num_peers = 0
    60  runtime
    61    cpu_count = 4
    62    goroutines = 43
    63    kernel.name = darwin
    64    max_procs = 4
    65    version = go1.5
    66    arch = amd64
    67  serf
    68    intent_queue = 0
    69    member_time = 1
    70    query_queue = 0
    71    event_time = 1
    72    event_queue = 0
    73    failed = 0
    74    left = 0
    75    members = 1
    76    query_time = 1
    77    encrypted = false
    78  client
    79    heartbeat_ttl = 0
    80    known_servers = 0
    81    last_heartbeat = 9223372036854775807
    82    num_allocations = 0
    83  nomad
    84    bootstrap = false
    85    known_regions = 1
    86    leader = false
    87    server = true
    88  ```