IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Metricbeat Reference [8.2] ›Modules
« SQL query metricset Stan channels metricset »

Stan moduleedit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified agent that you can deploy to hosts or containers to collect data and send it to the Elastic Stack. Elastic Agent uses integrations to connect your data to the Elastic Stack. Behind the scenes, Elastic Agent runs the Beats shippers required for your configuration. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

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

The default metricsets are channels, stats and subscriptions.

Compatibilityedit

The STAN module is tested with STAN 0.15.1.

Dashboardedit

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:

metricbeat.modules:
- 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

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.

Metricsetsedit

The following metricsets are available:

« SQL query metricset Stan channels metricset »