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

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

ClickHouse Supported

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

1. 接続情報を集める​

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

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

  • DATABASE NAME: デフォルトでは default というデータベースがあり、接続したいデータベースの名前を使用します。

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

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

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

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

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

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

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

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

  1. 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 データソースを選択すると、次のページが表示されます：

  1. サーバーの設定と資格情報を入力します。主な設定は以下の通りです：
  • Server host address: ClickHouse サービスのホスト名。
  • Server port: ClickHouse サービスのポート。サーバー設定やプロトコルによって異なる場合があります。
  • Protocol：ClickHouse サービスに接続するために使用されるプロトコル。
  • Secure connection：サーバーが安全な接続を要求する場合は有効にします。
  • Username および Password：ClickHouse のユーザー資格情報を入力します。ユーザーを設定していない場合は、ユーザー名に default を試してください。 読み取り専用ユーザーを構成することをお勧めします。

他の設定については plugin configuration ドキュメントを確認してください。

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

5. 次のステップ​

データソースの準備が整いました！クエリビルダー を使ってクエリを構築する方法についてもっと学びましょう。

設定の詳細については、plugin configuration ドキュメントを確認してください。

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

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

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

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

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

関連コンテンツ​