MCP Tools Reference: monitoring.googleapis.com

工具：list_dashboards

使用此工具作为主要工具，检索 Google Cloud 项目中现有自定义监控信息中心的列表。借助自定义监控信息中心，用户可以在同一上下文中查看和分析来自不同来源的数据。这有助于了解指定项目中当前配置和可用的自定义信息中心。

以下示例演示了如何使用 curl 调用 list_dashboards MCP 工具。

Curl 请求 
                  
curl --location 'https://monitoring.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_dashboards",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

ListDashboards 请求。

ListDashboardsRequest

JSON 表示法 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string
}
字段
parent

string

必需。要列出的信息中心的范围。格式为：

projects/[PROJECT_ID_OR_NUMBER]
pageSize

integer

一个正数，表示要返回的结果数上限。如果未指定，则使用默认值 1000。
pageToken

string

可选。如果此字段不为空，则必须包含之前对此方法的调用返回的 nextPageToken 值。使用此字段会导致该方法返回之前方法调用中的其他结果。

输出架构

ListDashboards 请求。

ListDashboardsResponse

JSON 表示法 
{
  "dashboards": [
    {
      object (Dashboard)
    }
  ],
  "nextPageToken": string
}
字段
dashboards[]

object (Dashboard)

所请求的信息中心的列表。
nextPageToken

string

如果结果数量多于已返回的结果数量，则此字段会设置为非空值。如需查看其他结果，请在下次调用此方法时将该值用作 page_token。

信息中心

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "etag": string,
  "dashboardFilters": [
    {
      object (DashboardFilter)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    object (DashboardAnnotations)
  },

  // Union field layout can be only one of the following:
  "gridLayout": {
    object (GridLayout)
  },
  "mosaicLayout": {
    object (MosaicLayout)
  },
  "rowLayout": {
    object (RowLayout)
  },
  "columnLayout": {
    object (ColumnLayout)
  }
  // End of list of possible types for union field layout.
}
字段
name

string

标识符。信息中心的资源名称。
displayName

string

必需。可变且直观易懂的名称。
etag

string

etag 用于乐观并发控制，可帮助防止同时对政策进行的更新相互覆盖。在对 GetDashboard 的响应中返回 etag，用户应将该 etag 放入对 UpdateDashboard 的请求中，以确保其更改将应用于同一版本的信息中心配置。在创建信息中心期间不应传递该字段。
dashboardFilters[]

object (DashboardFilter)

根据过滤条件过滤数据，以减少图表数据量。
labels

map (key: string, value: string)

应用于信息中心的标签

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
annotations

object (DashboardAnnotations)

用于在此信息中心上显示事件注解的配置。
联合字段 layout。用于定义布局样式的信息中心根容器元素。layout 只能是下列其中一项：
gridLayout

object (GridLayout)

内容采用基本布局进行排列，该布局会重新排列简单的信息元素列表，例如 widget 或功能块。
mosaicLayout

object (MosaicLayout)

内容以平铺网格的形式排列，每个内容 widget 占据一个或多个网格块。
rowLayout

object (RowLayout)

内容分为等间距的行，微件水平排列。
columnLayout

object (ColumnLayout)

内容划分为等间距的列，微件垂直排列。

GridLayout

JSON 表示法 
{
  "columns": string,
  "widgets": [
    {
      object (Widget)
    }
  ]
}
字段
columns

string (int64 format)

视图宽度划分成的列数。如果省略或设置为零，则在渲染时使用系统默认值。
widgets[]

object (Widget)

按行优先顺序排列到列中的信息元素。

微件

JSON 表示法 
{
  "title": string,
  "id": string,
  "visibilityCondition": {
    object (VisibilityCondition)
  },

  // Union field content can be only one of the following:
  "xyChart": {
    object (XyChart)
  },
  "scorecard": {
    object (Scorecard)
  },
  "text": {
    object (Text)
  },
  "blank": {
    object
  },
  "alertChart": {
    object (AlertChart)
  },
  "timeSeriesTable": {
    object (TimeSeriesTable)
  },
  "collapsibleGroup": {
    object (CollapsibleGroup)
  },
  "logsPanel": {
    object (LogsPanel)
  },
  "incidentList": {
    object (IncidentList)
  },
  "pieChart": {
    object (PieChart)
  },
  "treemap": {
    object (Treemap)
  },
  "errorReportingPanel": {
    object (ErrorReportingPanel)
  },
  "sectionHeader": {
    object (SectionHeader)
  },
  "singleViewGroup": {
    object (SingleViewGroup)
  },
  "filterControl": {
    object (FilterControl)
  }
  // End of list of possible types for union field content.
}
字段
title

string

可选。微件的名称。
id

string

可选。widget ID。ID 可以包含字母数字字符、短划线和下划线。widget ID 是可选的。
visibilityCondition

object (VisibilityCondition)

可选。如果设置了此属性，则仅当条件评估结果为 true 时，系统才会呈现相应 widget。
联合字段 content。内容定义用于填充 widget 的组件。content 只能是下列其中一项：
xyChart

object (XyChart)

时序数据图表。
scorecard

object (Scorecard)

汇总时序数据的得分卡。
text

object (Text)

显示文字内容的原始字符串或 Markdown。
blank

object

空白。
alertChart

object (AlertChart)

提醒政策数据图表。
timeSeriesTable

object (TimeSeriesTable)

以表格格式显示时序数据的 widget。
collapsibleGroup

object (CollapsibleGroup)

用于对其他 widget 进行分组的 widget。分组 widget 所涵盖区域内的所有 widget 均被视为成员 widget。
logsPanel

object (LogsPanel)

显示日志流的 widget。
incidentList

object (IncidentList)

显示突发事件列表的 widget。
pieChart

object (PieChart)

以饼图形式显示时序数据的 widget。
treemap

object (Treemap)

以树状图形式显示数据的 widget。
errorReportingPanel

object (ErrorReportingPanel)

用于显示错误组列表的 widget。
sectionHeader

object (SectionHeader)

用于定义部分标题的 widget，以便更轻松地浏览信息中心。
singleViewGroup

object (SingleViewGroup)

一种使用下拉菜单对其他 widget 进行分组的 widget。
filterControl

object (FilterControl)

一种用于显示输入字段以更改模板变量值的 widget。

XyChart

JSON 表示法 
{
  "dataSets": [
    {
      object (DataSet)
    }
  ],
  "timeshiftDuration": string,
  "thresholds": [
    {
      object (Threshold)
    }
  ],
  "xAxis": {
    object (Axis)
  },
  "yAxis": {
    object (Axis)
  },
  "y2Axis": {
    object (Axis)
  },
  "chartOptions": {
    object (ChartOptions)
  }
}
字段
dataSets[]

object (DataSet)

必需。此图表中显示的数据。
timeshiftDuration

string (Duration format)

用于显示比较图表的时长。比较图表可同时显示两个时长相近的时间段（例如周环比指标）的值。时长必须为正值，并且只能应用于具有折线图类型数据集的图表。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
thresholds[]

object (Threshold)

在图表中横向绘制的阈值线。
xAxis

object (Axis)

应用于 x 轴的属性。
yAxis

object (Axis)

应用于 y 轴的属性。
y2Axis

object (Axis)

应用于 y2 轴的属性。
chartOptions

object (ChartOptions)

图表的显示选项。

DataSet

JSON 表示法 
{
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "plotType": enum (PlotType),
  "legendTemplate": string,
  "minAlignmentPeriod": string,
  "targetAxis": enum (TargetAxis),
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "measures": [
    {
      object (Measure)
    }
  ],
  "breakdowns": [
    {
      object (Breakdown)
    }
  ],
  "sort": [
    {
      object (ColumnSortingOptions)
    }
  ]
}
字段
timeSeriesQuery

object (TimeSeriesQuery)

必需。用于从 Stackdriver 指标 API 查询时序数据的字段。
plotType

enum (PlotType)

相应数据应如何在图表上绘制。
legendTemplate

string

用于在生成的数据集中命名 TimeSeries 的模板字符串。这应该是一个包含 ${label_name} 形式的插值的字符串，该插值将解析为标签的值。
minAlignmentPeriod

string (Duration format)

可选。相应数据集的数据点频次下限，通过指定在时序查询中使用的最短对齐周期来实现。例如，如果数据每 10 分钟发布一次，则 min_alignment_period 应至少为 10 分钟。以 1 分钟的时间间隔提取和对齐数据是没有意义的。

对于 PromQL 查询，此字段用于设置查询 step 的最小间隔，从而控制数据粒度。较大的值可以提高长时间范围内的性能。如需详细了解 PromQL step，请参阅查询基础知识和范围查询。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
targetAxis

enum (TargetAxis)

可选。用于绘制指标的目标轴。
dimensions[]

object (Dimension)

可选。维度列的集合。
measures[]

object (Measure)

可选。一组衡量指标。
breakdowns[]

object (Breakdown)

可选。要应用于数据集的细分集合。
sort[]

object (ColumnSortingOptions)

可选。一组排序选项，用于影响数据和图例的顺序。

TimeSeriesQuery

JSON 表示法 
{
  "unitOverride": string,
  "outputFullDuration": boolean,

  // Union field source can be only one of the following:
  "timeSeriesFilter": {
    object (TimeSeriesFilter)
  },
  "timeSeriesFilterRatio": {
    object (TimeSeriesFilterRatio)
  },
  "timeSeriesQueryLanguage": string,
  "prometheusQuery": string,
  "opsAnalyticsQuery": {
    object (OpsAnalyticsQuery)
  },
  "traceQuery": {
    object (TraceQuery)
  }
  // End of list of possible types for union field source.
}
字段
unitOverride

string

所提取时序中包含的数据的单位。如果非空，此单位将替换随提取的数据一起提供的任何单位。格式与 MetricDescriptor 中的 unit 字段相同。
outputFullDuration

boolean

可选。如果设置了此参数，Cloud Monitoring 会将整个查询时长视为对齐周期，因此只会有一个输出值。

*注意：这可能会替换配置的对齐周期，但需要一系列数据点的情况除外，例如 - XyChart - 记分卡的迷你图
联合字段 source。获取图表数据所需的参数。source 只能是下列其中一项：
timeSeriesFilter

object (TimeSeriesFilter)

用于提取时序的过滤参数。
timeSeriesFilterRatio

object (TimeSeriesFilterRatio)

用于提取两个时序过滤条件之间的比率的参数。
timeSeriesQueryLanguage

string

用于使用 MQL 获取时序的查询。
prometheusQuery

string

用于使用 PromQL 获取时序的查询。
opsAnalyticsQuery

object (OpsAnalyticsQuery)

预览：用于使用 SQL 获取时序、类别序列或数值序列的查询。此功能为预览版，在最终版本发布前可能会发生变化。
traceQuery

object (TraceQuery)

可选。预览：查询轨迹。此功能为预览版，在最终版本发布前可能会发生变化。

TimeSeriesFilter

JSON 表示法 
{
  "filter": string,
  "aggregation": {
    object (Aggregation)
  },
  "secondaryAggregation": {
    object (Aggregation)
  },

  // Union field output_filter can be only one of the following:
  "pickTimeSeriesFilter": {
    object (PickTimeSeriesFilter)
  },
  "statisticalTimeSeriesFilter": {
    object (StatisticalTimeSeriesFilter)
  }
  // End of list of possible types for union field output_filter.
}
字段
filter

string

必需。用于标识要查询的指标类型、资源和项目的监控过滤条件。
aggregation

object (Aggregation)

默认情况下，系统会返回原始时序数据。使用此字段可合并多个时序，以获得不同的数据视图。
secondaryAggregation

object (Aggregation)

在应用 aggregation 后应用第二次聚合。
联合字段 output_filter。选择一个可选的时序过滤条件。output_filter 只能是下列其中一项：
pickTimeSeriesFilter

object (PickTimeSeriesFilter)

基于排名的时序过滤条件。
statisticalTimeSeriesFilter
(deprecated)

object (StatisticalTimeSeriesFilter)

基于统计信息的时序过滤条件。注意：此字段已弃用，并且会被 API 完全忽略。

聚合

JSON 表示法 
{
  "alignmentPeriod": string,
  "perSeriesAligner": enum (Aligner),
  "crossSeriesReducer": enum (Reducer),
  "groupByFields": [
    string
  ]
}
字段
alignmentPeriod

string (Duration format)

alignment_period 指定一个时间间隔（以秒为单位），用于将所有 time series 中的数据划分为一致的时间块。此操作将在应用序列对齐器之前完成。

该值必须至少为 60 秒。如果指定了除 ALIGN_NONE 之外的每个序列对齐器，则此字段为必需字段，否则系统会返回错误。如果未指定任何序列级对齐器，或者指定了对齐器 ALIGN_NONE，则系统会忽略此字段。

alignment_period 的最大值为 2 年，即 104 周。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
perSeriesAligner

enum (Aligner)

Aligner 用于描述如何使单个时序中的数据点在时间上保持一致。除了 ALIGN_NONE 之外，所有对齐方式都会将 alignment_period 中的所有数据点以数学方式分组在一起，从而为每个 alignment_period 生成一个数据点，其结束时间戳位于相应时间段的末尾。

并非所有对齐操作都可应用于所有时序。有效选项取决于原始时序的 metric_kind 和 value_type。对齐可以更改时序的 metric_kind 或 value_type。

时序数据必须先校准，然后才能执行跨时序缩减。如果指定了 cross_series_reducer，则必须指定 per_series_aligner 且 per_series_aligner 不得等于 ALIGN_NONE，并且必须指定 alignment_period；否则，系统会返回错误。
crossSeriesReducer

enum (Reducer)

用于将多个时序合并为单个时序的缩减操作，其中结果时序中每个数据点的值是输入时序中所有已对齐的值的函数。

并非所有归纳器操作都可应用于所有时序。有效选项取决于原始时序的 metric_kind 和 value_type。缩减可能会生成 metric_kind 或 value_type 与输入时序不同的时序。

时序数据必须先进行校准（请参阅 per_series_aligner），然后才能执行跨时序缩减。如果指定了 cross_series_reducer，则必须指定 per_series_aligner，且不得为 ALIGN_NONE。还必须指定 alignment_period；否则，系统会返回错误。
groupByFields[]

string

指定 cross_series_reducer 时要保留的字段集。group_by_fields 用于确定在应用聚合操作之前如何将时序划分为子集。每个子集中都包含在每个分组字段中具有相同值的时序。每个单独的时序都属于一个子集。cross_series_reducer 会应用于每个时序子集。无法跨不同资源类型进行缩减，因此此字段隐式包含 resource.type。未在 group_by_fields 中指定的字段会被聚合掉。如果未指定 group_by_fields 且所有时序都具有相同的资源类型，则这些时序会聚合为单个输出时序。如果未定义 cross_series_reducer，则忽略此字段。

时长

JSON 表示法 
{
  "seconds": string,
  "nanos": integer
}
字段
seconds

string (int64 format)

时间段的带符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间（含边界值）。注意：这些界限是通过以下计算得出的：60 秒/分钟 * 60 分钟/小时 * 24 小时/天 * 365.25 天/年 * 10000 年
nanos

integer

时间跨度的有符号秒数小数部分（以纳秒为单位）。小于 1 秒的时长用 0 seconds 字段和正或负 nanos 字段表示。对于时长为 1 秒或更长时间的视频，nanos 字段的非零值必须与 seconds 字段的符号相同。必须介于 -999,999,999 到 +999,999,999 之间（含边界值）。

PickTimeSeriesFilter

JSON 表示法 
{
  "rankingMethod": enum (Method),
  "numTimeSeries": integer,
  "direction": enum (Direction),
  "interval": {
    object (Interval)
  }
}
字段
rankingMethod

enum (Method)

ranking_method 会独立应用于每个时序，以生成用于将该时序与其他时序进行比较的值。
numTimeSeries

integer

允许通过过滤器的时序数量。
direction

enum (Direction)

如何使用排名来选择通过过滤器的时序。
interval

object (Interval)

选择相应时间间隔内的前 N 个数据流/时序

间隔

JSON 表示法 
{
  "startTime": string,
  "endTime": string
}
字段
startTime

string (Timestamp format)

可选。时间间隔的开始时间（含）。

如果指定，则与此时间间隔匹配的时间戳必须等于或晚于开始时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

可选。时间间隔的结束时间（不含）。

如果指定，则与此时间间隔匹配的时间戳必须早于结束时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

时间戳

JSON 表示法 
{
  "seconds": string,
  "nanos": integer
}
字段
seconds

string (int64 format)

表示世界协调时间 (UTC) 的秒数（从 Unix 纪元 1970-01-01T00:00:00Z 开始算起）。必须介于 -62135596800 到 253402300799 之间（含边界值），对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。
nanos

integer

秒数的非负小数部分（以纳秒为单位）。此字段是时长的纳秒部分，而不是秒的替代项。对于含小数部分的负秒数，仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间（含边界值）。

StatisticalTimeSeriesFilter

JSON 表示法 
{
  "rankingMethod": enum (Method),
  "numTimeSeries": integer
}
字段
rankingMethod

enum (Method)

rankingMethod 会应用于一组时序，然后使用每个单独时序的生成值将给定的时序与其他时序进行比较。这些方法无法逐个应用于数据流，而是需要请求的完整上下文来评估时序。
numTimeSeries

integer

要输出的时序数量。

TimeSeriesFilterRatio

JSON 表示法 
{
  "numerator": {
    object (RatioPart)
  },
  "denominator": {
    object (RatioPart)
  },
  "secondaryAggregation": {
    object (Aggregation)
  },

  // Union field output_filter can be only one of the following:
  "pickTimeSeriesFilter": {
    object (PickTimeSeriesFilter)
  },
  "statisticalTimeSeriesFilter": {
    object (StatisticalTimeSeriesFilter)
  }
  // End of list of possible types for union field output_filter.
}
字段
numerator

object (RatioPart)

比率的分子。
denominator

object (RatioPart)

比率的分母。
secondaryAggregation

object (Aggregation)

在计算出比率后应用第二次聚合。
联合字段 output_filter。选择在计算比率后应用于时序的可选过滤条件。output_filter 只能是下列其中一项：
pickTimeSeriesFilter

object (PickTimeSeriesFilter)

基于排名的时序过滤条件。
statisticalTimeSeriesFilter
(deprecated)

object (StatisticalTimeSeriesFilter)

基于统计信息的时序过滤条件。注意：此字段已弃用，并且会被 API 完全忽略。

RatioPart

JSON 表示法 
{
  "filter": string,
  "aggregation": {
    object (Aggregation)
  }
}
字段
filter

string

必需。用于标识要查询的指标类型、资源和项目的监控过滤条件。
aggregation

object (Aggregation)

默认情况下，系统会返回原始时序数据。使用此字段可合并多个时序，以获得不同的数据视图。

OpsAnalyticsQuery

JSON 表示法 
{
  "sql": string
}
字段
sql

string

用于提取时序、类别序列或数值序列数据的 SQL 查询。

TraceQuery

JSON 表示法 
{
  "spanDataValue": enum (SpanDataValue),
  "spanFilters": {
    object (SpanFilters)
  },
  "resourceContainer": string
}
字段
spanDataValue

enum (SpanDataValue)

要在图表上显示的 span 数据值的类型。必填。
spanFilters

object (SpanFilters)

我们将支持的跨度过滤的首个版本。必填。
resourceContainer

string

可选。要从中提取数据的项目或跟踪记录范围的资源名称。如果为空，该 widget 将默认使用项目的默认 Trace 范围。如果无法确定范围，则回退到当前项目。可选。

SpanFilters

JSON 表示法 
{
  "services": [
    string
  ],
  "displayNames": [
    string
  ],
  "status": [
    string
  ],
  "kinds": [
    string
  ],
  "minDuration": string,
  "maxDuration": string,
  "attributes": [
    {
      object (SpanAttributeFilter)
    }
  ],
  "isRootSpan": boolean,
  "applicationIds": [
    string
  ],
  "apphubServices": [
    string
  ],
  "apphubWorkloads": [
    string
  ]
}
字段
services[]

string

可选。过滤包含列表中某项服务的 span。多个值将通过 OR 运算符连接在一起。
displayNames[]

string

可选。过滤包含列表中某个 span 显示名称的 span。多个值将通过 OR 运算符连接在一起。
status[]

string

可选。过滤包含列表中某个状态的 span。多个值将通过 OR 运算符连接在一起。
kinds[]

string

可选。过滤包含列表中某种类型的 span。多个值将通过 OR 运算符连接在一起。
minDuration

string (Duration format)

可选。按最短时长过滤 span。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
maxDuration

string (Duration format)

可选。过滤出时长不超过指定上限的 span。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
attributes[]

object (SpanAttributeFilter)

可选。span 属性过滤条件的列表。每个 SpanAttributeFilter 键都必须是唯一的。多个属性过滤条件将通过 AND 运算符连接在一起。
isRootSpan

boolean

可选。如果设置为 true，则仅过滤根 span。根 span 是未定义父 span ID 的 span。
applicationIds[]

string

可选。过滤包含列表中某个 Apphub 应用 ID 的 span。多个值将通过 OR 运算符连接在一起。
apphubServices[]

string

可选。过滤包含列表中某个 Apphub 服务 ID 的 span。多个值将通过 OR 运算符连接在一起。示例：["service-id1", "service-id2"]
apphubWorkloads[]

string

可选。过滤包含列表中某个 Apphub 工作负载 ID 的 span。多个值将通过 OR 运算符连接在一起。示例：["workload-id1", "workload-id2"]

SpanAttributeFilter

JSON 表示法 
{
  "key": string,
  "value": [
    string
  ]
}
字段
key

string

属性的键
value[]

string

指定键的属性值列表。多个值将通过 OR 运算符连接在一起。

维度

JSON 表示法 
{
  "column": string,
  "columnType": string,
  "maxBinCount": integer,
  "sortOrder": enum (SortOrder),
  "sortColumn": string,
  "xMin": number,
  "xMax": number,

  // Union field bin_size can be only one of the following:
  "timeBinSize": string,
  "numericBinSize": integer,
  "floatBinSize": number
  // End of list of possible types for union field bin_size.
}
字段
column

string

必需。对于使用 SQL 查询的小部件，请将该值设置为结果表中要绘制图表的数据所在的列的名称。对于使用时序查询的直方图，请将此字段的值设置为 metric_value。
columnType

string

可选。维度列的类型。只有在设置了某个 bin_size 字段时，此字段才相关。如果为空，系统会根据设置的 bin_size 字段来假定类型为 TIMESTAMP 或 INT64。如果填充了此字段，则应将其设置为以下类型之一：DATE、TIME、DATETIME、TIMESTAMP、BIGNUMERIC、INT64、NUMERIC、FLOAT64。
maxBinCount

integer

对于使用 SQL 查询的 widget，生成箱数的上限。如果指定为 0，则不会强制执行最大数量。对于使用时序查询的直方图，要生成的箱数的确切数量。如果未指定或值为 0，则直方图会确定要使用的箱数。
sortOrder

enum (SortOrder)

应用于排序列的排序顺序。
sortColumn

string

用于分箱的排序依据列名称。此列可以与相应维度是同一列，也可以是结果中用作衡量指标的任何其他列。如果 sort_order 设置为 NONE，则不使用此值。
xMin

number

X 轴的最小值。
xMax

number

X 轴的最大值。
联合字段 bin_size。bin_size 的值用于配置由 column 字段指定的维度的点分组。bin_size 只能是下列其中一项：
timeBinSize

string (Duration format)

当指定维度的数据类型为时间类型，且箱大小由时间段确定时，使用 time_bin_size。如果 column_type 为 DATE，则此值必须是 1 天的整数倍。如果 column_type 为 TIME，则此值必须小于或等于 24 小时。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
numericBinSize

integer

当用于维度的列类型为数值或字符串时，使用 numeric_bin_size。如果 column 字段设置为 metric_value，则 numericBinSize 会替换 maxBinCount。
floatBinSize

number

可选。当用于维度的列类型为浮点数值列时，使用 float_bin_size。

测量

JSON 表示法 
{
  "column": string,
  "aggregationFunction": {
    object (AggregationFunction)
  }
}
字段
column

string

必需。用于衡量指标的数据集中的列名称。
aggregationFunction

object (AggregationFunction)

必需。应用于输入列的聚合函数。除非已针对相应维度停用分箱，否则不得将此值设置为 "none"。聚合函数用于对维度箱中的点进行分组。

聚合函数

JSON 表示法 
{
  "type": string,
  "parameters": [
    {
      object (Parameter)
    }
  ]
}
字段
type

string

必需。聚合函数的类型，必须是以下类型之一：

  • “none” - 无功能。
  • “百分位数”- APPROX_QUANTILES() - 1 个参数数值
  • “average” - AVG()
  • “count” - COUNT()
  • “count-distinct” - COUNT(DISTINCT)
  • “count-distinct-approx” - APPROX_COUNT_DISTINCT()
  • “max” - MAX()
  • “min” - MIN()
  • “sum” - SUM()
parameters[]

object (Parameter)

可选。应用于聚合函数的参数。仅用于需要它们的函数。

参数

JSON 表示法 
{

  // Union field value can be only one of the following:
  "intValue": string,
  "doubleValue": number
  // End of list of possible types for union field value.
}
字段
联合字段 value。参数值。value 只能是下列其中一项：
intValue

string (int64 format)

整数参数值。
doubleValue

number

浮点参数值。

细分

JSON 表示法 
{
  "column": string,
  "limit": integer,
  "aggregationFunction": {
    object (AggregationFunction)
  },
  "sortOrder": enum (SortOrder)
}
字段
column

string

必需。数据集中包含细分值的列的名称。
limit

integer

必需。细分的数量上限。如果设置为零，则应用所有可能的细分。细分列表取决于 sort_order 字段的值。
aggregationFunction

object (AggregationFunction)

必需。聚合函数会应用于创建的每个细分中的所有数据。
sortOrder

enum (SortOrder)

必需。排序顺序会应用于细分列的值。

ColumnSortingOptions

JSON 表示法 
{
  "column": string,
  "direction": enum (SortOrder)
}
字段
column

string

可选。用于对数据进行排序的列名称
direction

enum (SortOrder)

可选。一种排序方向，用于确定升序或降序。这是一个旧版字段，用于保持与表的向后兼容性。

阈值

JSON 表示法 
{
  "label": string,
  "value": number,
  "color": enum (Color),
  "direction": enum (Direction),
  "targetAxis": enum (TargetAxis)
}
字段
label

string

阈值的标签。
value

number

阈值的值。该值应以指标的原始比例定义。
color

enum (Color)

相应阈值的状态颜色。XyChart 中不允许使用颜色。
direction

enum (Direction)

当前阈值的方向。XyChart 中不允许使用方向。
targetAxis

enum (TargetAxis)

用于绘制阈值的目标轴。统计信息摘要中不允许使用目标轴。

Axis

JSON 表示法 
{
  "label": string,
  "scale": enum (Scale)
}
字段
label

string

轴的标签。
scale

enum (Scale)

轴刻度。默认情况下，系统会使用线性比例。

ChartOptions

JSON 表示法 
{
  "mode": enum (Mode),
  "displayHorizontal": boolean
}
字段
mode

enum (Mode)

图表模式。
displayHorizontal

boolean

预览：用于配置图表值是显示在横轴上还是纵轴上。默认情况下，值显示在纵轴上。此功能为预览版，在最终版本发布前可能会发生变化。

统计信息摘要图表

JSON 表示法 
{
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "thresholds": [
    {
      object (Threshold)
    }
  ],
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "measures": [
    {
      object (Measure)
    }
  ],
  "breakdowns": [
    {
      object (Breakdown)
    }
  ],

  // Union field data_view can be only one of the following:
  "gaugeView": {
    object (GaugeView)
  },
  "sparkChartView": {
    object (SparkChartView)
  },
  "blankView": {
    object
  }
  // End of list of possible types for union field data_view.
}
字段
timeSeriesQuery

object (TimeSeriesQuery)

必需。用于从 Stackdriver 指标 API 查询时序数据的字段。
thresholds[]

object (Threshold)

用于根据时序的当前值确定统计信息摘要图表状态的阈值。对于实际值 x，如果 x 小于或等于触发下限的危险阈值，或者大于或等于触发上限的危险阈值，则统计信息摘要图表处于危险状态。同样，如果 x 高于/低于触发“高于”/“低于”的警告阈值，则记分卡处于警告状态，除非 x 也使其处于危险状态。（危险优先于警告。）

例如，假设某个统计信息摘要图表包含以下四个阈值：

{
  value: 90,
  category: 'DANGER',
  trigger: 'ABOVE',
},
{
  value: 70,
  category: 'WARNING',
  trigger: 'ABOVE',
},
{
  value: 10,
  category: 'DANGER',
  trigger: 'BELOW',
},
{
  value: 20,
  category: 'WARNING',
  trigger: 'BELOW',
}

然后：如果值小于或等于 10，则将得分卡置于“危险”状态；如果值大于 10 但小于或等于 20，则置于“警告”状态；如果值严格介于 20 和 70 之间，则置于“正常”状态；如果值大于或等于 70 但小于 90，则置于“警告”状态；如果值大于或等于 90，则置于“危险”状态。
dimensions[]

object (Dimension)

可选。维度是指数据中一组衡量指标的结构化标签、类别或类别。
measures[]

object (Measure)

可选。度量是数据中属性的衡量值。例如，降雨量（以英寸为单位）、售出数量、获得的收入等。
breakdowns[]

object (Breakdown)

可选。要应用于数据集的细分集合。细分维度是一种细分数据的方式。例如，您可以按区域细分数据。
联合字段 data_view。定义得分卡上显示的可选附加图表。如果两者均未包含，则显示默认的记分卡。data_view 只能是下列其中一项：
gaugeView

object (GaugeView)

将导致统计信息摘要图表显示为刻度盘图。
sparkChartView

object (SparkChartView)

将导致统计信息摘要图表显示迷你图。
blankView

object

将导致 Scorecard 仅显示值，而不显示其相对于阈值的值的指示器。

GaugeView

JSON 表示法 
{
  "lowerBound": number,
  "upperBound": number
}
字段
lowerBound

number

此刻度盘图的下限。图表的值应始终大于或等于此值。
upperBound

number

此刻度盘图的上限。图表的值应始终小于或等于此值。

SparkChartView

JSON 表示法 
{
  "sparkChartType": enum (SparkChartType),
  "minAlignmentPeriod": string
}
字段
sparkChartType

enum (SparkChartType)

必需。要在相应 chartView 中显示的迷你图的类型。
minAlignmentPeriod

string (Duration format)

通过指定时序查询中要使用的最短校准时间段，实现图表中数据点频次的下限。例如，如果数据每 10 分钟发布一次，那么以 1 分钟的时间间隔提取和对齐数据就没有意义了。此字段是可选字段，仅作为提示存在。

对于 PromQL 查询，此字段用于设置查询 step 的最小间隔，从而控制数据粒度。较大的值可以提高长时间范围内的性能。如需详细了解 PromQL step，请参阅查询基础知识和范围查询。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

文本

JSON 表示法 
{
  "content": string,
  "format": enum (Format),
  "style": {
    object (TextStyle)
  }
}
字段
content

string

要显示的文本内容。
format

enum (Format)

文本内容的格式。
style

object (TextStyle)

文本的样式

TextStyle

JSON 表示法 
{
  "backgroundColor": string,
  "textColor": string,
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "padding": enum (PaddingSize),
  "fontSize": enum (FontSize),
  "pointerLocation": enum (PointerLocation)
}
字段
backgroundColor

string

以十六进制字符串表示的背景颜色。“#RRGGBB”或“#RGB”
textColor

string

以十六进制字符串表示的文字颜色。“#RRGGBB”或“#RGB”
horizontalAlignment

enum (HorizontalAlignment)

标题和内容的水平对齐方式
verticalAlignment

enum (VerticalAlignment)

标题和内容的垂直对齐方式
padding

enum (PaddingSize)

widget 周围的内边距量
fontSize

enum (FontSize)

标题和内容的字体大小。标题仍会比内容大。
pointerLocation

enum (PointerLocation)

相应 widget 的指针位置（有时也称为“尾部”）

AlertChart

JSON 表示法 
{
  "name": string
}
字段
name

string

必需。提醒政策的资源名称。格式为：

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

TimeSeriesTable

JSON 表示法 
{
  "dataSets": [
    {
      object (TableDataSet)
    }
  ],
  "metricVisualization": enum (MetricVisualization),
  "columnSettings": [
    {
      object (ColumnSettings)
    }
  ]
}
字段
dataSets[]

object (TableDataSet)

必需。此表格中显示的数据。
metricVisualization

enum (MetricVisualization)

可选。商店呈现策略
columnSettings[]

object (ColumnSettings)

可选。表格的持久列设置列表。

TableDataSet

JSON 表示法 
{
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "tableTemplate": string,
  "minAlignmentPeriod": string,
  "tableDisplayOptions": {
    object (TableDisplayOptions)
  }
}
字段
timeSeriesQuery

object (TimeSeriesQuery)

必需。用于从 Stackdriver 指标 API 查询时序数据的字段。
tableTemplate

string

可选。用于在生成的数据集中命名 TimeSeries 的模板字符串。这应该是一个包含 ${label_name} 形式的插值的字符串，该插值将解析为标签的值，即“${resource.labels.project_id}”。
minAlignmentPeriod

string (Duration format)

可选。相应数据集的数据点频次下限，通过指定时序查询中要使用的最短校准时间段来实现。例如，如果数据每 10 分钟发布一次，则 min_alignment_period 应至少为 10 分钟。以 1 分钟的时间间隔提取和对齐数据是没有意义的。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
tableDisplayOptions

object (TableDisplayOptions)

可选。用于配置表格呈现方式的表格显示选项。

TableDisplayOptions

JSON 表示法 
{
  "shownColumns": [
    string
  ]
}
字段
shownColumns[]
(deprecated)

string

可选。此字段未使用，已被 TimeSeriesTable.column_settings 取代

ColumnSettings

JSON 表示法 
{
  "column": string,
  "visible": boolean,
  "alignment": enum (CellAlignment),
  "displayName": string,
  "thresholds": [
    {
      object (Threshold)
    }
  ]
}
字段
column

string

必需。列的 ID。
visible

boolean

必需。列是否应在网页加载时显示。
alignment

enum (CellAlignment)

可选。列应左对齐 / 居中对齐 / 右对齐
displayName

string

可选。列的显示名称
thresholds[]

object (Threshold)

可选。用于确定在给定时序的当前值的情况下，应如何呈现表格单元格的阈值。

CollapsibleGroup

JSON 表示法 
{
  "collapsed": boolean
}
字段
collapsed

boolean

微件在首次网页加载时的折叠状态。

LogsPanel

JSON 表示法 
{
  "filter": string,
  "resourceNames": [
    string
  ]
}
字段
filter

string

用于选择要返回哪些日志条目的过滤条件。请参阅高级日志查询。系统仅返回与过滤条件匹配的日志条目。空过滤条件会匹配所有日志条目。
resourceNames[]

string

要收集日志的日志记录资源的名称。目前支持项目和存储视图。如果为空，则 widget 将默认使用宿主项目。

IncidentList

JSON 表示法 
{
  "monitoredResources": [
    {
      object (MonitoredResource)
    }
  ],
  "policyNames": [
    string
  ]
}
字段
monitoredResources[]

object (MonitoredResource)

可选。列出突发事件的受监控的资源。无需完全指定资源。也就是说，您可以指定资源类型，但不能指定资源标签的值。资源类型和标签用于过滤。
policyNames[]

string

可选。用于按提醒政策名称过滤突发事件列表的列表。请勿在政策名称中包含项目 ID 前缀。例如，使用 alertPolicies/utilization。

MonitoredResource

JSON 表示法 
{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
字段
type

string

必需。受监控的资源类型。此字段必须与 MonitoredResourceDescriptor 对象的 type 字段匹配。例如，Compute Engine 虚拟机实例的类型为 gce_instance。如需查看类型列表，请参阅监控资源类型和日志记录资源类型。
labels

map (key: string, value: string)

必需。关联的受监控资源描述符中列出的所有标签的值。例如，Compute Engine 虚拟机实例使用标签 "project_id"、"instance_id" 和 "zone"。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

LabelsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string
value

string

PieChart

JSON 表示法 
{
  "dataSets": [
    {
      object (PieChartDataSet)
    }
  ],
  "chartType": enum (PieChartType),
  "showLabels": boolean
}
字段
dataSets[]

object (PieChartDataSet)

必需。图表数据的查询。
chartType

enum (PieChartType)

必需。指明饼图的可视化图表类型。
showLabels

boolean

可选。指示饼图是否应显示切片的标签

PieChartDataSet

JSON 表示法 
{
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "sliceNameTemplate": string,
  "minAlignmentPeriod": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "measures": [
    {
      object (Measure)
    }
  ]
}
字段
timeSeriesQuery

object (TimeSeriesQuery)

必需。饼图的查询。请参阅 google.monitoring.dashboard.v1.TimeSeriesQuery。
sliceNameTemplate

string

可选。切片名称的模板。此名称将显示在饼图的图例和工具提示中。它会替换分片的自动生成的名称。例如，如果模板设置为 ${resource.labels.zone}，则系统会使用相应地区的价值作为名称，而不是默认名称。
minAlignmentPeriod

string (Duration format)

可选。相应数据集的数据点频次下限，通过指定在时序查询中使用的最短对齐周期来实现。例如，如果数据每 10 分钟发布一次，则 min_alignment_period 应至少为 10 分钟。以 1 分钟的时间间隔提取和对齐数据是没有意义的。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
dimensions[]

object (Dimension)

维度是指数据中一组衡量指标的结构化标签、类别或类别。
measures[]

object (Measure)

度量是数据中属性的衡量值。例如，降雨量（以英寸为单位）、售出数量、获得的收入等。

树状图

JSON 表示法 
{
  "dataSets": [
    {
      object (TreemapDataSet)
    }
  ],
  "treemapHierarchy": [
    string
  ]
}
字段
dataSets[]

object (TreemapDataSet)

必需。用于构建和填充树状图的数据集集合。对于渲染的树状图矩形：

  • 颜色由每个分组的汇总值决定。
  • 大小与相应矩形段内汇总的时序数量成正比。
treemapHierarchy[]

string

必需。表示分层树状图结构的有序标签。

TreemapDataSet

JSON 表示法 
{
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "measures": [
    {
      object (Measure)
    }
  ],
  "breakdowns": [
    {
      object (Breakdown)
    }
  ]
}
字段
timeSeriesQuery

object (TimeSeriesQuery)

必需。用于提取相关数据的查询。查看google.monitoring.dashboard.v1.TimeSeriesQuery
measures[]

object (Measure)

可选。一组衡量指标。度量是数据中属性的衡量值。例如，降雨量（以英寸为单位）、售出数量、获得的收入等。
breakdowns[]

object (Breakdown)

可选。要应用于数据集的细分集合。细分维度是一种细分数据的方式。例如，您可以按区域细分数据。

ErrorReportingPanel

JSON 表示法 
{
  "projectNames": [
    string
  ],
  "services": [
    string
  ],
  "versions": [
    string
  ]
}
字段
projectNames[]

string

Google Cloud Platform 项目的资源名称。以 projects/{projectID} 或 projects/{projectNumber} 的形式写入，其中 {projectID} 和 {projectNumber} 可在 Google Cloud 控制台中找到。

示例：projects/my-project-123、projects/5551234。
services[]

string

服务的标识符，例如可执行文件、作业或 Google App Engine 服务名称的名称。与 version 不同，此字段的值数量预计较少，并且会随着时间的推移保持相对稳定，而 version 可以在每次部署新代码时进行更改。

包含从 Google App Engine 日志中提取的错误报告的服务名称，如果使用 App Engine 默认服务，则为 default。
versions[]

string

表示开发者提供的源代码版本，例如版本标签或 Git SHA-1 哈希。对于 App Engine 标准环境，版本设置为应用的相应版本。

SectionHeader

JSON 表示法 
{
  "subtitle": string,
  "dividerBelow": boolean
}
字段
subtitle

string

相应部分的副标题
dividerBelow

boolean

是否在目录中的相应部分下方插入分隔线

SingleViewGroup

JSON 表示法 
{
  "displayType": enum (DisplayType)
}
字段
displayType

enum (DisplayType)

可选。确定 widget 选择器的显示方式。

FilterControl

JSON 表示法 
{
  "templateVariable": string
}
字段
templateVariable

string

微件影响的模板变量的名称。

VisibilityCondition

JSON 表示法 
{
  "templateVariableCondition": {
    object (TemplateVariableCondition)
  }
}
字段
templateVariableCondition

object (TemplateVariableCondition)

一种评估基于模板变量值的条件。

TemplateVariableCondition

JSON 表示法 
{
  "templateVariable": string,
  "templateVariableValue": string,
  "comparator": enum (Comparator)
}
字段
templateVariable

string

要评估其值的模板变量。
templateVariableValue

string

用于与模板变量进行比较的值。例如，如果比较器为 REGEX_FULL_MATCH，则此字段应包含正则表达式。
comparator

enum (Comparator)

用于评估模板变量的值是否与 template_variable_value 相匹配的比较器。例如，如果比较器为 REGEX_FULL_MATCH，则 template_variable_value 将包含一个与模板变量值匹配的正则表达式。

MosaicLayout

JSON 表示法 
{
  "columns": integer,
  "tiles": [
    {
      object (Tile)
    }
  ]
}
字段
columns

integer

马赛克网格中的列数。列数必须介于 1 到 48 之间（含首尾）。
tiles[]

object (Tile)

要显示的板块。

模块

JSON 表示法 
{
  "xPos": integer,
  "yPos": integer,
  "width": integer,
  "height": integer,
  "widget": {
    object (Widget)
  }
}
字段
xPos

integer

相应功能块在网格块中的位置（从零开始的索引），相对于网格的左边缘。平铺必须包含在指定列数内。x_pos不能为负数。
yPos

integer

网格块中图块相对于网格顶边的从零开始的索引位置。y_pos不能为负数。
width

integer

图块的宽度（以网格块为单位）。平铺的宽度必须至少为 1。
height

integer

相应功能块的高度，以网格块为单位。图块的最小高度必须为 1。
widget

object (Widget)

功能块中包含的信息类 widget。例如 XyChart。

RowLayout

JSON 表示法 
{
  "rows": [
    {
      object (Row)
    }
  ]
}
字段
rows[]

object (Row)

要显示的内容行。

行

JSON 表示法 
{
  "weight": string,
  "widgets": [
    {
      object (Widget)
    }
  ]
}
字段
weight

string (int64 format)

相应行的相对权重。行权重用于调整屏幕上各行的高度（相对于同级元素）。权重越大，相应行的屏幕高度就越大。如果省略，则在渲染时使用值 1。
widgets[]

object (Widget)

此行中水平排列的显示微件。

ColumnLayout

JSON 表示法 
{
  "columns": [
    {
      object (Column)
    }
  ]
}
字段
columns[]

object (Column)

要显示的内容列。

列

JSON 表示法 
{
  "weight": string,
  "widgets": [
    {
      object (Widget)
    }
  ]
}
字段
weight

string (int64 format)

相应列的相对权重。列权重用于调整屏幕上列的宽度（相对于同级列）。权重越大，屏幕上相应列的宽度就越大。如果省略，则在渲染时使用值 1。
widgets[]

object (Widget)

此列中垂直排列的显示微件。

DashboardFilter

JSON 表示法 
{
  "labelKey": string,
  "templateVariable": string,
  "valueType": enum (ValueType),
  "filterType": enum (FilterType),

  // Union field default_value can be only one of the following:
  "stringValue": string,
  "stringArrayValue": {
    object (StringArray)
  }
  // End of list of possible types for union field default_value.

  // Union field value_source can be only one of the following:
  "timeSeriesQuery": {
    object (TimeSeriesQuery)
  },
  "stringArray": {
    object (StringArray)
  }
  // End of list of possible types for union field value_source.
}
字段
labelKey

string

可选。标签的键。如果 filter_type 为 VALUE_ONLY，则必须省略此字段；否则，必须提供此字段。
templateVariable

string

可在过滤条件字符串或 MQL 查询中引用的占位文本。如果省略，信息中心过滤条件将应用于信息中心内的所有相关 widget。
valueType

enum (ValueType)

过滤条件值的类型。如果未提供 value_type，系统将根据 default_value 推断出 value_type。如果未提供 value_type 和 default_value，则 value_type 将默认设置为 STRING。
filterType

enum (FilterType)

指定的过滤条件类型
联合字段 default_value。过滤比较 default_value 中使用的默认值只能是以下值之一：
stringValue

string

长度可变的字符串值。如果设置了此字段，则必须将 value_type 设置为 STRING 或 VALUE_TYPE_UNSPECIFIED
stringArrayValue

object (StringArray)

长度可变的字符串值数组。如果设置了此字段，则必须将 value_type 设置为 STRING_ARRAY 或 VALUE_TYPE_UNSPECIFIED
联合字段 value_source。过滤条件的有效值集的定义。此为可选操作，但建议用于 VALUE_ONLY 过滤条件。对于其他过滤条件类型，系统会根据图表中的数据推断有效值集。value_source 只能是下列其中一项：
timeSeriesQuery

object (TimeSeriesQuery)

用于运行以提取过滤条件的可能值的查询。仅支持 OpsAnalyticsQueries
stringArray

object (StringArray)

过滤条件的可能字符串值列表

StringArray

JSON 表示法 
{
  "values": [
    string
  ]
}
字段
values[]

string

数组的值

LabelsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string
value

string

DashboardAnnotations

JSON 表示法 
{
  "defaultResourceNames": [
    string
  ],
  "eventAnnotations": [
    {
      object (EventAnnotation)
    }
  ]
}
字段
defaultResourceNames[]

string

信息中心级默认值，用于指定要搜索事件的日志记录资源的名称。目前仅支持项目。每个单独的 EventAnnotation 可能都有自己的替换项。如果此字段和每个注解字段均为空，则使用范围界定项目。上限：50 个项目。例如：

“projects/some-project-id”
eventAnnotations[]

object (EventAnnotation)

相应信息中心的注解配置列表。每个条目指定一种事件类型。

EventAnnotation

JSON 表示法 
{
  "displayName": string,
  "eventType": enum (EventType),
  "filter": string,
  "enabled": boolean,
  "resourceNames": [
    string
  ]
}
字段
displayName

string

仅用于界面显示。不应以编程方式使用。
eventType

enum (EventType)

要显示的事件类型。
filter

string

用于过滤事件的字符串 - 取决于事件。示例值：

"resource.labels.pod_name = 'pod-1'"
"protoPayload.authenticationInfo.principalEmail='user@example.com'"
enabled

boolean

是否默认在信息中心内显示事件
resourceNames[]

string

针对要搜索的日志记录资源名称的每个注解级替换。目前仅支持项目。如果此字段和每个注解字段均为空，则默认使用宿主项目。上限：50 个项目。例如：

“projects/another-project-id”

校准器

Aligner 用于指定将应用于时序中每个校准时间段内的数据点的操作。除了 ALIGN_NONE（指定不应用任何操作）之外，每种对齐操作都会将每个对齐周期内的一组数据值替换为一个值：将相应操作应用于数据值的结果。校准后的时序在每个 alignment_period 结束时都有一个数据值。

对齐操作也可以更改值的数据类型。例如，如果您对布尔值应用计数操作，则原始时序中的数据 value_type 为 BOOLEAN，但对齐结果中的 value_type 为 INT64。

枚举
ALIGN_NONE 不对齐。返回原始数据。如果请求了跨序列缩减，则无效。结果的 value_type 与输入的 value_type 相同。
ALIGN_DELTA

对齐并转换为 DELTA。输出为 delta = y1 - y0。

此对齐方式适用于 CUMULATIVE 和 DELTA 指标。如果所选的对齐周期导致某些周期没有数据，则系统会通过插值来创建相应周期的对齐值。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_RATE

对齐并转换为速率。计算结果为 rate = (y1 - y0)/(t1 - t0)，即“随时间的变化量”。可以将此对齐器视为提供通过 alignment_period 开头和结尾处的值的直线的斜率。

此校准器适用于具有数值的 CUMULATIVE 和 DELTA 指标。如果所选的对齐周期导致某些周期没有数据，则系统会通过插值来创建相应周期的对齐值。输出是一个 GAUGE 指标，具有 value_type DOUBLE。

如果您所说的“比率”是指“百分比变化”，请改用 ALIGN_PERCENT_CHANGE 对齐器。
ALIGN_INTERPOLATE 通过在校准时间段边界周围的相邻点之间插值来进行对齐。此校准器适用于具有数值的 GAUGE 指标。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_NEXT_OLDER 通过将校准时间段结束前的最近的数据点移动到校准时间段结束时的边界来校准数据点。此对齐器适用于 GAUGE 个指标。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_MIN 通过返回每个校准时间段中的最小值来校准时序。此校准器适用于具有数值的 GAUGE 和 DELTA 指标。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_MAX 通过返回每个校准时间段中的最大值来校准时序。此校准器适用于具有数值的 GAUGE 和 DELTA 指标。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_MEAN 通过返回每个校准时间段中的平均值来校准时序。此校准器适用于具有数值的 GAUGE 和 DELTA 指标。校准后结果的 value_type 为 DOUBLE。
ALIGN_COUNT 通过返回每个校准时间段中的值的数量来校准时序。此校准器适用于具有数值或布尔值的 GAUGE 和 DELTA 指标。校准后结果的 value_type 为 INT64。
ALIGN_SUM 通过返回每个校准时间段中的值之和来校准时序。此校准器适用于具有数值和分布值的 GAUGE 和 DELTA 指标。对齐后结果的 value_type 与输入的 value_type 相同。
ALIGN_STDDEV 通过返回每个校准时间段中的值的标准差来校准时序。此校准器适用于具有数值的 GAUGE 和 DELTA 指标。输出的 value_type 为 DOUBLE。
ALIGN_COUNT_TRUE 通过返回每个校准时间段中的 True 值数量来校准时序。此校准器适用于具有布尔值的 GAUGE 指标。输出的 value_type 为 INT64。
ALIGN_COUNT_FALSE 通过返回每个校准时间段中的 False 值数量来校准时序。此校准器适用于具有布尔值的 GAUGE 指标。输出的 value_type 为 INT64。
ALIGN_FRACTION_TRUE 通过返回每个校准时间段中 True 值数量与值总数的比率来校准时序。此校准器适用于具有布尔值的 GAUGE 指标。输出值在 [0.0, 1.0] 范围内，且具有 value_type DOUBLE。
ALIGN_PERCENTILE_99 使用百分位聚合校准时序。每个校准时间段内生成的数据点是该时间段内所有数据点的第 99 个百分位。此校准器适用于具有分布值的 GAUGE 和 DELTA 指标。输出是一个 GAUGE 指标，具有 value_type DOUBLE。
ALIGN_PERCENTILE_95 使用百分位聚合校准时序。每个校准时间段内生成的数据点是该时间段内所有数据点的第 95 个百分位。此校准器适用于具有分布值的 GAUGE 和 DELTA 指标。输出是一个 GAUGE 指标，具有 value_type DOUBLE。
ALIGN_PERCENTILE_50 使用百分位聚合校准时序。每个校准时间段内生成的数据点是该时间段内所有数据点的第 50 个百分位。此校准器适用于具有分布值的 GAUGE 和 DELTA 指标。输出是一个 GAUGE 指标，具有 value_type DOUBLE。
ALIGN_PERCENTILE_05 使用百分位聚合校准时序。每个校准时间段内生成的数据点是该时间段内所有数据点的第 5 个百分位。此校准器适用于具有分布值的 GAUGE 和 DELTA 指标。输出是一个 GAUGE 指标，具有 value_type DOUBLE。
ALIGN_PERCENT_CHANGE

对齐并转换为百分比变化。此校准器适用于具有数值的 GAUGE 和 DELTA 指标。此对齐方式会返回 ((current - previous)/previous) * 100，其中 previous 的值是根据 alignment_period 确定的。

如果 current 和 previous 的值均为 0，则返回的值为 0。如果只有 previous 为 0，则返回值为无穷大。

在上述计算之前，系统会在对齐周期的每个点计算 10 分钟的移动平均值，以平滑指标并防止因非常短暂的峰值而出现误报。移动平均值仅适用于值为 >= 0 的数据。任何 < 0 值都被视为缺失数据点，并会被忽略。虽然此对齐方式接受 DELTA 指标，但应特别注意，该指标的值始终为正数。输出是一个 GAUGE 指标，具有 value_type DOUBLE。

缩减器

Reducer 操作描述了如何将多个时序中的数据点聚合为单个时序，其中结果序列中每个数据点的值是输入时序中所有已对齐的值的函数。

枚举
REDUCE_NONE 无跨时序缩减。返回 Aligner 的输出。
REDUCE_MEAN 通过计算每个校准时间段内时序的平均值进行缩减。此缩减器适用于具有数值或分布值的 DELTA 和 GAUGE 指标。输出的 value_type 为 DOUBLE。
REDUCE_MIN 通过计算每个校准时间段内时序的最小值进行缩减。此精简器适用于具有数值的 DELTA 和 GAUGE 指标。输出的 value_type 与输入的 value_type 相同。
REDUCE_MAX 通过计算每个校准时间段内时序的最大值进行缩减。此精简器适用于具有数值的 DELTA 和 GAUGE 指标。输出的 value_type 与输入的 value_type 相同。
REDUCE_SUM 通过计算每个校准时间段的时序的总和进行缩减。此缩减器适用于具有数值和分布值的 DELTA 和 GAUGE 指标。输出的 value_type 与输入的 value_type 相同。
REDUCE_STDDEV 通过计算每个校准时间段的时序标准差进行缩减。此缩减器适用于具有数值或分布值的 DELTA 和 GAUGE 指标。输出的 value_type 为 DOUBLE。
REDUCE_COUNT 通过计算每个校准时间段内各个时序的数据点数量进行缩减。此缩减器适用于数值、布尔值、分布和字符串 value_type 的 DELTA 和 GAUGE 指标。输出的 value_type 为 INT64。
REDUCE_COUNT_TRUE 通过计算每个校准时间段内时序中 True 值数据点的数量进行缩减。此归约器适用于布尔值 value_type 的 DELTA 和 GAUGE 指标。输出的 value_type 为 INT64。
REDUCE_COUNT_FALSE 通过计算每个校准时间段内时序中 False 值数据点的数量进行缩减。此归约器适用于布尔值 value_type 的 DELTA 和 GAUGE 指标。输出的 value_type 为 INT64。
REDUCE_FRACTION_TRUE 通过计算每个校准时间段内值为 True 的数据点数量与数据点总数的比率进行缩减。此归约器适用于布尔值 value_type 的 DELTA 和 GAUGE 指标。输出值在 [0.0, 1.0] 范围内，且具有 value_type DOUBLE。
REDUCE_PERCENTILE_99 通过计算每个校准时间段内各个时序的数据点的第 99 个百分位进行缩减。此缩减器适用于数值型和分布型 GAUGE 和 DELTA 指标。输出的值为 DOUBLE。
REDUCE_PERCENTILE_95 通过计算每个校准时间段内各时序的数据点的第 95 百分位进行缩减。此缩减器适用于数值型和分布型 GAUGE 和 DELTA 指标。输出的值为 DOUBLE。
REDUCE_PERCENTILE_50 通过计算每个校准时间段内各个时序的数据点的第 50 百分位进行缩减。此缩减器适用于数值型和分布型 GAUGE 和 DELTA 指标。输出的值为 DOUBLE。
REDUCE_PERCENTILE_05 通过计算每个校准时间段内各个时序的数据点的第 5 个百分位进行缩减。此缩减器适用于数值型和分布型 GAUGE 和 DELTA 指标。输出的值为 DOUBLE。

方法

可应用于 PickTimeSeriesFilter 的值归约器。

枚举
METHOD_UNSPECIFIED 不允许。如果您指定了 PickTimeSeriesFilter，则必须指定其他 Method。
METHOD_MEAN 选择所有值的平均值。
METHOD_MAX 选择最大值。
METHOD_MIN 选择最小值。
METHOD_SUM 计算所有值的总和。
METHOD_LATEST 选择最新值。

方向

描述排名方向。

枚举
DIRECTION_UNSPECIFIED 不允许。如果您指定了 PickTimeSeriesFilter，则必须指定其他 Direction。
TOP 传递最高 num_time_series 排名输入。
BOTTOM 传递最低 num_time_series 排名输入。

方法

可应用于数据流的过滤方法。

枚举
METHOD_UNSPECIFIED 在格式正确的请求中不允许使用。
METHOD_CLUSTER_OUTLIER 计算每个视频流的离群值得分。

SpanDataValue

用于确定图表上显示的数据的不同时间跨度数据值的列表

枚举
SPAN_DATA_VALUE_UNSPECIFIED 我们必须为枚举提供 UNSPECIFIED 值。在实践中不应使用此方法。
SPAN_COUNT 跨度数数据值
SPAN_DURATION span 时长数据值
SPAN_DURATION_PERCENTILES span 时长百分位数值

PlotType

数据集的绘图策略类型。

枚举
PLOT_TYPE_UNSPECIFIED 地块类型未指定。视图将默认为 LINE。
LINE 数据以一组折线的形式绘制（每个序列一条折线）。
STACKED_AREA 数据以一组填充区域（每个序列一个区域）的形式绘制，这些区域垂直堆叠（每个区域的底部是其前一个区域的顶部，第一个区域的底部是 x 轴）。由于这些区域不重叠，因此每个区域都填充了不同的不透明颜色。
STACKED_BAR 数据以一组矩形框（每个序列一个框）的形式绘制，这些框垂直堆叠（每个框的底部是其前一个框的顶部，第一个框的底部是 x 轴）。由于这些框不重叠，因此每个框都填充了不同的不透明颜色。
HEATMAP 数据以热图的形式绘制。绘制的序列必须具有 DISTRIBUTION 值类型。分布中每个分桶的值都以颜色显示。Stackdriver Monitoring 应用目前不支持此类型。

TargetAxis

轴标识符。

枚举
TARGET_AXIS_UNSPECIFIED 未指定目标轴。默认值为 Y1。
Y1 y_axis（图表的右轴）。
Y2 y2_axis（图表的左轴）。

SortOrder

排序顺序选项。

枚举
SORT_ORDER_UNSPECIFIED 未指定的排序顺序。如果需要排序，此选项无效。
SORT_ORDER_NONE 未应用任何排序。
SORT_ORDER_ASCENDING 系统会先选择价值最低的条目。
SORT_ORDER_DESCENDING 系统会先选择价值最高的条目。

颜色

当实际值超过阈值时，颜色会向观看者提示一种解读。每种颜色对应的注释都提供了用户体验指南，说明用户可能会如何解读给定的状态颜色。

枚举
COLOR_UNSPECIFIED 颜色未指定。在格式正确的请求中不允许使用。
YELLOW 超过阈值属于“令人担忧”的行为。
RED 超过阈值属于“紧急”行为。

方向

实际值高于或低于阈值时，是否视为已达到阈值。

枚举
DIRECTION_UNSPECIFIED 在格式正确的请求中不允许使用。
ABOVE 如果实际值高于阈值，则视为已超过阈值。
BELOW 如果实际值低于阈值，则视为已达到阈值。

TargetAxis

轴标识符。

枚举
TARGET_AXIS_UNSPECIFIED 未指定目标轴。默认值为 Y1。
Y1 y_axis（图表的右轴）。
Y2 y2_axis（图表的左轴）。

扩缩

轴中使用的比例类型。

枚举
SCALE_UNSPECIFIED 未指定比例。视图将默认为 LINEAR。
LINEAR 线性比例。
LOG10 对数刻度（以 10 为底）。

模式

图表模式选项。

枚举
MODE_UNSPECIFIED 模式未指定。视图将默认为 COLOR。
COLOR 图表使用不同的颜色来区分数据系列。如果图表中的线条过多，线条颜色可能会重复使用。
X_RAY 此图表使用 Stackdriver X-ray 模式，其中每个数据集都使用相同的半透明颜色绘制。
STATS 该图表会显示平均值、中位数、第 95 百分位等统计信息。

SparkChartType

定义 Scorecard 支持的可能的迷你图类型。

枚举
SPARK_CHART_TYPE_UNSPECIFIED 在格式正确的请求中不允许使用。
SPARK_LINE 火花谱线将渲染为小型折线图。
SPARK_BAR 迷你条形图将渲染为小型条形图。

格式

文本内容的格式类型。

枚举
FORMAT_UNSPECIFIED 未指定格式。默认值为 MARKDOWN。
MARKDOWN 文本包含 Markdown 格式。
RAW 文本不包含任何特殊格式。

HorizontalAlignment

文本 widget 上标题和内容的水平对齐方式

枚举
HORIZONTAL_ALIGNMENT_UNSPECIFIED 未指定水平对齐方式，将默认为 H_LEFT
H_LEFT 左对齐
H_CENTER 居中对齐
H_RIGHT 右对齐

VerticalAlignment

文本 widget 上标题和内容的垂直对齐方式

枚举
VERTICAL_ALIGNMENT_UNSPECIFIED 未指定垂直对齐方式，将默认为 V_TOP
V_TOP 顶部对齐
V_CENTER 居中对齐
V_BOTTOM 底部对齐

PaddingSize

指定文本 widget 周围的内边距大小

枚举
PADDING_SIZE_UNSPECIFIED 未指定边衬区大小，将默认为 P_EXTRA_SMALL
P_EXTRA_SMALL 特小内边距
P_SMALL 小内边距
P_MEDIUM 中等内边距
P_LARGE 较大边衬区
P_EXTRA_LARGE 超大内边距

FontSize

为文本 widget 的标题和内容指定字体大小

枚举
FONT_SIZE_UNSPECIFIED 未指定字体大小，将默认为 FS_LARGE
FS_EXTRA_SMALL 特小字号
FS_SMALL 字体过小
FS_MEDIUM 中等字号
FS_LARGE 字体过大
FS_EXTRA_LARGE 超大字号

PointerLocation

指定视觉指针在文本 widget 上的放置位置（有时也称为“尾部”）

枚举
POINTER_LOCATION_UNSPECIFIED 无视觉指针
PL_TOP 放置在 widget 顶部中间位置
PL_RIGHT 放置在微件右侧的中间位置
PL_BOTTOM 放置在 widget 底部的中间位置
PL_LEFT 放置在 widget 左侧的中间位置
PL_TOP_LEFT 放置在 widget 顶部左侧
PL_TOP_RIGHT 位于 widget 顶部右侧
PL_RIGHT_TOP 位于微件右侧顶部
PL_RIGHT_BOTTOM 放置在 widget 右侧底部
PL_BOTTOM_RIGHT 放置在 widget 底部的右侧
PL_BOTTOM_LEFT 放置在 widget 底部的左侧
PL_LEFT_BOTTOM 放置在 widget 左侧的底部
PL_LEFT_TOP 放置在 widget 左侧的顶部

MetricVisualization

指标 metric_visualization 的枚举

枚举
METRIC_VISUALIZATION_UNSPECIFIED 未指定状态
NUMBER 默认文本呈现
BAR 水平条形图渲染

CellAlignment

相应列中表格单元格的水平对齐方式

枚举
CELL_ALIGNMENT_UNSPECIFIED 未指定水平对齐方式；回退到默认行为。标签值左对齐。数值会右对齐。
LEFT 左对齐
CENTER 居中对齐
RIGHT 右对齐

PieChartType

饼图的类型。

枚举
PIE_CHART_TYPE_UNSPECIFIED 零值。未指定类型。请勿使用。
PIE 饼图类型的饼图。
DONUT 与 PIE 类似，但 DONUT 类型的饼图中间有一个孔。

DisplayType

一种类型，用于指示 widget 选择器的显示方式。

枚举
DISPLAY_TYPE_UNSPECIFIED 未指定显示屏类型，默认为下拉菜单。
DROPDOWN 将 widget 选择器呈现为下拉菜单。
TAB 将 widget 选择器呈现为标签页列表。

比较条件

用于评估模板变量值是否匹配的比较器选项。

枚举
COMPARATOR_UNSPECIFIED 未指定比较器。默认行为为 REGEX_FULL_MATCH。
REGEX_FULL_MATCH 当模板变量的值与指定的正则表达式匹配时，使用此比较器的条件的评估结果为 true。

ValueType

过滤条件值的类型

枚举
VALUE_TYPE_UNSPECIFIED 值类型未指定
STRING 字符串类型
STRING_ARRAY 字符串数组类型

FilterType

信息中心过滤器的类型

枚举
FILTER_TYPE_UNSPECIFIED 过滤条件类型未指定。在格式正确的请求中，此值无效。
RESOURCE_LABEL 按资源标签值过滤
METRIC_LABEL 按指标标签值过滤
USER_METADATA_LABEL 按用户元数据标签值过滤
SYSTEM_METADATA_LABEL 按系统元数据标签值过滤
GROUP 按群组 ID 过滤
VALUE_ONLY 仅包含值的过滤条件。对于此类过滤条件，必须取消设置 label_key 字段。

EventType

预定义的事件类型。

枚举
EVENT_TYPE_UNSPECIFIED 未指定事件类型。
GKE_WORKLOAD_DEPLOYMENT GKE 工作负载的补丁/更新。
GKE_POD_CRASH GKE Pod 的崩溃事件。
GKE_POD_UNSCHEDULABLE GKE Pod 的调度失败。
GKE_CONTAINER_CREATION_FAILED 无法创建 GKE 容器。
GKE_CLUSTER_CREATE_DELETE 创建/删除 GKE 集群。
GKE_CLUSTER_UPDATE GKE 集群的更新。
GKE_NODE_POOL_UPDATE GKE 节点池的更新。
GKE_CLUSTER_AUTOSCALER GKE 集群自动扩缩器事件。
GKE_POD_AUTOSCALER GKE Pod 自动扩缩器事件。
VM_TERMINATION 虚拟机的终止。
VM_GUEST_OS_ERROR 虚拟机上出现客户机操作系统错误。
VM_START_FAILED 虚拟机上的启动失败。
MIG_UPDATE 代管式实例组的更新。
MIG_AUTOSCALER 代管式实例组的自动扩缩器事件。
CLOUD_RUN_DEPLOYMENT 新部署的 Cloud Run 服务。
CLOUD_SQL_FAILOVER Cloud SQL 实例的故障切换。
CLOUD_SQL_START_STOP Cloud SQL 实例的启动/停止。
CLOUD_SQL_STORAGE Cloud SQL 实例的存储事件。
UPTIME_CHECK_FAILURE Cloud Monitoring 拨测失败。
CLOUD_ALERTING_ALERT Cloud Alerting 发出的提醒
SERVICE_HEALTH_INCIDENT Service Health 中的突发事件
SAP_BACKINT 与 Agent for SAP Backint 相关的事件。
SAP_AVAILABILITY 与 Agent for SAP 可用性相关的事件。
SAP_OPERATIONS 与 Agent for SAP 操作相关的事件。
INTERCONNECT_MAINTENANCE_STARTED 互连维护开始事件。
INTERCONNECT_MAINTENANCE_COMPLETED 互连维护完成事件。
VPN_TRAFFIC_SELECTOR_NARROWING VPN 流量选择器缩小范围事件。
VPN_MAINTENANCE VPN 维护事件。

工具注释

破坏性提示：❌ | 等幂性提示：✅ | 只读提示：✅ | 开放世界提示：❌