HashiDays One conference. Three cities. Find a city near you
Nomad
Nomad Home

Command: agent-info

The agent-info command dumps metrics and status information of a running agent. The information displayed pertains to the specific agent the CLI is connected to. This is useful for troubleshooting and performance monitoring.

Usage

nomad agent-info [options]

When ACLs are enabled, this command requires a token with the agent:read capability.

General Options

  • -address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

  • -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.

  • -force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.

  • -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.

  • -ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.

  • -client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.

  • -client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.

  • -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.

  • -tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.

  • -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

Agent Info Options

  • -json : Output agent info in its JSON format.
  • -t : Format and display agent info using a Go template.

Output

Depending on the agent queried, information from different subsystems is returned. These subsystems are described below:

  • 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
  • runtime - Various metrics from the runtime environment

Examples

$ nomad agent-inforaft  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 = 0runtime  cpu_count = 4  goroutines = 43  kernel.name = darwin  max_procs = 4  version = go1.5  arch = amd64serf  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 = falseclient  heartbeat_ttl = 0  known_servers = 0  last_heartbeat = 9223372036854775807  num_allocations = 0nomad  bootstrap = false  known_regions = 1  leader = false  server = true
Edit this page on GitHub