# clickhouse-mixin

**Repository Path**: mirrors_ClickHouse/clickhouse-mixin

## Basic Information

- **Project Name**: clickhouse-mixin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-13
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ClickHouse Cloud Prometheus/Grafana mix-in

Pre-configured Grafana dashboard for monitoring ClickHouse Cloud services via the ClickHouse Cloud
[Prometheus API endpoint](https://clickhouse.com/docs/integrations/prometheus).

It also supports
[native ClickHouse Prometheus exporter](https://clickhouse.com/docs/operations/server-configuration-parameters/settings#prometheus).

## Links
- Dashboard in [Grafana dashboards marketplace](https://grafana.com/grafana/dashboards/23415-prom-exporter-instance-dashboard-v2/)
- Getting started guide in our [blog post](https://clickhouse.com/blog/monitor-with-new-prometheus-grafana-mix-in)

## BYOC Dashboard

The BYOC (Bring Your Own Cloud) dashboard is automatically generated from `dashboard.json` via GitHub Actions whenever changes are pushed to either `dashboard.json` or the converter script.

The CI workflow will:
- Convert `dashboard.json` to `dashboard_byoc.json`
- Automatically commit and push the generated file back to the repository
- Upload the generated dashboard as a workflow artifact for download

To manually generate the BYOC dashboard locally, run:

```shell
python3 .github/scripts/convert.py dashboard.json dashboard_byoc.json
```