REST Resource: anomalies

リソース: Anomaly

データセットで検出された異常を表します。

異常検出システムは、過去のデータから導き出された予測範囲から外れた時系列のデータポイントを検出します。これらの予測範囲には上限と下限がありますが、データが予想外に悪化した場合にのみ異常が検出されます。通常、これは指標が上限を超えた場合に該当します。

タイムライン内の予想範囲外の連続する複数のデータポイントは、1 つの異常としてグループ化されます。したがって、異常は指標のタイムラインのセグメントを効果的に表します。timelineSpec、dimensions、metric に保存された情報は、コンテキストの範囲を拡大して完全なタイムラインを取得するために使用できます。

必要な権限: このリソースにアクセスするには、呼び出し元のユーザーにアプリのアプリ情報の閲覧（読み取り専用）権限が必要です。

JSON 表現 
{
  "name": string,
  "metricSet": string,
  "timelineSpec": {
    object (TimelineSpec)
  },
  "dimensions": [
    {
      object (DimensionValue)
    }
  ],
  "metric": {
    object (MetricValue)
  }
}
フィールド
name

string

ID。異常の名前。

形式: apps/{app}/anomalies/{anomaly}
metricSet

string

異常が検出された指標セット リソース。
timelineSpec

object (TimelineSpec)

異常期間をカバーするタイムラインの指定。
dimensions[]

object (DimensionValue)

異常が検出されたディメンションの組み合わせ。
metric

object (MetricValue)

異常が検出された指標と異常値。

TimelineSpec

タイムラインの時間関連の集計パラメータの仕様。

タイムラインには集計期間（DAILY、HOURLY など）があり、指標でイベントを集計する方法を定義します。

タイムラインのポイントは、集計期間の開始日時で定義されます。期間は AggregationPeriod で暗黙的に指定されます。

指標セットでサポートされている時間単位の集計期間は、夏時間の移行に関する曖昧さを回避するために、常に UTC で指定されます。夏時間を採用すると 1 時間がスキップされ、夏時間を廃止すると 1 時間が繰り返されます。たとえば、タイムスタンプ「2021-11-07 01:00:00 America/Los_Angeles」は、「2021-11-07 08:00:00 UTC」または「2021-11-07 09:00:00 UTC」に対応する可能性があるため、曖昧です。

日単位の集計期間では、タイムゾーンを指定する必要があります。これにより、1 日の開始時刻と終了時刻が正確に決まります。すべての指標セットがすべてのタイムゾーンをサポートしているわけではありません。クエリする指標セットでサポートされているタイムゾーンを確認してください。

JSON 表現 
{
  "aggregationPeriod": enum (AggregationPeriod),
  "startTime": {
    object (DateTime)
  },
  "endTime": {
    object (DateTime)
  }
}
フィールド
aggregationPeriod

enum (AggregationPeriod)

タイムライン内のデータポイントの集計期間のタイプ。

間隔は、間隔の開始日時で識別されます。
startTime

object (DateTime)

タイムラインの開始データポイント（このデータポイントを含む）。次のように集計期間に合わせる必要があります。

  • HOURLY: 'minutes'、'seconds'、'nanos' フィールドは未設定にする必要があります。timeZone は設定しないままにする（デフォルトは UTC）か、明示的に「UTC」に設定できます。他の utcOffset またはタイムゾーン ID を設定すると、検証エラーが発生します。
  • DAILY: 'hours'、'minutes'、'seconds'、'nanos' の各フィールドは設定解除する必要があります。サポートされるタイムゾーンは、指標セットによって異なります。設定しないままにして、指標セットで指定されたデフォルトのタイムゾーンを使用することもできます。

終了地点のタイムゾーンは、開始地点のタイムゾーンと一致している必要があります。
endTime

object (DateTime)

タイムラインの終了データポイント（この値を含みません）。制限については、startTime をご覧ください。終了地点のタイムゾーンは、開始地点のタイムゾーンと一致している必要があります。

DimensionValue

単一のディメンションの値を表します。

JSON 表現 
{
  "dimension": string,
  "valueLabel": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "int64Value": string
  // End of list of possible types for union field value.
}
フィールド
dimension

string

ディメンションの名前。
valueLabel

string

省略可。値の人間が理解できるラベル。常に英語で指定します。たとえば、国コード「ES」の場合は「Spain」となります。

ディメンション値は安定していますが、この値ラベルは変更される可能性があります。（value、valueLabel）の関係が安定していると想定しないでください。たとえば、ISO 国コード「MK」は最近「北マケドニア」に名称変更されました。
共用体フィールド value。ディメンションの実際の値。型によって異なります。value は次のいずれかになります。
stringValue

string

実際の値（文字列として表されます）。
int64Value

string (int64 format)

実際の値（int64 として表されます）。

MetricValue

指標の値を表します。

JSON 表現 
{
  "metric": string,

  // Union field value can be only one of the following:
  "decimalValue": {
    object (Decimal)
  }
  // End of list of possible types for union field value.

  // Union field confidence_interval can be only one of the following:
  "decimalValueConfidenceInterval": {
    object (DecimalConfidenceInterval)
  }
  // End of list of possible types for union field confidence_interval.
}
フィールド
metric

string

指標の名前。
共用体フィールド value。指標の実際の値。型によって異なります。value は次のいずれかになります。
decimalValue

object (Decimal)

実際の値（10 進数）。
共用体フィールド confidence_interval。指定されている場合、値の信頼区間を表します。confidence_interval は次のいずれかになります。
decimalValueConfidenceInterval

object (DecimalConfidenceInterval)

type.Decimal 型の値の信頼区間。

DecimalConfidenceInterval

指標の信頼区間を表します。

JSON 表現 
{
  "lowerBound": {
    object (Decimal)
  },
  "upperBound": {
    object (Decimal)
  }
}
フィールド
lowerBound

object (Decimal)

信頼区間の下限。
upperBound

object (Decimal)

信頼区間の上限。

メソッド

list

 データセットの異常を一覧表示します。