CockroachDB moduleedit

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 CockroachDB.

Compatibilityedit

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

Dashboardedit

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

./images/metricbeat-cockroachdb-overview.png

Example configurationedit

The CockroachDB module supports the standard configuration options that are described in Specify which modules to run. Here is an example configuration:

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 Specify SSL settings. It also supports the options described in Standard HTTP config options.

Metricsetsedit

The following metricsets are available: