IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Beat stats metricset Benchmark info metricset »
Elastic Docs ›Metricbeat Reference [8.18] ›Modules

Benchmark module

edit
A newer version is available. Check out the latest documentation.

Benchmark module

edit

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.

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 benchmark module is used to generate synthetic metrics at a predictable rate. This can be useful when you want to test output settings or test system sizing without using real data.

The benchmark module metricset is info.

- module: benchmark
  metricsets:
    - info
  enabled: true
  period: 10s

Metricsets

edit

info

edit

A metric that includes a counter field which is used to keep the metric unique.

Module-specific configuration notes

edit
count
number, the number of metrics to emit per fetch.

Example configuration

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

metricbeat.modules:
- module: benchmark
  metricsets:
    - info
  enabled: false
  period: 10s

Metricsets

The following metricsets are available:

« Beat stats metricset Benchmark info metricset »