Troubleshooting
Diagnosing problems in NATS JetStream clusters requires:
knowledge of JetStream concepts
knowledge of the NATS Command Line Interface (CLI)
The following tips and commands (while not an exhaustive list) can be useful when diagnosing problems in NATS JetStream clusters:
Troubleshooting tips
Look at nats-server logs. By default, only warning and error logs are produced, but debug and trace logs can be turned on from the command line using
-D
and-DV
, respectively. Alternatively, enablingdebug
ortrace
in the server config.Make sure that in the NATS JetStream configuration, at least one system user is configured in this section:
{ $SYS { users } }
.
nats account
commands
nats account
commandsCommand | Description |
---|---|
Verify that JetStream is enabled on account |
Basic nats server
commands
nats server
commandsCommand | Description |
---|---|
| List known servers |
| Ping all servers |
| Show information about a single server |
Health check for NATS servers |
nats server report
commands
nats server report
commandsCommand | Description |
---|---|
| Report on connections |
| Report on account activity |
Report on JetStream activity |
nats server request
commands
nats server request
commandsCommand | Description |
---|---|
Show JetStream details | |
| Show subscription information |
| Show runtime variables |
| Show connection details |
| Show route details |
| Show gateway details |
| Show leafnode details |
| Show account details |
nats server cluster
commands
nats server cluster
commandsCommand | Description |
---|---|
Force a new leader election by standing down the current meta leader | |
Removes a server from a JetStream cluster |
Experimental commands
Command | Description |
---|---|
Monitor NATS traffic. (Experimental command) |
Further troubleshooting references
Last updated