{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/79", "result": {"data":{"issuesJson":{"id":"b1303fef-cfaa-5aa3-8904-7157cf5b8386","title":"TongchengOpenSource/ckibana: CKibana是一款可以在原生kibana查询Clickhouse的服务","number":79,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ReposTongchengOpenSource/ckibana
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

\"CKibana
\n\"CKibana

\n

\"License\"
\n\"Release\"

\n

ClickHouse adapter for Kibana

\n

ClickHouse proxy for Kibana

\n

Clickhouse visualization tool

\n

English | 简体中文

\n
\n\n

Introduce

\n

CKibana is a service for convenient analysis of ClickHouse data using native Kibana.

\n

A typical use case is when nginx log storage is migrated from ElasticSearch to ClickHouse,users can seamlessly continue their log query and analysis with Kibana.

\n

It is recommended to use version 6.x of Kibana. This version is used internally and has been more thoroughly tested.

\n

\"tlb.gif\"

\n

Features

\n\n

Supported Aggregation Syntax:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ES SyntaxNote
terms
sum
min
max
avg
percentile_ranks
percentiles
filtersCurrently, only the first level of aggregation is supported.
filter item
cardinality
\n

UnSupported Syntax:

\n

Kibana Query Language(KQL) is not supported, it is recommended to use the lucene instead。

\n

\"img_1.png\"

\n

Get started

\n

quick start

\n

To quickly experience Kibana, you can deploy it quickly using docker-compose.

\n

ckibana-quick-start-doc

\n
# Enter the docker-compose directory.\ncd ckibana/docker-compose\n# Deploy\ndocker-compose up -d
\n

After deployment is complete, access Kibana in a browser at： http://127.0.0.1:5601/

\n

A process with built-in mock data has been included. After importing the Kibana configuration file (dashboard, index-pattern, etc.), you can start experiencing it!

\n

Configuration file path：docker-compose/quickstart-export.json
\n\"\"
\nEffect display：
\n\"\"

\n

Local run CKibana

\n

CKibana can be run on all major operating systems and requires Java JDK version 17 or higher to be installed. To check, please run:java -version:

\n
$ java -version\njava version \"17.0.5\"
\n

The proxy service depends on the ES, CK, and Kibana services, which need to be prepared in advance. The following steps only include querying data from CK and do not include writing data to CK.

\n

1）Create a database and a table

\n

To initialize database and table structures in ClickHouse, please refer to:api-docs Detailed explanation of creating a table

\n

2）Start CKibana

\n

To modify the ES configuration in CKibana, you need to change it to your own ES information. The configuration file path is src/main/resources/application.yml

\n
metadata-config:\n  hosts: your es metadata cluster hosts\n  headers:\n    headerKey: yourHeaderValue
\n

Package and run or run locally directly com.ly.ckibana.Bootstrap

\n
### start ckibana\n$ nohup java -jar ckibana.jar > run.out 2>&1 &\n\n### check whether ckibana is successfully started\n$ tail -f ~/logs/app.log\nTomcat started on port(s): 8080 (http) with context path ''\nStarted Bootstrap in 1.474 seconds
\n

3）start kibana

\n

Configure the elasticsearchHosts parameter in Kibana to the CKibana proxy address, so that it can be routed to the proxy service.

\n
eg：elasticsearchHosts=http://ip:port
\n

4）Configure the index pattern whitelist

\n

Only after configuring the corresponding whitelist can you proceed to create it in the next step index pattern，The configured whitelist needs to be consistent with the table name，please refer to:api-docs Update the whitelist index interface

\n

5）Create index pattern in Kibana

\n
eg：If the CK table name is `table_test`, then create an index pattern `table_test`
\n

After completing the above 5 steps, you can create a dashboard and start using it.

\n

TODO

\n\n

Documentation

\n

CKibana-docs

\n

Contributors

\n

\n

Join us

\n

The group supports both Enterprise WeChat and personal WeChat accounts
\n\"\"

\n

HelloGithub计划

\n

\"Featured｜HelloGitHub\"

\n

License

\n

Apache License, Version 2.0 Copyright (C) Apache Software Foundation

","updatedAt":"2025-05-21T15:52:04Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"ClickHouse","color":"480668"}},{"node":{"name":"TongchengOpenSource","color":"152501"}}]},"comments":{"edges":[]}}},"pageContext":{"number":79,"previous":{"title":"RubyMetric/chsrc: 一款用 C 语言编写的各语言换源的工具","number":78},"next":{"title":"clickvisual/clickvisual: 一个轻量级的基于浏览器的日志分析和查询平台，底层数据存储采用 ClickHouse","number":80}}}, "staticQueryHashes": ["151096407","2861350382"]}