REST Resource: anomalies

资源：Anomaly

表示在数据集中检测到的异常。

我们的异常值检测系统会标记时间序列中超出根据历史数据得出的预期范围的数据点。虽然这些预期范围有上限和下限，但我们只会在数据意外变差时标记异常，这通常对应于指标超出上限的情况。

时间轴上超出预期范围的多个连续数据点将归为单个异常。因此，异常实际上表示指标时间轴上的一个时间段。存储在 timelineSpec、dimensions 和 metric 中的信息可用于获取具有扩展范围的完整时间轴，以提供上下文。

所需权限：如需访问此资源，调用用户需要拥有应用的查看应用信息（只读）权限。

JSON 表示法 
{
  "name": string,
  "metricSet": string,
  "timelineSpec": {
    object (TimelineSpec)
  },
  "dimensions": [
    {
      object (DimensionValue)
    }
  ],
  "metric": {
    object (MetricValue)
  }
}
字段
name

string

标识符。异常的名称。

格式：apps/{app}/anomalies/{anomaly}
metricSet

string

检测到异常的指标集资源。
timelineSpec

object (TimelineSpec)

涵盖异常时间段的时间轴规范。
dimensions[]

object (DimensionValue)

检测到异常的维度组合。
metric

object (MetricValue)

检测到异常的指标以及异常值。

TimelineSpec

时间轴的时间相关汇总参数的规范。

时间轴具有汇总周期（DAILY、HOURLY 等），用于定义如何在指标中汇总事件。

时间轴中的点由汇总周期的开始日期时间定义。时长隐含在 AggregationPeriod 中。

如果指标集支持按小时汇总，则始终以世界协调时间 (UTC) 指定按小时汇总的时间段，以避免因夏令时转换而产生歧义。采用夏令时时，会跳过一个小时；放弃夏令时时，会重复一个小时。例如，时间戳“2021-11-07 01:00:00 America/Los_Angeles”存在歧义，因为它可以对应于“2021-11-07 08:00:00 UTC”或“2021-11-07 09:00:00 UTC”。

每日汇总周期需要指定时区，该时区将决定一天的开始和结束的确切时间点。并非所有指标集都支持所有时区，因此请务必检查您要查询的指标集支持哪些时区。

JSON 表示法 
{
  "aggregationPeriod": enum (AggregationPeriod),
  "startTime": {
    object (DateTime)
  },
  "endTime": {
    object (DateTime)
  }
}
字段
aggregationPeriod

enum (AggregationPeriod)

时间轴中数据点的汇总周期类型。

间隔由间隔开始时的日期和时间标识。
startTime

object (DateTime)

时间轴的起始数据点（含）。必须与汇总周期保持一致，如下所示：

  • HO网址Y：必须取消设置“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”国家/地区代码，值为“西班牙”。

虽然维度值是稳定的，但此值标签可能会发生变化。请勿假设 (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)

实际值，以小数形式表示。
联合字段 confidence_interval。如果提供，则表示值的置信区间。confidence_interval 只能是下列其中一项：
decimalValueConfidenceInterval

object (DecimalConfidenceInterval)

类型为 type.Decimal 的值的置信区间。

DecimalConfidenceInterval

表示指标的置信区间。

JSON 表示法 
{
  "lowerBound": {
    object (Decimal)
  },
  "upperBound": {
    object (Decimal)
  }
}
字段
lowerBound

object (Decimal)

置信区间的下限。
upperBound

object (Decimal)

置信区间的上限。

方法

list

 列出任何数据集中的异常情况。