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.
« SQL query metricset Stan channels metricset »
Elastic Docs ›Metricbeat Reference [8.x] ›Modules

Stan module

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Stan 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 STAN module uses STAN monitoring server APIs to collect metrics.

The default metricsets are channels, stats and subscriptions.

Compatibility

edit

The STAN module is tested with STAN 0.15.1.

Dashboard

edit

Dashboards for topic message count and queue depth are included:

metricbeat stan overview

Example configuration

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.

Metricsets

The following metricsets are available:

« SQL query metricset Stan channels metricset »