uip insights alert-history

「uip insights alert-history」の構文とオプション。UiPath Insights のアラート トリガーの履歴と、間隔ごとのトリガー数のメトリックを読み取ります。

uip insights alert-history は、アラートの定義方法を読み取る アラートとは対照的に、アラート (トリガーの行とトリガー数の集計メトリック) が発生したときに読み取られます。

注:

これらのルートは、クラウドおよび専有型の SaaS デプロイへの機能ゲートされます。他のデプロイの種類では、コマンドは失敗し、空の結果ではなく、ルートが提供されていないことを示す ConfigError が表示されます。

概要

uip insights alert-history list [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] [-l <n>] [-o <n>]
uip insights alert-history get-metrics [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] --time-grouping <size>

すべての動詞は、 グローバル オプション と標準の 終了コードを尊重します。どちらの動詞も -t, --tenant を受け入れません。 uip login時に選択したテナントを使用します。

共有フィルター

どちらの動詞も同じフィルター セットを受け入れます。

フラグ	説明
--time-range <minutes>	相対ウィンドウは分単位で終了します。--since/--untilと事実上相互に排他的です — 以下を参照してください。
--since <epoch-seconds>	絶対下限、Unix エ ポック秒 (ミリ秒ではない — ジョブは ミリ秒を使用します)。
--until <epoch-seconds>	絶対上限、Unixエポック秒。--sinceでのみ意味があります。
--alert-name <name>	フィルターを適用して、1 つのアラート名に絞り込む。空にすることはできません。
--folder-name <names...>	フォルダー 名 (フォルダー キーではない)、スペース区切り/繰り返し可能でフィルター処理します。
--severity <severities...>	重要度、スペース区切り/繰り返し可能 ( INFO、 WARN、 ERROR、 NORMAL でフィルター処理します (NORMAL は後方互換性のためにのみ保持されます)。

時刻の選択が必要です。 --time-range、または --since (任意で --untilを使用) から選択できます。どちらも合格していないと検証に失敗します。--since 0/absent --since 両方 --until のみを設定すると、拒否されるのではなく、取得可能な最も古いタイムスタンプに浮動小数点になります。

重要:

list は最新の 1000 行に上限を設定 サーバー側 (ORDER BY Timestamp DESC LIMIT 1000) — これはペイロード自体には表示されません。ちょうど 1,000 行が返された場合、応答の Instructions フィールドには切り捨てメモが付きます。「真の数はもっと大きく、不明である可能性があります」です。--time-range/--since+--untilを絞り込むか、フィルターを追加して上限を下回るようにし、返されるカウント 1000 を正確に信頼するのではありません。

UIP Insights のアラート - 履歴リスト

アラート トリガーの履歴行を時間枠内に、新しい順に一覧表示します。

オプション

「共有フィルター」に加えて、「共有フィルター」をご覧ください。

フラグ	説明
-l, --limit <number>	返される最大行数。既定値は 50です。
-o, --offset <number>	結果を返す前にスキップする行です。

ページネーションは、(最大 1000 行の) バックエンドの応答に対するクライアント側で行われます。

例

uip insights alert-history list --time-range 1440

uip insights alert-history list \
  --since 1714003200 --until 1714608000 \
  --severity ERROR WARN

データシェイプ

{
  "Code": "InsightsAlertHistoryList",
  "Data": [
    {
      "alertId": 42,
      "alertName": "High failure rate",
      "triggeredAt": 1714003200,
      "severity": "ERROR",
      "operator": "GreaterThan",
      "threshold": 5,
      "metric": "FailedJobCount",
      "metricState": "Failed",
      "deliveryId": 7
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}

triggeredAt は Unix エポック秒であり、ジョブのミリ秒フィールドとは異なり、--since/--untilと同じ単位です。--folder-nameでは、一致するフォルダーごとにバックエンドが同じトリガーを 1 回だけ出力できるため、同一に見える行は、重複するのではなく実際の別個のイベントにすることができます。

uip insights alert-history get-metrics

アラートのトリガー数を、アラートの種類別にグループ化して、時間間隔ごとに取得します。

オプション

「共有フィルター」に加えて、「共有フィルター」をご覧ください。

フラグ	説明
--time-grouping <size>	必須。メトリック間隔のバケット サイズ。

例

uip insights alert-history get-metrics --time-range 10080 --time-grouping day

データシェイプ

{
  "Code": "InsightsAlertHistoryMetrics",
  "Data": {
    "groups": ["High failure rate", "SLA breach"],
    "intervalEndTimes": [1714003200, 1714089600],
    "counts": [[2, 5], [0, 1]]
  }
}

結果はアラートの種類別にグループ化されます。 counts では、 groupsのエントリごとに 1 行のトリガー カウントが保持され、各カウントは intervalEndTimesの同じインデックスでの間隔終了時刻とペアになります。

関連

• アラート — これらのトリガーが参照するアラートの定義です。
• alert-deliveries — トリガーの通知 (deliveryId) が送信された場所です。

参照

• Insights の概要