% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Openmetrics module [metricbeat-module-openmetrics]

::::{warning} 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 module periodically fetches metrics from endpoints following Openmetrics format.

Filtering metrics [_filtering_metrics]

In order to filter out/in metrics one can make use of metrics_filters.include metrics_filters.exclude settings:

- module: openmetrics
  metricsets: ['collector']
  period: 10s
  hosts: ["localhost:9090"]
  metrics_path: /metrics
  metrics_filters:
    include: ["node_filesystem_*"]
    exclude: ["node_filesystem_device_*", "^node_filesystem_readonly$"]

The configuration above will include only metrics that match node_filesystem_* pattern and do not match node_filesystem_device_* and are not node_filesystem_readonly metric.

Example configuration [_example_configuration]

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

metricbeat.modules:
- module: openmetrics
  metricsets: ['collector']
  period: 10s
  hosts: ['localhost:9090']

  # This module uses the Prometheus collector metricset, all
  # the options for this metricset are also available here.
  metrics_path: /metrics
  metrics_filters:
    include: []
    exclude: []

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 [_metricsets]

The following metricsets are available:

• collector {applies_to}stack: beta