Stan moduleedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

This is the STAN module. The STAN module uses STAN monitoring server APIs to collect metrics.

The default metricsets are channels, stats and subscriptions.


The STAN module is tested with STAN 0.15.1.


Dashboards for topic message count and queue depth are included:

metricbeat stan overview

Example configurationedit

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

- module: stan
  metricsets: ["stats", "channels", "subscriptions"]
  period: 60s
  hosts: ["localhost:8222"]
  #stats.metrics_path: "/streaming/serverz"
  #channels.metrics_path: "/streaming/channelsz"
  #subscriptions.metrics_path: "/streaming/channelsz" # we retrieve streaming subscriptions with a detailed query param to the channelsz endpoint


The following metricsets are available: