Grafana用ClickHouseデータソースプラグイン

GrafanaでClickHouseを使用するための入門

Grafana を使用すると、ダッシュボードを通じてすべてのデータを探索し、共有できます。 Grafana を ClickHouse に接続するにはプラグインが必要ですが、UI から簡単にインストールできます。

​

1. 接続情報を確認する

ClickHouse にネイティブ TCP で接続するには、次の情報が必要です。

Parameters	説明
HOST and PORT	通常、TLS を使用する場合のポートは 9440、TLS を使用しない場合は 9000 です。
DATABASE NAME	初期状態では default という名前のデータベースがあります。接続先のデータベース名を使用してください。
USERNAME and PASSWORD	初期状態のユーザー名は default です。用途に応じたユーザー名を使用してください。

ClickHouse Cloud サービスの接続情報は、ClickHouse Cloud コンソールで確認できます。 接続先のサービスを選択し、Connect をクリックします。

Native を選択すると、接続情報が clickhouse-client コマンドの例として表示されます。

セルフマネージド ClickHouse を使用している場合、接続情報は ClickHouse 管理者が設定します。

​

2. 読み取り専用ユーザーの作成

ClickHouse を Grafana のようなデータ可視化ツールに接続する場合は、意図しない変更からデータを保護するため、読み取り専用ユーザーを作成することを推奨します。

Grafana はクエリが安全かどうかを検証しません。クエリには、DELETE や INSERT を含む任意の SQL ステートメントを含めることができます。

読み取り専用ユーザーを設定するには、次の手順に従ってください。

1. Creating Users and Roles in ClickHouse ガイドに従って、readonly ユーザープロファイルを作成します。
2. readonly ユーザーに、基盤となる clickhouse-go client が必要とする max_execution_time 設定を変更できる十分な権限があることを確認します。
3. 公開された ClickHouse インスタンスを使用している場合、readonly プロファイルで readonly=2 を設定することは推奨されません。代わりに readonly=1 のままにし、この設定の変更を許可するため、max_execution_time の制約タイプを changeable_in_readonly に設定してください。

​

3. Grafana 用の ClickHouse プラグインをインストールする

Grafana から ClickHouse に接続するには、適切な Grafana プラグインをインストールする必要があります。Grafana にログインしていることを前提に、以下の手順に従ってください。

1. サイドバーの Connections ページから、Add new connection タブを選択します。

2. ClickHouse を検索し、Grafana Labs 提供の署名済みプラグインをクリックします。

3. 次の画面で、Install ボタンをクリックします。

​

4. ClickHouseデータソースを定義する

1. インストールが完了したら、Add new data source ボタンをクリックします。 (Connections ページの Data sources タブからデータソースを追加することもできます。)

2. 下にスクロールして ClickHouse データソースタイプを探すか、Add data source ページの検索バーで検索します。ClickHouse データソースを選択すると、次のページが表示されます。

3. サーバー設定と認証情報を入力します。主な設定は次のとおりです。

• Server host address: ClickHouseサービスのホスト名。
• Server port: ClickHouseサービスのポート。サーバー設定とプロトコルによって異なります。
• Protocol ClickHouseサービスへの接続に使用するプロトコル。
• Secure connection サーバーでセキュアな接続が必要な場合に有効にします。
• Username と Password: ClickHouse のユーザー認証情報を入力します。ユーザーを設定していない場合は、ユーザー名に default を試してください。読み取り専用ユーザーを設定することを推奨します。

その他の設定については、プラグイン設定 のドキュメントを参照してください。

4. Save & test ボタンをクリックして、Grafana が ClickHouseサービスに接続できることを確認します。成功すると、Data source is working というメッセージが表示されます。

​

5. 次のステップ

これでデータソースを使用できます。クエリビルダーを使ったクエリの作成方法について詳しくは、こちらをご覧ください。

設定の詳細については、プラグイン設定のドキュメントを参照してください。

このドキュメントに記載されていない情報をお探しの場合は、GitHub 上のプラグインリポジトリをご確認ください。

​

プラグインバージョンのアップグレード

v4 以降では、新しいバージョンがリリースされるたびに、設定とクエリをアップグレードできるようになりました。

v3 の設定とクエリは、開くと v4 に移行されます。古い設定やダッシュボードも v4 で読み込まれますが、新しいバージョンで再保存するまで、その移行内容は保持されません。古い設定やクエリを開いた際に問題が見つかった場合は、変更を破棄して、GitHub で issue を報告してください。

設定やクエリを新しいバージョンで作成した場合、プラグインを以前のバージョンにダウングレードすることはできません。