関連ビュー設定の説明¶
telemetry は、エンティティ詳細ページにおける関連ビュー(ログ、イベント、トレース、ダッシュボードなど)を設定するために使用します。各設定項目は、表示可能なビューカードを表します。
基本構造¶
telemetry:
- name: "エラーログ"
type: explorer
viewName: logs
query: "service='{{metadata.service}}'"
- name: "メトリクス"
type: dashboard
timerange: "30m"
viewName: "サービス概要"
説明:
name、viewNameを国際化対応する場合は、zh-CN、en-USに分割できます。- 国際化が不要な場合は、文字列をそのまま記述してください。
フィールド説明¶
name¶
詳細ページに表示されるビュー名です。
例:
type¶
関連ビューのタイプです。現在、以下の2種類をサポートしています。
dashboard:ダッシュボードexplorer:エクスプローラー
explorer タイプの設定¶
explorer は、ログ、イベント、トレース、コンテナ、Pod などのエクスプローラーを関連付けるために使用します。
viewName¶
エクスプローラーのタイプです。現在サポートしているものは以下のとおりです。
logs:ログエクスプローラーevent:イベントエクスプローラーtrace:トレースエクスプローラーcontainer:コンテナエクスプローラーpod:Pod エクスプローラー
query¶
フィルタ条件です。DQL クエリ構文を使用します。
変数を使用して現在のエンティティの属性を参照できます。
例:
より複雑な条件を記述することもできます。
explorer の例¶
- name: "エラーログ"
type: explorer
viewName: logs
query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"
- name: "トレース"
type: explorer
viewName: trace
query: "service='{{metadata.service}}'"
- name: "イベント"
type: explorer
viewName: event
query: "service='{{metadata.service}}'"
dashboard タイプの設定¶
dashboard は、詳細ページにダッシュボードを表示するために使用します。
timerange¶
ダッシュボードのクエリ時間範囲です。例:
keys¶
特定のエンティティ条件を満たす場合にのみ、そのダッシュボードを表示します。
例:
これは、現在のエンティティの database_type が MySQL の場合にのみ、そのダッシュボードを表示することを意味します。
viewName¶
ダッシュボード名です。
- 組み込みビュー内のダッシュボード名を指定する必要があります。
- 名前はシステムの組み込みダッシュボードと一致している必要があります。一致しない場合、正しく開けません。
dashboard の例¶
- name: "メトリクス"
type: dashboard
timerange: "30m"
viewName: "サービス概要"
- name: "メトリクス"
type: dashboard
keys: { database_type: "MySQL" }
timerange: "1h"
viewName: "インフラストラクチャ MySQL 監視ビュー"
- name: "メトリクス"
type: dashboard
keys: { database_type: "Oracle" }
timerange: "1h"
viewName: "インフラストラクチャ Oracle 監視ビュー"
完全な例¶
telemetry:
- name: "エラーログ"
type: explorer
viewName: logs
query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"
- name: "トレース"
type: explorer
viewName: trace
query: "service='{{metadata.service}}'"
- name: "イベント"
type: explorer
viewName: event
query: "service='{{metadata.service}}'"
- name: "メトリクス"
type: dashboard
timerange: "30m"
viewName: "サービス概要"
- name: "メトリクス"
type: dashboard
keys: { database_type: "MySQL" }
timerange: "1h"
viewName: "インフラストラクチャ MySQL 監視ビュー"
- name: "メトリクス"
type: dashboard
keys: { database_type: "Oracle" }
timerange: "1h"
viewName: "インフラストラクチャ Oracle 監視ビュー"
設定の推奨事項¶
- 国際化対応が必要な場合、
nameとviewNameにはzh-CN、en-USを使用できます。 explorer.queryで参照する{{metadata.field}}は、エンティティに実際に存在する属性である必要があります。dashboard.viewNameは、システムに組み込まれたダッシュボードを指す必要があります。keysは、エンティティの属性値に応じて異なるダッシュボードを表示する場合に適しています。- 1つのエンティティに複数の関連ビューを設定できます。
telemetryの下に直接追加してください。