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

:modulename: cockroachdb

[[metricbeat-module-cockroachdb]]
[role="xpack"]
== CockroachDB module

beta[]

This module periodically fetches metrics from CockroachDB.

[float]
=== Compatibility

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


[float]
=== Dashboard

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

image::./images/metricbeat-cockroachdb-overview.png[]


[float]
=== Example configuration

The CockroachDB module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,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 <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-cockroachdb-status,status>>

include::cockroachdb/status.asciidoc[]

