QueryHub¶
QueryHub はGuanceに組み込まれた、外部データをクエリする機能です。接続を設定すると、外部データソースをサポートするクエリ画面でデータベース、メトリクスサービス、またはドキュメントストア内のデータを読み取り、分析やチャート表示に利用できます。これらのデータを事前にワークスペースへ収集する必要はありません。
QueryHub はネイティブクエリと DQL Like の 2 つのクエリ方式を提供します。いずれも入力欄に手入力し、選択したインスタンスで実際に利用可能なクエリモードに従います。
ネイティブクエリでは、MySQL、PostgreSQL は SQL を入力し、Prometheus、Elasticsearch、MongoDB は完全なクエリ JSON を入力します。DQL Like では完全な QueryHub 式を入力します。DQL Like は QueryHub のクエリ構文であり、ワークスペース内のログやメトリクスをクエリするときに使用する通常の DQL とは異なります。
データソースタイプを選択¶
| タイプ | クエリ対象 | 設定とクエリガイド |
|---|---|---|
| MySQL | データベース内のテーブル | MySQL |
| PostgreSQL | 指定した Schema 内のテーブル | PostgreSQL |
| Prometheus | メトリクスおよびサンプルラベル | Prometheus |
| Elasticsearch | 設定範囲内のインデックスとドキュメント | Elasticsearch |
| MongoDB | 設定されたデータベース、コレクション、ドキュメント | MongoDB |
クエリのアクセス範囲は、選択したデータソースの接続設定、アカウントの読み取り権限、およびワークスペース権限によって決まります。
接続を追加¶
1. 接続方式とデータソースタイプを選択¶
対象のワークスペースに切り替え、インテグレーション > 外部データソース に移動し、データソースを追加 をクリックして、QueryHub 接続方式とデータソースタイプを選択します。
2. 接続属性を入力¶
各タイプとも、まず以下の共通フィールドを入力します。認証フィールドは選択した認証方式に応じて表示されます。具体的な必須条件は対応するデータソースタイプの説明を参照してください。証明書フィールドは TLS の要件に従って入力します。
| 設定項目 | 必須 | 意味と入力方法 |
|---|---|---|
| データソース ID | はい | この接続の識別子を手動で入力します。例: mysql-orders。最大 100 文字です。DQL Like 式の datasource にはこの値を使用します。データベースから取得したアカウントやデータベース名ではありません |
| 名前 | はい | クエリページで接続を識別しやすい名前です。例:「本番注文データベース」。最大 100 文字です |
| 説明 | いいえ | 接続の用途やデータ範囲を補足します。最大 256 文字です |
データソース設定とクエリ例 の対応するタイプに従って、アドレス、データベースまたはリソース範囲、認証情報を入力します。アドレス、アカウント、パスワード、またはトークンは、データソース管理者、運用担当者、またはクラウドサービスの接続情報ページから取得するものであり、Guanceのログインアカウントではありません。
TLS モード、証明書などのフィールドは、共通 TLS 設定 を参照し、サーバー側の要件に従って入力します。
アカウントには対象データの読み取り専用クエリ権限が必要です。接続の設定はGuanceにデータソースへのアクセス方法を伝えるものであり、クエリ文を事前にデータベースへ保存する必要はなく、データベースアカウントの権限を追加することもありません。
3. 接続をテスト¶
接続情報を入力したら、接続をテスト をクリックし、結果に応じて操作を続行します:
| 結果 | 対応方法 |
|---|---|
| 接続成功 | 設定の保存に進みます。有効になった後、実際のクエリで対象データの読み取り権限を検証します |
| アドレス、ネットワーク、またはタイムアウトエラー | アドレスとポートを確認します。必要に応じて運用担当者に連絡し、ネットワーク、ホワイトリスト、サービスの状態を確認します |
| 認証失敗 | データソース管理者にユーザー名、パスワード、認証データベース、またはトークンが正しいか確認します |
| 権限不足 | アカウントに対象のデータベース、テーブル、インデックス、コレクション、またはメトリクスの読み取り権限があるか確認します |
接続テストに成功しても、すべてのオブジェクトをクエリできるわけではありません。接続アドレス、リソース範囲、認証情報を変更した後は、再度テストする必要があります。
4. クエリ設定と権限¶
クエリ設定 はデフォルトで折りたたまれています。展開し、必要に応じてページに表示されるオプションを入力できます。具体的なフィールド、デフォルト値、上限は展開後のページに従います。これらの設定は保存後の実際のクエリに使用され、接続テストのみに使用されるものではありません。
権限 エリアで カスタム操作権限 を設定します:
- オフ: 「外部データソース」のデフォルト権限に従います。
- オン: 展開された権限オプションに従って、この接続の操作権限を設定します。
これらの権限は、ワークスペースメンバーによる接続の操作を制御するものであり、データベースアカウント自体の読み取り権限を変更するものではありません。
5. 保存してクエリを検証¶
ページ下部の保存をクリックし、データソース一覧に戻って設定を確認します。その後、クエリページに移動してこの接続を選択し、読み取り専用クエリを 1 つ実行して利用可能か検証します。
DQL Like を使用する場合、設定時に入力したデータソース IDを式の datasource に記述し、クエリページで選択したインスタンスと一致させます。ID はデータソース一覧または詳細で確認、コピーできます。
クエリを開始¶
- アドホッククエリと分析: メトリクス > メトリクス分析 に移動し、+ データソースを追加 をクリックして、接続とクエリ方式を選択します。クエリを入力した後、右上の更新をクリックします。詳細な手順はメトリクス分析でのクエリを参照してください。
- チャートに保存: ダッシュボードのチャート編集ページに移動し、クエリ領域でデータソースを追加してクエリを設定します。プレビュー結果を確認して保存します。詳細な手順はダッシュボードチャートでのクエリを参照してください。
各タイプのネイティブクエリ、DQL Like、およびソースとフィールドの表示例については、データソース設定とクエリ例 を参照してください。