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

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

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

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

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

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

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

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

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

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

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

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

   

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

   

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 というメッセージが表示されます。

   

これでデータソースを使用する準備が整いました。クエリビルダー を使ったクエリ作成方法の詳細を確認してください。

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

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