﻿---
title: Openmetrics module
description: This module periodically fetches metrics from endpoints following Openmetrics format. In order to filter out/in metrics one can make use of metrics_filters.include...
url: https://www.elastic.co/elastic/docs-builder/docs/2452/reference/beats/metricbeat/metricbeat-module-openmetrics
applies_to:
  - Elastic Stack: Beta in 9.0+
---

# Openmetrics module
<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.
</warning>

This module periodically fetches metrics from endpoints following [Openmetrics](https://openmetrics.io/) format.

## Filtering metrics

In order to filter out/in metrics one can make use of `metrics_filters.include` `metrics_filters.exclude` settings:
```yaml
- 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

The Openmetrics module supports the standard configuration options that are described in [Modules](https://www.elastic.co/elastic/docs-builder/docs/2452/reference/beats/metricbeat/configuration-metricbeat). Here is an example configuration:
```yaml
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](https://www.elastic.co/elastic/docs-builder/docs/2452/reference/beats/metricbeat/configuration-ssl). It also supports the options described in [Standard HTTP config options](/elastic/docs-builder/docs/2452/reference/beats/metricbeat/configuration-metricbeat#module-http-config-options).

## Metricsets

The following metricsets are available:
- [collector](https://www.elastic.co/elastic/docs-builder/docs/2452/reference/beats/metricbeat/metricbeat-metricset-openmetrics-collector)  <applies-to>Elastic Stack: Beta in 9.0+</applies-to>