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

CockroachDB module [metricbeat-module-cockroachdb]

:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.

::::{dropdown} Learn more {{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 {{agent}}.

::::

:::::

This module periodically fetches metrics from CockroachDB.

Compatibility [_compatibility_10]

The CockroachDB status metricset is compatible with any CockroachDB version exposing metrics in Prometheus format.

Dashboard [_dashboard_21]

The CockroachDB module includes a predefined dashboard with overview information of the monitored servers.

Example configuration [_example_configuration]

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

yaml

metricbeat.modules:
- module: cockroachdb
  metricsets: ['status']
  period: 10s
  hosts: ['localhost:8080']

  # This module uses the Prometheus collector metricset, all
  # the options for this metricset are also available here.
  #metrics_path: /_status/vars

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:

status