メインコンテンツへスキップ
メインコンテンツへスキップ

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

ClickHouse Supported

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

1. 接続情報を準備する​

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

Parameter(s)Description
HOST and PORT通常、TLS を使用する場合はポート 9440、TLS を使用しない場合は 9000 です。
DATABASE NAMEデフォルトで default という名前のデータベースが用意されています。接続したいデータベース名を指定します。
USERNAME and PASSWORDデフォルトのユーザー名は default です。ユースケースに適したユーザー名を使用してください。

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

ClickHouse Cloud サービスの接続ボタン

Native を選択すると、例として表示される clickhouse-client コマンド内に詳細が示されます。

ClickHouse Cloud ネイティブ TCP 接続の詳細

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

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

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

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 の constraint type を changeable_in_readonly に設定します。

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

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

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

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

    Connections ページで ClickHouse プラグインを選択する

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

    ClickHouse プラグインをインストールする

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

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

    ClickHouse データソースを作成する

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

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

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

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

    Save & test を選択する

5. 次のステップ​

これでデータソースを利用する準備が整いました。クエリの構築方法については、query builder の使い方を参照してください。

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

これらのドキュメントに含まれていない情報をお探しの場合は、GitHub 上の プラグイン リポジトリ を参照してください。

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

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

v3 の設定とクエリは、開いたタイミングで v4 に自動的に移行されます。古い設定とダッシュボードは v4 で読み込まれますが、新しいバージョンで再度保存されるまで、その移行内容は永続的には反映されません。既存の設定やクエリを開いた際に問題が発生した場合は、変更を破棄し、GitHub で問題を報告してください。

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