This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« MySQL status metricset NATS connection metricset »
Elastic Docs ›Metricbeat Reference [master] ›Modules

NATS module

edit

NATS module

edit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

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.

Compatibility

edit

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

Dashboard

edit

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:

metricbeat.modules:
- module: nats
  metricsets:
    - "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.

Metricsets

The following metricsets are available:

« MySQL status metricset NATS connection metricset »