> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cockroachlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Monitor CockroachDB with DBmarlin

[DBmarlin](https://www.dbmarlin.com/home) is a monitoring platform for databases. The CockroachDB integration with DBmarlin enables DBmarlin to view CockroachDB metrics stored in the [`crdb_internal` system catalog](/docs/stable/monitoring-and-alerting#crdb_internal-system-catalog).

In this tutorial, you will enable the CockroachDB integration in DBmarlin, run a workload on CockroachDB, and visualize data.

For more information about the integration, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/dbmarlin-cockroachdb).

> [!TIP]
>
> For more information about using DBmarlin, see the [DBmarlin documentation](https://docs.dbmarlin.com/).

## Before you begin

You must have the following set up before proceeding with this tutorial:

* [DBmarlin installation on a supported platform](https://docs.dbmarlin.com/docs/Getting-Started/supported-platforms#supported-installation-platforms)
* [Supported version of CockroachDB](https://docs.dbmarlin.com/docs/Getting-Started/supported-platforms#supported-database-platforms)

## Step 1. Connect DBmarlin to CockroachDB

Follow the steps in [CockroachDB](https://docs.dbmarlin.com/docs/Monitored-Technologies/Databases/cockroachdb).

## Step 2. Run a sample workload

To test the dashboard functionality, use [`cockroach workload`](/docs/stable/cockroach-workload) to run a sample workload on the cluster.

Initialize the workload for MovR, a fictional vehicle-sharing company:

```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
cockroach workload init movr  "postgresql://<username:<password@<host-address:26257/movr?sslmode=verify-full&sslrootcert=$HOME/.postgresql/root.crt&options=--cluster%<cluster-id"
```

Run the MovR workload for 5 minutes:

```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
cockroach workload run movr --duration=5m <username>:<password@<host-address:26257/movr?sslmode=verify-full&sslrootcert=$HOME/.postgresql/root.crt&options=--cluster%<cluster-id"
```

## Step 3. View database behavior in DBmarlin

Follow the steps in [Instance Dashboard](https://docs.dbmarlin.com/docs/Using-DBmarlin/instance-dashboard).

When you open the dashboard you'll see:

![CockroachDB Overview dashboard for DBmarlin](https://mintcdn.com/cockroachlabs/Vnu3Mn2DzHS7Vfry/images/common/dbmarlin-crdb-dashboard.png?fit=max\&auto=format\&n=Vnu3Mn2DzHS7Vfry\&q=85\&s=3d6a9a0325cd2797f48a8efab6142bd1)

## See also

* [Monitoring and Alerting](/docs/stable/monitoring-and-alerting.md)
* [DB Console Overview](/docs/stable/ui-overview.md)
* [Logging Overview](/docs/stable/logging-overview.md)