string

Identifier. The resource name of the dashboard.

string

Required. The mutable, human-readable name.

string

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. Anetag is returned in the response todashboards.get, and users are expected to put that etag in the request todashboards.patch to ensure that their change will be applied to the same version of the Dashboard configuration. The field should not be passed during dashboard creation.

object (DashboardFilter)

Filters to reduce the amount of data charted based on the filter criteria.

map (key: string, value: string)

Labels applied to the dashboard

object (DashboardAnnotations)

Configuration for event annotations to display on this dashboard.

object (GridLayout)

Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.

object (MosaicLayout)

The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.

object (RowLayout)

The content is divided into equally spaced rows and the widgets are arranged horizontally.

object (ColumnLayout)

The content is divided into equally spaced columns and the widgets are arranged vertically.

string (int64 format)

The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering.

object (Widget)

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

string

Optional. The title of the widget.

string

Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.

object (VisibilityCondition)

Optional. If set, this widget is rendered only when the condition is evaluated to true.

object (XyChart)

A chart of time series data.

object (Scorecard)

A scorecard summarizing time series data.

object (Text)

A raw string or markdown displaying textual content.

object

A blank space.

object (AlertChart)

A chart of alert policy data.

object (TimeSeriesTable)

A widget that displays time series data in a tabular format.

object (CollapsibleGroup)

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

object (LogsPanel)

A widget that shows a stream of logs.

object (IncidentList)

A widget that shows list of incidents.

object (PieChart)

A widget that displays timeseries data as a pie chart.

object (Treemap)

A widget that displays data as a treemap.

object (ErrorReportingPanel)

A widget that displays a list of error groups.

object (SectionHeader)

A widget that defines a section header for easier navigation of the dashboard.

object (SingleViewGroup)

A widget that groups the other widgets by using a dropdown menu.

object (FilterControl)

A widget that displays an input field to change the value of a template variable.

object (DataSet)

Required. The data displayed in this chart.

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.

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.

object (Axis)

The properties applied to the y2-axis.

object (ChartOptions)

Display options for the chart.

object (TimeSeriesQuery)

Required. Fields for querying time series data from the Stackdriver metrics API.

enum (PlotType)

How this data should be plotted on the chart.

string

A template string for namingTimeSeries 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, theminAlignmentPeriod should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

enum (TargetAxis)

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

object (Dimension)

Optional. A collection of dimension columns.

object (Measure)

Optional. A collection of measures.

object (Breakdown)

Optional. The collection of breakdowns to be applied to the dataset.

object (ColumnSortingOptions)

Optional. A collection of sort options, affects the order of the data and legend.

string

The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as theunit field inMetricDescriptor.

boolean

Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.

*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart

object (TimeSeriesFilter)

Filter parameters to fetch time series.

object (TimeSeriesFilterRatio)

Parameters to fetch a ratio between two time series filters.

string

A query used to fetch time series with MQL.

string

A query used to fetch time series with PromQL.

object (OpsAnalyticsQuery)

Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release.

string

Required. Themonitoring filter that identifies the metric types, resources, and projects to query.

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 (Aggregation)

Apply a second aggregation afteraggregation is applied.

object (PickTimeSeriesFilter)

Ranking based time series filter.

string (Duration format)

ThealignmentPeriod specifies a time interval, in seconds, that is used to divide the data in all thetime series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.

The value must be at least 60 seconds. If a per-series aligner other thanALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the alignerALIGN_NONE is specified, then this field is ignored.

The maximum value of thealignmentPeriod is 2 years, or 104 weeks.

enum (Aligner)

AnAligner describes how to bring the data points in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in analignmentPeriod to be mathematically grouped together, resulting in a single data point for eachalignmentPeriod 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 themetricKind andvalueType of the original time series. Alignment can change themetricKind or thevalueType of the time series.

Time series data must be aligned in order to perform cross-time series reduction. IfcrossSeriesReducer is specified, thenperSeriesAligner must be specified and not equal toALIGN_NONE andalignmentPeriod 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 themetricKind and thevalueType of the original time series. Reduction can yield a time series with a differentmetricKind orvalueType than the input time series.

Time series data must first be aligned (seeperSeriesAligner) in order to perform cross-time series reduction. IfcrossSeriesReducer is specified, thenperSeriesAligner must be specified, and must not beALIGN_NONE. AnalignmentPeriod must also be specified; otherwise, an error is returned.

string

The set of fields to preserve whencrossSeriesReducer is specified. ThegroupByFields 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. ThecrossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly containsresource.type. Fields not specified ingroupByFields are aggregated away. IfgroupByFields 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. IfcrossSeriesReducer is not defined, this field is ignored.

Align and convert toDELTA. The output isdelta = y1 - y0.

This alignment is valid forCUMULATIVE andDELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. ThevalueType of the aligned result is the same as thevalueType of the input.

Align and convert to a rate. The result is computed asrate = (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of thealignmentPeriod.

This aligner is valid forCUMULATIVE andDELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is aGAUGE metric withvalueTypeDOUBLE.

If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

Align and convert to a percentage change. This aligner is valid forGAUGE andDELTA metrics with numeric values. This alignment returns((current - previous)/previous) * 100, where the value ofprevious is determined based on thealignmentPeriod.

If the values ofcurrent andprevious are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.

A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are>= 0. Any values< 0 are treated as a missing datapoint, and are ignored. WhileDELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is aGAUGE metric withvalueTypeDOUBLE.

enum (Method)

rankingMethod is applied to each time series independently to produce the value which will be used to compare the time series to other time series.

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. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

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".

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".

object (RatioPart)

The numerator of the ratio.

object (RatioPart)

The denominator of the ratio.

object (Aggregation)

Apply a second aggregation after the ratio is computed.

object (PickTimeSeriesFilter)

Ranking based time series filter.

string

Required. Themonitoring filter that identifies the metric types, resources, and projects to query.

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.

string

A SQL query to fetch time series, category series, or numeric series data.

string

Required. For widgets that use SQL queries, set the value to the name of the column in the results table whose data is charted. For a histogram that uses a time series query, set the value of this field tometric_value.

string

Optional. The type of the dimension column. This is relevant only if one of the bin_size fields is set. If it is empty, the type TIMESTAMP or INT64 will be assumed based on which bin_size field is set. If populated, this should be set to one of the following types: DATE, TIME, DATETIME, TIMESTAMP, BIGNUMERIC, INT64, NUMERIC, FLOAT64.

integer

For widgets that use SQL queries, the limit to the number of bins to generate. When 0 is specified, the maximum count is not enforced. For a histogram that uses a time series query, the exact number of bins to generate. If not specified or the value is 0, then the histogram determines the number of bins to use.

enum (SortOrder)

The sort order applied to the sort column.

string

The column name to sort on for binning. This column can be the same column as this dimension or any other column used as a measure in the results. IfsortOrder is set toNONE, then this value is not used.

string (Duration format)

timeBinSize is used when the data type of the specified dimension is a time type and the bin size is determined by a time duration. IfcolumnType isDATE, this must be a whole value multiple of 1 day. IfcolumnType isTIME, this must be less than or equal to 24 hours.

integer

numericBinSize is used when the column type used for a dimension is numeric or string. If thecolumn field is set tometric_value, thennumericBinSize overridesmaxBinCount.

number

Optional.floatBinSize is used when the column type used for a dimension is a floating point numeric column.

string

Required. The column name within in the dataset used for the measure.

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.

string

Required. The type of aggregation function, must be one of the following:

• "none" - no function.
• "percentile" - APPROX_QUANTILES() - 1 parameter numeric value
• "average" - AVG()
• "count" - COUNT()
• "count-distinct" - COUNT(DISTINCT)
• "count-distinct-approx" - APPROX_COUNT_DISTINCT()
• "max" - MAX()
• "min" - MIN()
• "sum" - SUM()

object (Parameter)

Optional. Parameters applied to the aggregation function. Only used for functions that require them.

string (int64 format)

An integer parameter value.

number

A floating-point parameter value.

string

Required. The name of the column in the dataset containing the breakdown values.

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 thesortOrder 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.

string

Optional. Column name to sort data by

enum (SortOrder)

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

string

A label for the threshold.

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.

string

The label of the axis.

enum (Scale)

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

enum (Mode)

The chart mode.

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.

object (TimeSeriesQuery)

Required. Fields for querying time series data from the Stackdriver metrics API.

object (Threshold)

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

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

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

object (Dimension)

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

object (Measure)

Optional. 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.

object (GaugeView)

Will cause the scorecard to show a gauge chart.

object (SparkChartView)

Will cause the scorecard to show a spark chart.

object

Will cause theScorecard to show only the value, with no indicator to its value relative to its thresholds.

number

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

number

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

enum (SparkChartType)

Required. The type of sparkchart to show in this chartView.

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.

string

The text content to be displayed.

enum (Format)

How the text content is formatted.

object (TextStyle)

How the text is styled

string

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

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 (FontSize)

Font sizes for both the title and content. The title will still be larger relative to the content.

enum (PointerLocation)

The pointer location for this widget (also sometimes called a "tail")

string

Required. The resource name of the alert policy. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

object (TableDataSet)

Required. The data displayed in this table.

enum (MetricVisualization)

Optional. Store rendering strategy

object (ColumnSettings)

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

object (TimeSeriesQuery)

Required. Fields for querying time series data from the Stackdriver metrics API.

string

Optional. A template string for namingTimeSeries 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, theminAlignmentPeriod should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

object (TableDisplayOptions)

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

string

string

Required. The id of the column.

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.

boolean

The collapsed state of the widget on first page load.

string

A filter that chooses which log entries to return. SeeAdvanced Logs Queries. Only log entries that match the filter are returned. An empty filter matches all log entries.

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.

object (MonitoredResource)

Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering.

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, usealertPolicies/utilization.

object (PieChartDataSet)

Required. The queries for the chart's data.

enum (PieChartType)

Required. Indicates the visualization type for the PieChart.

boolean

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

object (TimeSeriesQuery)

Required. The query for the PieChart. See,google.monitoring.dashboard.v1.TimeSeriesQuery.

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, theminAlignmentPeriod should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

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 (TreemapDataSet)

Required. The collection of datasets used to construct and populate the treemap. For the rendered treemap rectangles:

• Color is determined by the aggregated value for each grouping.
• Size is proportional to the count of time series aggregated within that rectangle's segment.

string

Required. Ordered labels representing the hierarchical treemap structure.

object (TimeSeriesQuery)

Required. The query that fetches the relevant data. Seegoogle.monitoring.dashboard.v1.TimeSeriesQuery

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

The resource name of the Google Cloud Platform project. Written asprojects/{projectID} orprojects/{projectNumber}, where{projectID} and{projectNumber} can be found in theGoogle Cloud console.

Examples:projects/my-project-123,projects/5551234.

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 toversion, which can be changed whenever new code is deployed.

Contains the service name for error reports extracted from Google App Engine logs ordefault 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.

string

The subtitle of the section

boolean

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

enum (DisplayType)

Optional. Determines how the widget selector will be displayed.

string

Name of the template variable the widget affects.

object (TemplateVariableCondition)

A condition whose evaluation is based on the value of a template variable.

string

The template variable whose value is evaluated.

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 templateVariableValue. For example, if the comparator is REGEX_FULL_MATCH, templateVariableValue would contain a regex that is matched against the value of the template variable.

integer

The number of columns in the mosaic grid. The number of columns must be between 1 and 48, inclusive.

object (Tile)

The tiles to display.

integer

The zero-indexed position of the tile in grid blocks relative to the left edge of the grid. Tiles must be contained within the specified number of columns.xPos cannot be negative.

integer

The zero-indexed position of the tile in grid blocks relative to the top edge of the grid.yPos 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 anXyChart.

object (Row)

The rows of content to display.

string (int64 format)

The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers). Greater the weight, greater the height of the row on the screen. If omitted, a value of 1 is used while rendering.

object (Widget)

The display widgets arranged horizontally in this row.

object (Column)

The columns of content to display.

string (int64 format)

The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers). Greater the weight, greater the width of the column on the screen. If omitted, a value of 1 is used while rendering.

object (Widget)

The display widgets arranged vertically in this column.

string

Optional. The key for the label. This must be omitted if the filterType is VALUE_ONLY but is required otherwise.

string

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

enum (ValueType)

The type of the filter value. If valueType is not provided, it will be inferred from the defaultValue. If neither valueType nor defaultValue is provided, valueType will be set to STRING by default.

enum (FilterType)

The specified filter type

string

A variable-length string value. If this field is set, valueType must be set to STRING or VALUE_TYPE_UNSPECIFIED

object (StringArray)

An array of variable-length string values. If this field is set, valueType must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED

object (TimeSeriesQuery)

A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported

object (StringArray)

A list of possible string values for the filter

string

The values of the array

string

Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individualEventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example:

“projects/some-project-id”

object (EventAnnotation)

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

string

Solely for UI display. Should not be used programmatically.

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”