docs/reference/metricbeat/metricbeat-module-nats.md
% This file is generated! See metricbeat/scripts/mage/docs_collector.go
:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.
::::{dropdown} Learn more {{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 {{agent}}.
::::
:::::
The Nats module uses Nats monitoring server APIs to collect metrics.
The default metricsets are stats, connections, routes and subscriptions. The connection, route, and jetstream metricsets can be enabled to collect additional metrics.
The NATS module is tested with NATS 2.2.6 and 2.11.x. Versions in between are expected to be compatible as well.
The Nats module comes with a predefined dashboard. For example:
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"
#- "jetstream"
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"
#jetstream:
# stats:
# enabled: true
# account:
# enabled: true
# names:
# - default
# stream:
# enabled: true
# names:
# - my-stream-1
# - another-stream
# consumer:
# enabled: true
# names:
# - my-stream-1-consumer-1
# - my-stream-1-consumer-2
# - another-stream-consumer-1
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:
stack: beta 9.1.0