コンテンツにスキップ

エンティティタイプ管理


本ドキュメントでは、エンティティタイプをカスタマイズして統合カタログのアセット管理機能を拡張する方法について説明します。

統合カタログ > エンティティ一覧に移動し、左側のサイドバーにある「設定」アイコンをクリックして「エンティティタイプ管理」を選択すると、エンティティタイプ管理ページにアクセスできます。


エンティティタイプを作成

  1. エンティティタイプ管理ページの右上にある「エンティティタイプを作成」をクリックします。
  2. 基本情報を入力します。

    • エンティティタイプ:グローバルに一意な識別子。例:kubernetes_deployment
    • 表示名:エンティティタイプの表示名を入力します。
    • 説明:必要に応じて、このタイプの用途を補足説明します。
  3. 「詳細設定(オプション)」領域を展開し、YAML を使用して Data Schema、表示列、関連ビューをカスタマイズします。

  4. 「保存」をクリックして作成を完了します。
注意
  • エンティティタイプの識別子は重複できません。すでに存在する場合は、システムがエラーを表示します。
  • タイプを削除する前に、そのタイプに関連するエンティティがないことを確認してください。関連エンティティがある場合は削除できません。

詳細設定(オプション)

エンティティタイプを作成または編集する際、基本情報の下に「詳細設定(オプション)」領域が表示されます。システムはデフォルトテンプレートに基づいて以下の設定を生成します。デフォルト設定をそのまま使用することも、必要に応じて YAML を編集することもできます。

データ Schema 設定

エンティティタイプのフィールド、ソース、必須項目、検証ルールなどを定義します。デフォルトでは、システムのデフォルト DataSchema テンプレートに基づいて YAML プレビューが生成されます。

  • 公式エンティティタイプ:dataschema.yaml をベースとし、custom_properties の追加をサポートします。
  • カスタムエンティティタイプ:統合カタログのデフォルトテンプレートをベースとし、カスタムフィールド、ソース、必須項目、列挙値、デフォルト値、検証ルールをサポートします。

詳しくはデータ Schema 設定ガイドを参照してください。

デフォルト表示列設定

エンティティ一覧の固定列、デフォルト列、オプション列を設定するために使用します。

設定ルール:

  • field:フィールド名
  • fixed:固定表示列かどうか。デフォルトは false。固定列は常に表示され、表示列の有効/無効リストには表示されません。
  • hidden:デフォルトで非表示にするかどうか。デフォルトは falsefalse はデフォルトで表示、true はデフォルトで非表示(ただし、表示列設定で有効にできます)を意味します。
  • nameentity_type のような簡略表記は、field: namefield: entity_type と同等であり、デフォルトで表示されます。
  • ユーザー個人の列設定は、タイプのデフォルト設定よりも優先されます。

詳しくはデフォルト表示列設定ガイドを参照してください。

エンティティ詳細ページの関連ビューを設定します。

  • 公式設定の場合、YAML を使用して組み込みの関連ビューを有効または無効にできます。
  • YAML を使用してカスタム関連ビューを追加できます。
  • ログ関連ビューにデフォルトインデックスを設定する必要がある場合は、YAML の index フィールドを使用して設定します。複数のインデックスは配列形式で指定します。

設定例:

telemetry:
  - name: { zh-CN: "错误日志", en-US: "Error Logs" }
    type: explorer
    viewName: logs
    index: ["app-prod", "gateway-prod"]
    query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

詳しくは関連ビュー設定ガイドを参照してください。


エンティティタイプ一覧

エンティティタイプ一覧ページには、現在のワークスペース内のすべてのエンティティタイプ(システムプリセット、公式組み込み、カスタムタイプ)が表示されます。一覧には、各タイプの表示名、エンティティタイプ識別子、説明、エンティティ数、分類ラベルが表示されます。

タイプ分類

分類 含まれるタイプ
システムプリセット system(システム)
公式組み込み サービス、ホスト、データベース、キュー、K8s Service、Deployment など
カスタム ユーザーが作成したタイプ(K8s リソース、ビジネスドメインなど)
権限制限
  • system タイプは編集とヘルスステータス設定をサポートし、デフォルトアルゴリズムを提供します。
  • その他の公式組み込みタイプは編集とヘルスステータス設定をサポートしますが、デフォルトアルゴリズムは提供されません。「カスタム関数」または「設定なし」のみをサポートします。
  • カスタムタイプは編集、削除、ヘルスステータス設定をサポートしますが、デフォルトアルゴリズムは提供されません。「カスタム関数」または「設定なし」のみをサポートします。

ヘルスステータス設定

すべてのエンティティタイプ(組み込み + カスタム)はヘルスステータス設定をサポートしており、そのタイプのすべてのエンティティに対して統一されたデフォルトのヘルスステータス計算方法を設定するために使用します。

エンティティタイプ行の操作メニューにある「ヘルスステータス設定」をクリックします。タイプに応じて、選択可能な方法が異なります。

system タイプは以下の3つの方法をサポートします。

方法 説明
ヘルスステータス計算を有効にする ヘルスステータス計算を有効にするかどうかを制御するスイッチ。オフにすると、このタイプのすべてのエンティティはヘルスステータスが計算されず、カタログ一覧にヘルスステータスが表示されず、ヘルスステータスによるフィルタリングもできなくなります。
デフォルトアルゴリズム プラットフォームの組み込み集約アルゴリズムを使用してヘルスステータスを計算します。
カスタム関数 Func プラットフォームの関数を呼び出してヘルスステータスを計算します。選択後、特定の Func 関数を指定する必要があります。

system 以外のタイプは以下の2つの方法をサポートします。

方法 説明
ヘルスステータス計算を有効にする ヘルスステータス計算を有効にするかどうかを制御するスイッチ。オフにすると、このタイプのすべてのエンティティはヘルスステータスが計算されず、カタログ一覧にヘルスステータスが表示されず、ヘルスステータスによるフィルタリングもできなくなります。
カスタム関数 Func プラットフォームの関数を呼び出してヘルスステータスを計算します。選択後、特定の Func 関数を指定する必要があります。system 以外のタイプにはデフォルトアルゴリズムは提供されません。
適用ルール
  1. ここでの設定は、このエンティティタイプのデフォルトルールとなり、そのタイプのすべてのエンティティに適用されます。
  2. 特定のエンティティを作成または編集する際に、そのエンティティに対して、タイプのデフォルト設定に従うか、個別にカスタム関数を指定するかを選択できます。個別に指定されたエンティティは、こちらの設定変更の影響を受けません。
  3. ここで設定されたカスタム関数が削除されたり、使用できなくなった場合、デフォルト設定に従っているエンティティのヘルスステータスは「不明」と表示されます。個別に指定されたエンティティは影響を受けません。

ヘルスステータスとは

ヘルスステータスは、エンティティの全体的な動作状態を反映し、正常注意重大不明の4つの状態に分類されます。

system タイプの場合、システムはユーザーが構築したビジネス集約エンティティであり、ビジネスシステムまたはプラットフォームの集合体(例:「決済システム」「注文システム」)を表します。アラート/イベントは通常、システム自体ではなく、その下層のサービス、ホスト、データベースなどのエンティティに関連付けられるため、システムのヘルスステータスは、その構成エンティティの未復旧アラート状態を集約して計算されます。

簡単に言うと、システムのヘルスステータスは「そのシステムを構成する各部分」が全体としてどのように動作しているかを反映します。

system 以外のタイプの場合、ヘルスステータスはカスタム Func 関数を使用して計算されます。この関数内で、メトリクスしきい値、ログ異常、トレースエラー率などのデータに基づいて、計算ロジックを自由に定義できます。

ヘルスステータスの説明

ヘルスステータスは4つの状態に分類されます。

状態 スコア範囲 意味 よくあるシナリオ
正常 80–100 エンティティは全体的に良好に動作しており、未復旧のアラートはありません。 すべての構成エンティティにアクティブなアラートがない、またはカスタム関数が healthy を返す。
注意 60–79 エンティティに注意が必要な異常が存在します。 一部のエンティティに warning または error レベルのアラートがある、またはカスタム関数が warning を返す。
重大 0–59 エンティティに重大な異常が存在し、直ちに対処することを推奨します。 コアエンティティに fatal/critical アラートがある、または複数のエンティティが同時に障害を起こしている、またはカスタム関数が critical を返す。
不明 ヘルスステータスを一時的に計算できません。 エンティティに現在構成エンティティがない、または新規作成後の初回計算がまだ完了していない、またはカスタム関数の実行が失敗した/unknown を返した。
デフォルトアルゴリズムの説明

デフォルトアルゴリズムは system タイプのみサポートされ、以下の3つのステップで集約計算されます。

1. 構成エンティティとその重要度を決定する

システムのヘルスステータスは、その構成エンティティ(サービス、ホスト、データベースなど)に基づいて計算されます。エンティティによってシステムへの影響度は異なります。

  • 各エンティティには基本重要度レベルがあり、レベルが高いエンティティほどシステムのヘルスステータスに与える影響が大きくなります。
  • システム内で、特定の構成エンティティのヘルス影響ウェイトを調整して、デフォルトレベルを上書きすることもできます。
  • エンティティが「計算に含めない」と設定されている場合、そのエンティティのアラートはシステムのヘルスステータスに影響を与えません。

2. 個々のエンティティのアラート影響を評価する

構成エンティティに未復旧のアラートが存在する場合、プラットフォームはアラートの重大度に応じて減点します。

アラート重大度 エンティティへの影響
fatal / critical 大幅な減点
error 中程度の減点
warning 軽微な減点
info / 復旧済み 減点なし

同じエンティティに複数のアクティブなアラートが同時に存在する場合、プラットフォームは影響が最も大きい上位3つのアクティブな障害を取得し、減少係数で重ね合わせます(1つ目は全額、2つ目は50%、3つ目は25%)。これにより、大量の低レベルアラートによるスコアの歪みを防ぎつつ、複数障害が同時に発生するリスクを過小評価することもありません。

3. システム合計スコアを加重計算し、状態を判定する

システムスコアは加重平均方式で計算されます。

  • 各構成エンティティのアラート減点に、その重要度ウェイトを乗算します。
  • すべての構成エンティティの加重減点を合計し、総ウェイトで除算します。
  • 100点から上記の加重平均減点を減算し、最終的なシステムスコアを算出します。

状態判定

スコア範囲 状態
80–100 正常
60–79 注意
0–59 重大
カスタム関数

すべてのエンティティタイプは、Func を使用したカスタムヘルスステータス計算ロジックをサポートします。system 以外のタイプは、カスタム関数を使用してヘルスステータスを計算する必要があります。


エンティティ状態の判定

エンティティ状態は、データソースのレポートアクティビティを反映し、最終レポート時刻に基づいてシステムによって自動的に判定されます。手動で維持する必要はありません。現在、ホスト(DataKit データレポートに基づく)とサービス(APM Span データレポートに基づく)をサポートしています。

判定ルールの設定

統合カタログ > エンティティタイプ管理 > エンティティ一覧に移動し、左側のサイドバーにある「設定」アイコンをクリックして「エンティティタイプ管理」を選択します。エンティティタイプ一覧で、ホストまたはサービスタイプの行末にある「判定ルールの設定」をクリックします。

設定項目 説明 デフォルト値 設定可能範囲
オフライン判定しきい値 この期間を超えてデータレポートを受信しない場合、エンティティはオフラインとしてマークされます。 24 時間 1 時間 ~ 7 日
オフライン保持期間 オフラインになってからこの期間を超えると、エンティティは自動的にカタログから削除されます。 7 日 1 日 ~ 90 日
注意

権限制限:ワークスペースの Owner、管理者、または「統合カタログ > エンティティ分類設定」権限が付与されたカスタムロールのみが編集できます。手動で追加されたエンティティは、自動判定とクリーンアップの対象外です。

エンティティ状態の確認

1. エンティティ一覧

「エンティティ状態」列で、すべて / オンライン / オフラインでフィルタリングできます。

2. エンティティ詳細ページ

上部に状態ラベルが表示されます。オフラインのエンティティでは、オフライン時刻、予想削除時刻、最終レポート時刻を確認でき、手動でアクティブ化することもできます。

3. トポロジービュー

ワンクリックでオンラインのエンティティのみを表示できます。


関連ビューの管理

単一行のエンティティ右側のアイコンをクリックして、「関連ビューの管理」ページに移動します。ページは組み込み関連ビューカスタム関連ビューの2つの領域に分かれています。

組み込み関連ビュー

システムがデフォルトで提供する関連ビューで、必要に応じて有効または無効にできます。

  • 現在のエンティティタイプに公式の組み込みビューが存在する場合、ページに自動的にリストされ、デフォルトで有効状態になります。
  • 有効/無効:現在のビューの表示をカスタマイズして有効または無効にできます。

無効にすると、そのビューはエンティティ詳細ページに表示されなくなります。

カスタム関連ビュー

指定された形式に従って、関連ビューをカスタム設定できます。

設定が完了すると、そのタイプのすべてのエンティティの詳細ページに、対応するタブが表示され、迅速なドリルダウン分析が可能になります。

詳しくは設定の詳細を参照してください。

フィードバック

このページは役に立ちましたか?