メインコンテンツまでスキップ
メインコンテンツまでスキップ

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

ClickHouse Supported

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

1. 接続情報を収集する​

To connect to ClickHouse with native TCP you need this information:

  • The HOST and PORT: typically, the port is 9440 when using TLS, or 9000 when not using TLS.

  • The DATABASE NAME: out of the box there is a database named default, use the name of the database that you want to connect to.

  • The USERNAME and PASSWORD: out of the box the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click Connect:

ClickHouse Cloud service connect button

Choose Native, and the details are available in an example clickhouse-client command.

ClickHouse Cloud Native TCP connection details

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

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

ClickHouseをGrafanaなどのデータ可視化ツールに接続する際は、データを不正な変更から保護するために読み取り専用ユーザーを作成することをお勧めします。

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

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

  1. ClickHouseでのユーザーおよびロールの作成 ガイドに従って、readonlyユーザープロファイルを作成します。
  2. readonlyユーザーが、基盤となるclickhouse-goクライアントに必要な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によって署名されたプラグインをクリックします：

    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. 次のステップ​

データソースはすぐに使用できる状態になりました！クエリビルダーを使用してクエリを作成する方法について詳しく学んでください。

設定に関する詳細は、プラグイン設定 ドキュメントを確認してください。

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

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

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

v3からの設定とクエリは、開かれた時にv4にマイグレーションされます。古い設定やダッシュボードはv4で読み込まれますが、マイグレーションは新しいバージョンで再保存されるまで持続されません。古い設定やクエリを開く際に何らかの問題が発生した場合は、変更を破棄し、GitHubで問題を報告してください。

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