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

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

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

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

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

  • HOSTとPORT：通常、TLSを使用する場合はポートが9440、TLSを使用しない場合は9000です。

  • DATABASE NAME：デフォルトではdefaultというデータベースが存在します。接続したいデータベースの名前を使用してください。

  • USERNAMEとPASSWORD：デフォルトではユーザー名がdefaultです。使用ケースに応じたユーザー名を使用してください。

ClickHouse Cloudサービスの詳細は、ClickHouse Cloudコンソールで確認できます。接続するサービスを選択し、Connectをクリックしてください：

ClickHouse Cloudサービス接続ボタン

Nativeを選択すると、例のclickhouse-clientコマンドで詳細が確認できます。

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

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

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. ClickHouseプラグインをGrafanaにインストールする​

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

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

  2. ClickHouseを検索し、Grafana Labsによって署名されたプラグインをクリックします：

    接続ページで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で問題を報告してください。

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

関連コンテンツ​