Varz
Request Schema
Request options for varz monitoring endpoint
Response Schema
NATS Server VARZ Monitoring output
server_idstring
The unique server ID generated at start
server_namestring
The configured server name, equals ID when not set
versionstring
The version of the running server
protointeger
The protocol version this server supports
git_commitstring
The git repository commit hash that the build corresponds with
gostring
The version of Go used to build this binary
hoststring
The hostname the server runs on
portinteger
The port the server listens on for client connections
auth_requiredboolean
Indicates if users are required to authenticate to join the server
tls_requiredboolean
Indicates if connections must use TLS when connecting to this server
tls_verifyboolean
Indicates if full TLS verification will be performed
tls_ocsp_peer_verifyboolean
Indicates if the OCSP protocol will be used to verify peers
ipstring
The IP address the server listens on if set
connect_urlsstring[]
The list of URLs NATS clients can use to connect to this server
ws_connect_urlsstring[]
The list of URLs websocket clients can use to connect to this server
max_connectionsinteger
The maximum amount of connections the server can accept
nanoseconds depicting a duration in time, signed 64 bit integer
Minimum:
-9223372036854776000Maximum:
9223372036854776000max_subscriptionsinteger
The maximum amount of subscriptions the server can manage
ping_intervalnumber
The interval the server will send PING messages during periods of inactivity on a connection
ping_maxinteger
The number of unanswered PINGs after which the connection will be considered stale
http_hoststring
The HTTP host monitoring connections are accepted on
http_portinteger
The port monitoring connections are accepted on
http_base_pathstring
The path prefix for access to monitor endpoints
https_portinteger
The HTTPS port monitoring connections are accepted on
auth_timeoutnumber
The amount of seconds connections have to complete authentication
max_control_lineinteger
The amount of bytes a signal control message may be
max_payloadinteger
The maximum amount of bytes a message may have as payload
max_pendinginteger
The maximum amount of unprocessed bytes a connection may have
clusterobject
Monitoring cluster information
gatewayobject
Monitoring gateway information
leafobject
Monitoring leaf node information
mqttobject
Monitoring MQTT information
websocketobject
Monitoring websocket information
jetstreamobject
Basic runtime information about JetStream
tls_timeoutnumber
How long TLS operations have to complete
write_deadlineinteger
The maximum time writes to sockets have to complete
nanoseconds depicting a duration in time, signed 64 bit integer
Minimum:
-9223372036854776000Maximum:
9223372036854776000write_timeoutany
The policy to apply to sockets being closed due to write_deadline
Allowed values:
defaultcloseretrystartstring
Time when the server was started
nowstring
The current time of the server
uptimestring
How long the server has been running
meminteger
The resident memory allocation
coresinteger
The number of cores the process has access to
gomaxprocsinteger
The configured GOMAXPROCS value
gomemlimitinteger
The configured GOMEMLIMIT value
cpunumber
The current total CPU usage
connectionsinteger
The current connected connections
total_connectionsinteger
The total connections the server have ever handled
routesinteger
The number of connected route servers
remotesinteger
The configured route remote endpoints
leafnodesinteger
The number connected leafnode clients
in_msgsinteger
The number of messages this server received
out_msgsinteger
The number of message this server sent
in_bytesinteger
The number of bytes this server received
out_bytesinteger
The number of bytes this server sent
slow_consumersinteger
The total count of clients that were disconnected since start due to being slow consumers
stale_connectionsinteger
The total count of stale connections that were detected
stalled_clientsinteger
The total number of times that clients have been stalled
subscriptionsinteger
The count of active subscriptions
http_req_stats{ [key: string]: integer }
The number of requests each HTTP endpoint received
config_load_timestring
The time the configuration was loaded or reloaded
config_digeststring
A calculated hash of the current configuration
tagsstring[]
The tags assigned to the server in configuration
metadata{ [key: string]: string }
The metadata assigned to the server in configuration
trusted_operators_jwtstring[]
The JWTs for all trusted operators
trusted_operators_claimobject[]
The decoded claims for each trusted operator
system_accountstring
The name of the System account
pinned_account_failsinteger
How often user logon fails due to the issuer account not being pinned
ocsp_peer_cacheobject
OCSP response cache information
slow_consumer_statsobject
Information about slow consumers from different type of connections
stale_connection_statsobject
Information about stale consumers from different type of connections
tls_cert_not_afterstring
The expiration date of the TLS certificate