MCP Tools Reference: monitoring.googleapis.com

object ( Widget )

The informational elements that are arranged into the columns row-first.

string ( Duration format)

The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

object ( Threshold )

Threshold lines drawn horizontally across the chart.

object ( Axis )

The properties applied to the x-axis.

object ( Axis )

The properties applied to the y-axis.

enum ( PlotType )

How this data should be plotted on the chart.

string

A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name} , which will resolve to the label's value.

string ( Duration format)

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

For PromQL queries, this field is used to set the minimum interval for the query step , controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step .

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

enum ( TargetAxis )

Optional. The target axis to use for plotting the metric.

enum ( Aligner )

An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE , all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.

Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.

Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.

enum ( Reducer )

The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.

Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.

Time series data must first be aligned (see per_series_aligner ) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE . An alignment_period must also be specified; otherwise, an error is returned.

string

The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type . Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.

integer

Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

integer

How many time series to allow to pass through the filter.

enum ( Direction )

How to use the ranking to select time series that pass through the filter.

object ( Interval )

Select the top N streams/time series within this time interval

string ( Timestamp format)

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

integer

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

integer

How many time series to output.

object ( Aggregation )

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

object ( AggregationFunction )

Required. The aggregation function applied to the input column. This must not be set to "none" unless binning is disabled on the dimension. The aggregation function is used to group points on the dimension bins.

integer

Required. A limit to the number of breakdowns. If set to zero then all possible breakdowns are applied. The list of breakdowns is dependent on the value of the sort_order field.

object ( AggregationFunction )

Required. The Aggregation function is applied across all data in each breakdown created.

enum ( SortOrder )

Required. The sort order is applied to the values of the breakdown column.

enum ( SortOrder )

Optional. A sorting direction that determines ascending or descending order. This is a legacy field kept for backwards compatibility with table.

number

The value of the threshold. The value should be defined in the native scale of the metric.

enum ( Color )

The state color for this threshold. Color is not allowed in a XyChart.

enum ( Direction )

The direction for the current threshold. Direction is not allowed in a XyChart.

enum ( TargetAxis )

The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.

enum ( Scale )

The axis scale. By default, a linear scale is used.

boolean

Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release.

number

The upper bound for this gauge chart. The value of the chart should always be less than or equal to this.

string ( Duration format)

The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.

For PromQL queries, this field is used to set the minimum interval for the query step , controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step .

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

enum ( Format )

How the text content is formatted.

object ( TextStyle )

How the text is styled

string

The text color as a hex string. "#RRGGBB" or "#RGB"

enum ( HorizontalAlignment )

The horizontal alignment of both the title and content

enum ( VerticalAlignment )

The vertical alignment of both the title and content

enum ( PaddingSize )

The amount of padding around the widget

enum ( MetricVisualization )

Optional. Store rendering strategy

object ( ColumnSettings )

Optional. The list of the persistent column settings for the table.

string

Optional. A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name} , which will resolve to the label's value i.e. "${resource.labels.project_id}."

string ( Duration format)

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

object ( TableDisplayOptions )

Optional. Table display options for configuring how the table is rendered.

boolean

Required. Whether the column should be visible on page load.

enum ( CellAlignment )

Optional. Whether the column should be left / middle / right aligned

string

Optional. Display name of the column

object ( Threshold )

Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value.

string

The names of logging resources to collect logs for. Currently projects and storage views are supported. If empty, the widget will default to the host project.

string

Optional. A list of alert policy names to filter the incident list by. Don't include the project ID prefix in the policy name. For example, use alertPolicies/utilization .

map (key: string, value: string)

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id" , "instance_id" , and "zone" .

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

string

enum ( PieChartType )

Required. Indicates the visualization type for the PieChart.

boolean

Optional. Indicates whether or not the pie chart should show slices' labels

string

Optional. A template for the name of the slice. This name will be displayed in the legend and the tooltip of the pie chart. It replaces the auto-generated names for the slices. For example, if the template is set to ${resource.labels.zone} , the zone's value will be used for the name instead of the default name.

string ( Duration format)

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

object ( Dimension )

A dimension is a structured label, class, or category for a set of measurements in your data.

object ( Measure )

A measure is a measured value of a property in your data. For example, rainfall in inches, number of units sold, revenue gained, etc.

object ( Measure )

Optional. A collection of measures. A measure is a measured value of a property in your data. For example, rainfall in inches, number of units sold, revenue gained, etc.

object ( Breakdown )

Optional. The collection of breakdowns to be applied to the dataset. A breakdown is a way to slice the data. For example, you can break down the data by region.

string

An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version , which can be changed whenever new code is deployed.

Contains the service name for error reports extracted from Google App Engine logs or default if the App Engine default service is used.

string

Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app.

boolean

Whether to insert a divider below the section in the table of contents

string

The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex.

enum ( Comparator )

Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable.

object ( Tile )

The tiles to display.

integer

The zero-indexed position of the tile in grid blocks relative to the top edge of the grid. y_pos cannot be negative.

integer

The width of the tile, measured in grid blocks. Tiles must have a minimum width of 1.

integer

The height of the tile, measured in grid blocks. Tiles must have a minimum height of 1.

object ( Widget )

The informational widget contained in the tile. For example an XyChart .

object ( Widget )

The display widgets arranged horizontally in this row.

object ( Widget )

The display widgets arranged vertically in this column.

string

object ( EventAnnotation )

List of annotation configurations for this dashboard. Each entry specifies one event type.

enum ( EventType )

The type of event to display.

string

string filtering the events - event dependant. Example values:

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

boolean

Whether or not to show the events on the dashboard by default

string

Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example:

 “projects/another-project-id”