Enabling Monitoring
Last updated
Was this helpful?
Last updated
Was this helpful?
To monitor the NATS messaging system, nats-server provides a lightweight HTTP server on a dedicated monitoring port. The monitoring server provides several endpoints, providing statistics and other information.
The support and , making it easy to create single page monitoring web applications.
Warning:
nats-serverdoes not have authentication/authorization for the monitoring endpoint. When you plan to open yournats-serverto the internet make sure to not expose the monitoring port as well. By default monitoring binds to every interface0.0.0.0so consider setting monitoring tolocalhostor have appropriate firewall rules.
To enable the monitoring server, start the NATS server with the monitoring flag -m and the monitoring port, or turn it on in the .
Example:
To test, run nats-server -m 8222, then go to
You can also enable monitoring using the configuration file as follows:
Binding to localhost as well:
For example, to monitor this server locally, the endpoint would be . It reports various general statistics.
In addition to writing custom monitoring tools, you can monitor nats-server in Prometheus. The allows you to configure the metrics you want to observe and store in Prometheus. There's a sample dashboard that you can use to visualize the server metrics.