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 MCP tool 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

ID。資訊主頁的資源名稱。

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)

內容會以基本版面配置排列,重新排列簡單的資訊元素清單,例如小工具或資訊方塊。

mosaicLayout

object (MosaicLayout)

內容會以方塊格線排列,每個內容小工具會佔用一或多個格線方塊。

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)
  },
  "timeRange": {
    object (TimeRange)
  },

  // 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

選用。小工具 ID。ID 可以由英數字元、破折號和底線組成。小工具 ID 為選填項目。

visibilityCondition

object (VisibilityCondition)

選用。如果設定了這項屬性,只有在條件評估結果為 true 時,系統才會算繪這個小工具。

timeRange

object (TimeRange)

選用。代表小工具的時間範圍。設定後,這個時間範圍會覆寫資訊主頁的時間範圍。僅支援折線、堆疊面積和堆疊長條圖小工具。

聯集欄位 content。內容會定義用於填入小工具的元件。content 只能是下列其中一個設定:
xyChart

object (XyChart)

時間序列資料圖表。

scorecard

object (Scorecard)

匯總時間序列資料的評量表。

text

object (Text)

顯示文字內容的原始字串或 Markdown。

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)

這個小工具會顯示輸入欄位,方便您變更範本變數的值。

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)

用於顯示比較圖的時長。比較圖會同時顯示兩個長度相近時間範圍的值 (例如每週指標)。時間範圍必須為正數,且只能套用至資料集為折線圖類型的圖表。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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 分鐘。以一分鐘為間隔擷取及對齊資料並不合理。

如果是 PromQL 查詢,這個欄位可用於設定查詢 step 的最短間隔,藉此控管資料精細程度。較大的值可提升較長時間範圍的效能。如要進一步瞭解 PromQL step,請參閱查詢基礎和範圍查詢。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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 會將完整查詢時間視為對齊週期,因此只會產生 1 個輸出值。

*注意:這可能會覆寫設定的對齊週期,但預期會有一連串資料點的情況除外,例如:- 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 週。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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,且不得等於 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

時間跨度以奈秒為單位的正負秒數。如果時間長度不到一秒,系統會以 0 seconds 欄位和正數或負數 nanos 欄位表示。如果時間長度為一秒以上,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 正規化,並使用 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 正規化,並使用 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)

代表自 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)

要在圖表上顯示的範圍資料值類型。必填。

spanFilters

object (SpanFilters)

我們支援的第一個跨度篩選版本。必填。

resourceContainer

string

選用。要從中擷取資料的專案或 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

選用。篩選包含清單中其中一項服務的範圍。多個值會以 OR 邏輯合併。

displayNames[]

string

選用。篩選包含清單中任一時距顯示名稱的時距。多個值會以 OR 邏輯合併。

status[]

string

選用。篩選包含清單中任一狀態的範圍。多個值會以 OR 邏輯合併。

kinds[]

string

選用。篩選包含清單中其中一種範圍的範圍。多個值會以 OR 邏輯合併。

minDuration

string (Duration format)

選用。篩選出最短時間範圍。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「s」結尾,例如:"3.5s"。

maxDuration

string (Duration format)

選用。篩選時長上限的範圍。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「s」結尾,例如:"3.5s"。

attributes[]

object (SpanAttributeFilter)

選用。跨度屬性篩選條件清單。每個 SpanAttributeFilter 鍵不得重複。多個屬性篩選器會以 AND 組成交集。

isRootSpan

boolean

選用。如果設為 true,則只會篩選根範圍。根時距是指未定義父項時距 ID 的時距。

applicationIds[]

string

選用。篩選包含清單中任一 Apphub 應用程式 ID 的範圍。多個值會以 OR 邏輯合併。

apphubServices[]

string

選用。篩選包含清單中任一 Apphub 服務 ID 的範圍。多個值會以 OR 邏輯合併。例如:["service-id1", "service-id2"]

apphubWorkloads[]

string

選用。篩選包含清單中任一 Apphub 工作負載 ID 的範圍。多個值會以 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 查詢的小工具,則會限制要產生的資料箱數量。如果指定 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 小時。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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"。匯總函式用於將點分組到維度區間。

AggregationFunction

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 也會使評分表處於危險狀態。(危險情況優先於警告)。

舉例來說,假設評分表有下列四個門檻:

{
  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 分鐘發布一次,以一分鐘為間隔擷取及對齊資料就沒有意義。這個欄位為選填,僅做為提示。

如果是 PromQL 查詢,這個欄位可用於設定查詢 step 的最短間隔,藉此控管資料精細程度。較大的值可提升較長時間範圍的效能。如要進一步瞭解 PromQL step,請參閱查詢基礎和範圍查詢。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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)

小工具周圍的邊框間距大小

fontSize

enum (FontSize)

標題和內容的字型大小。標題仍會比內容大。

pointerLocation

enum (PointerLocation)

這個小工具的指標位置 (有時也稱為「尾端」)

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 分鐘。以一分鐘為間隔擷取及對齊資料並不合理。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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

要收集記錄的記錄資源名稱。目前支援專案和儲存空間檢視畫面。如果留空,小工具預設會使用主專案。

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 VM 執行個體的類型為 gce_instance。如需類型清單,請參閱「監控資源類型」和「記錄資源類型」。

labels

map (key: string, value: string)

這是必要旗標,相關聯的受監控資源描述元中列出的所有標籤的值。舉例來說,Compute Engine VM 執行個體會使用 "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)

這是必要旗標,指出 PieChart 的視覺化類型。

showLabels

boolean

選用。指出圓餅圖是否應顯示切片標籤

PieChartDataSet

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

object (TimeSeriesQuery)

這是必要旗標,PieChart 的查詢。詳情請參閱google.monitoring.dashboard.v1.TimeSeriesQuery。

sliceNameTemplate

string

選用。切片名稱的範本。這個名稱會顯示在圓餅圖的圖例和工具提示中。並取代自動產生的切片名稱。舉例來說,如果範本設為 ${resource.labels.zone},系統會使用區域的值做為名稱,而非預設名稱。

minAlignmentPeriod

string (Duration format)

選用。這個資料集的資料點頻率下限,是透過指定時間序列查詢中使用的最短對齊週期來實作。舉例來說,如果資料每 10 分鐘發布一次,則 min_alignment_period 至少應為 10 分鐘。以一分鐘為間隔擷取及對齊資料並不合理。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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

服務的 ID,例如可執行檔、工作或 Google App Engine 服務的名稱。相較於 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)

選用。決定小工具選取器的顯示方式。

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,這個欄位應包含 regex。

comparator

enum (Comparator)

用來評估範本變數值是否符合 template_variable_value 的比較子。舉例來說,如果比較子是 REGEX_FULL_MATCH,template_variable_value 就會包含與範本變數值相符的 regex。

TimeRange

JSON 表示法
{

  // Union field time_interval can be only one of the following:
  "absoluteWindow": {
    object (Interval)
  },
  "relativeDuration": string
  // End of list of possible types for union field time_interval.
}
欄位
聯集欄位 time_interval。指定時間範圍間隔類型。time_interval 只能是下列其中一個設定:
absoluteWindow

object (Interval)

選用。代表具有絕對開始和結束時間的時間範圍。開始時間會包含值,但結束時間不含值。

relativeDuration

string (Duration format)

選用。指定用來相對於目前時間 (做為結束時間) 偏移資料的時間長度。時間長度必須為正數。

時間長度以秒為單位,最多可有 9 個小數位數,並應以「s」結尾,例如:"3.5s"。

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)

圖塊中包含的資訊小工具。例如 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 查詢中參照的預留位置文字。如果省略,資訊主頁篩選器會套用至資訊主頁中所有相關的小工具。

valueType

enum (ValueType)

篩選器值的類型。如未提供 value_type,系統會從 default_value 推斷。如果未提供 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_DURATION_PERCENTILES 時距長度百分位數資料值

PlotType

資料集的繪圖策略類型。

列舉
PLOT_TYPE_UNSPECIFIED 未指定情節類型。預設檢視畫面為 LINE。
LINE 資料會繪製成一組折線 (每個序列一條折線)。
STACKED_AREA 資料會繪製為一組填滿的區域 (每個序列一個區域),且這些區域會垂直堆疊 (每個區域的底部是前一個區域的頂部,第一個區域的底部則是 x 軸)。由於這些區域不會重疊,因此會以不同的不透明顏色填滿。
STACKED_BAR 資料會繪製成一組矩形方塊 (每個序列一個方塊),方塊會垂直堆疊 (每個方塊的底部是前一個方塊的頂部,第一個方塊的底部則是 x 軸)。由於方塊不會重疊,因此每個方塊都會填入不同的不透明顏色。
HEATMAP 資料會繪製成熱視圖。繪製的序列必須具有 DISTRIBUTION 值型別。分佈圖中每個值區的值都會以顏色顯示。Stackdriver Monitoring 應用程式目前不支援這類指標。

TargetAxis

座標軸 ID。

列舉
TARGET_AXIS_UNSPECIFIED 未指定目標軸。預設為 Y1。
Y1 y_axis (圖表的右軸)。
Y2 y2_axis (圖表的左軸)。

SortOrder

排序順序選項。

列舉
SORT_ORDER_UNSPECIFIED 未指定排序順序。如果需要排序,這個選項無效。
SORT_ORDER_NONE 未套用任何排序方式。
SORT_ORDER_ASCENDING 系統會優先選取值最低的項目。
SORT_ORDER_DESCENDING 系統會優先選取價值最高的項目。

顏色

實際值超過門檻時,顏色會向觀眾提供解讀方式。每種顏色都有註解,提供 UX 指導,說明使用者應如何解讀特定狀態顏色。

列舉
COLOR_UNSPECIFIED 未指定顏色。不允許在格式正確的要求中使用。
YELLOW 超過門檻即為「令人擔憂」的行為。
RED 超過門檻即為「緊急」行為。

方向

實際值高於或低於門檻值時,是否視為已跨越門檻。

列舉
DIRECTION_UNSPECIFIED 不允許在格式正確的要求中使用。
ABOVE 如果實際值高於門檻值,系統就會判定已超過門檻。
BELOW 如果實際值低於門檻值,系統就會判定已跨越門檻。

TargetAxis

座標軸 ID。

列舉
TARGET_AXIS_UNSPECIFIED 未指定目標軸。預設為 Y1。
Y1 y_axis (圖表的右軸)。
Y2 y2_axis (圖表的左軸)。

規模

座標軸使用的比例類型。

列舉
SCALE_UNSPECIFIED 未指定比例。預設檢視畫面為 LINEAR。
LINEAR 線性比例。
LOG10 對數比例 (以 10 為底)。

模式

圖表模式選項。

列舉
MODE_UNSPECIFIED 未指定模式。預設檢視畫面為 COLOR。
COLOR 圖表會使用不同顏色區分資料序列。如果圖表中有許多線條,系統可能會重複使用線條顏色。
X_RAY 圖表採用 Stackdriver X 射線模式,其中每個資料集都是以半透明的相同顏色繪製。
STATS 圖表會顯示平均值、中位數和第 95 個百分位數等統計資料。

SparkChartType

定義 Scorecard 支援的可能火花線圖類型。

列舉
SPARK_CHART_TYPE_UNSPECIFIED 不允許在格式正確的要求中使用。
SPARK_LINE 走勢圖會以小型折線圖呈現。
SPARK_BAR 系統會將走勢圖顯示為小型長條圖。

格式

文字內容的格式類型。

列舉
FORMAT_UNSPECIFIED 未指定格式。預設為 MARKDOWN。
MARKDOWN 文字含有 Markdown 格式。
RAW 文字不含特殊格式。

HorizontalAlignment

文字小工具中標題和內容的水平對齊方式

列舉
HORIZONTAL_ALIGNMENT_UNSPECIFIED 未指定水平對齊方式,預設為 H_LEFT
H_LEFT 靠左對齊
H_CENTER 置中對齊
H_RIGHT 靠右對齊

VerticalAlignment

文字小工具中標題和內容的垂直對齊方式

列舉
VERTICAL_ALIGNMENT_UNSPECIFIED 未指定垂直對齊方式,預設為 V_TOP
V_TOP 靠上對齊
V_CENTER 置中對齊
V_BOTTOM 靠下對齊

PaddingSize

指定文字小工具周圍的邊框間距大小

列舉
PADDING_SIZE_UNSPECIFIED 未指定邊框間距大小,預設為 P_EXTRA_SMALL
P_EXTRA_SMALL 特小邊框間距
P_SMALL 小邊框間距
P_MEDIUM 中等邊框間距
P_LARGE 大型邊框間距
P_EXTRA_LARGE 特大邊框間距

FontSize

指定文字小工具標題和內容的字型大小

列舉
FONT_SIZE_UNSPECIFIED 未指定字型大小,預設為 FS_LARGE
FS_EXTRA_SMALL 字型極小
FS_SMALL 字型太小
FS_MEDIUM 中等字型大小
FS_LARGE 字型太大
FS_EXTRA_LARGE 特大字型

PointerLocation

指定視覺指標在文字小工具上的位置 (有時也稱為「尾端」)

列舉
POINTER_LOCATION_UNSPECIFIED 沒有視覺指標
PL_TOP 位於小工具頂端中央
PL_RIGHT 位於小工具右側中間
PL_BOTTOM 位於小工具底部的中間
PL_LEFT 位於小工具左側中間
PL_TOP_LEFT 位於小工具頂端的左側
PL_TOP_RIGHT 位於小工具頂端右側
PL_RIGHT_TOP 位於小工具右側頂端
PL_RIGHT_BOTTOM 位於小工具右下角
PL_BOTTOM_RIGHT 位於小工具底部的右側
PL_BOTTOM_LEFT 位於小工具底部的左側
PL_LEFT_BOTTOM 位於小工具左側底部
PL_LEFT_TOP 放在小工具左上角

MetricVisualization

指標 metric_visualization 的列舉

列舉
METRIC_VISUALIZATION_UNSPECIFIED 未指定狀態
NUMBER 預設文字算繪
BAR 橫條顯示

CellAlignment

該資料欄中表格儲存格的水平對齊方式

列舉
CELL_ALIGNMENT_UNSPECIFIED 未指定水平對齊方式,因此會改用預設行為。標籤值會靠左對齊。數值會靠右對齊。
LEFT 靠左對齊
CENTER 置中對齊
RIGHT 靠右對齊

PieChartType

圓餅圖的類型。

列舉
PIE_CHART_TYPE_UNSPECIFIED 零值。未指定類型。請勿使用。
PIE 圓餅圖類型的 PieChart。
DONUT 與 PIE 類似,但 DONUT 類型的 PieChart 中間有洞。

DisplayType

指出小工具選取器顯示方式的類型。

列舉
DISPLAY_TYPE_UNSPECIFIED 未指定顯示螢幕類型,預設為下拉式選單。
DROPDOWN 將小工具選取器顯示為下拉式選單。
TAB 將小工具選取器顯示為分頁清單。

比較子

範本變數值相符時,要評估的比較器選項。

列舉
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 虛擬機器上的客體 OS 發生錯誤。
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 維護事件。

工具註解

工具註解會傳送至 MCP 用戶端,說明特定工具的基本風險。大多數用戶端會將這些提示視為不受信任,但可用於決定何時向使用者傳送確認提示。

除了標題字串外,以下布林提示的定義如下:

  • readOnlyHint:如果為 true,工具不會修改環境。預設值:false。
  • destructiveHint:如果為 true,工具可以執行破壞性動作。如果為 false,工具只能執行加法動作。預設值:true。
  • idempotentHint:如果為 true,以相同引數重複呼叫工具,對環境不會有額外影響。預設值:false。
  • openWorldHint:設為 true 時,工具可以與外部實體的「開放世界」互動。如果為 false,工具只能與內部實體互動。舉例來說,網頁搜尋工具屬於開放世界,記憶體工具則不屬於開放世界。

破壞性提示:❌ | 等冪提示:✅ | 唯讀提示:✅ | 開放世界提示:❌