graphite-clickhouse

支持 ClickHouse 的 Graphite 集群后端。「Graphite cluster backend with ClickHouse support」

Github星跟踪图

deb
rpm

graphite-clickhouse

Graphite cluster backend with ClickHouse support

Work scheme

stack.png

Gray components are optional or alternative

TL;DR

Preconfigured docker-compose

Docker

Docker images are available on packages page.

Compatibility

Build

Required golang 1.18+

# build binary
git clone https://github.com/lomik/graphite-clickhouse.git
cd graphite-clickhouse
make

Installation

  1. Setup Yandex ClickHouse and carbon-clickhouse
  2. Setup and configure graphite-clickhouse
  3. Add graphite-clickhouse host:port to graphite-web CLUSTER_SERVERS

Configuration

See configuration documentation.

Special headers processing

Some HTTP headers are processed specially by the service

Request headers

Grafana headers: X-Dashboard-Id, X-Grafana-Org-Id, and X-Panel-Id are logged and passed further to the ClickHouse.

Debug headers (see debugging.md for details):

  • X-Gch-Debug-External-Data - when this header is set to anything and every of directory, directory-perm, and external-data-perm parameters in [debug] is set and valid, service will save the dump of external data tables in the directory for debug output.
  • X-Gch-Debug-Output - header to enable special processing for format=carbonapi_v3_pb and format=json render output.
  • X-Gch-Debug-Protobuf - header enables the original marshallers for protobuf and carbonapi_v3_pb to check the binary data integrity.

Response headers

  • X-Gch-Request-Id - the current request ID.
  • X-Cached-Find - Flag for find cache hit.

Run on same host with old graphite-web 0.9.x

By default graphite-web won't connect to CLUSTER_SERVER on localhost. Cheat:

class ForceLocal(str):
    def split(self, *args, **kwargs):
        return ["8.8.8.8", "8080"]

CLUSTER_SERVERS = [ForceLocal("127.0.0.1:9090")]

主要指标

概览
名称与所有者go-graphite/graphite-clickhouse
主编程语言Go
编程语言Go (语言数: 5)
平台
许可证MIT License
所有者活动
创建于2016-11-11 19:21:46
推送于2025-06-05 09:02:27
最后一次提交2025-06-05 14:02:27
发布数32
最新版本名称v0.14.0 (发布于 )
第一版名称v0.1 (发布于 2016-11-23 01:35:33)
用户参与
星数215
关注者数16
派生数53
提交数0.9k
已启用问题?
问题数97
打开的问题数17
拉请求数188
打开的拉请求数9
关闭的拉请求数22
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?