NATS moduleedit

The Nats module uses Nats monitoring server APIs to collect metrics.

The default metricsets are stats, connections, routes and subscriptions while connection and route metricsets can be enabled to collect detailed metrics per connection/route.


The Nats module is tested with Nats 1.3.0, 2.0.4 and 2.1.4


The Nats module comes with a predefined dashboard. For example:

metricbeat nats dashboard

Example configuration

The NATS module supports the standard configuration options that are described in Modules. Here is an example configuration:

- module: nats
    - "connections"
    - "routes"
    - "stats"
    - "subscriptions"
    #- "connection"
    #- "route"
  period: 10s
  hosts: ["localhost:8222"]
  #stats.metrics_path: "/varz"
  #connections.metrics_path: "/connz"
  #routes.metrics_path: "/routez"
  #subscriptions.metrics_path: "/subsz"
  #connection.metrics_path: "/connz"
  #route.metrics_path: "/routez"

This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.


The following metricsets are available: