Index
-
DashboardsService(interface) -
Aggregation(message) -
Aggregation.Aligner(enum) -
Aggregation.Reducer(enum) -
AggregationFunction(message) -
AggregationFunction.Parameter(message) -
AlertChart(message) -
Breakdown(message) -
ChartOptions(message) -
ChartOptions.Mode(enum) -
CollapsibleGroup(message) -
ColumnLayout(message) -
ColumnLayout.Column(message) -
ColumnSortingOptions(message) -
CreateDashboardRequest(message) -
Dashboard(message) -
DashboardAnnotations(message) -
DashboardFilter(message) -
DashboardFilter.FilterType(enum) -
DashboardFilter.StringArray(message) -
DashboardFilter.ValueType(enum) -
DeleteDashboardRequest(message) -
Dimension(message) -
ErrorReportingPanel(message) -
EventAnnotation(message) -
EventAnnotation.EventType(enum) -
GetDashboardRequest(message) -
GridLayout(message) -
IncidentList(message) -
ListDashboardsRequest(message) -
ListDashboardsResponse(message) -
LogsPanel(message) -
Measure(message) -
MosaicLayout(message) -
MosaicLayout.Tile(message) -
OpsAnalyticsQuery(message) -
PickTimeSeriesFilter(message) -
PickTimeSeriesFilter.Direction(enum) -
PickTimeSeriesFilter.Method(enum) -
PieChart(message) -
PieChart.PieChartDataSet(message) -
PieChart.PieChartType(enum) -
RowLayout(message) -
RowLayout.Row(message) -
Scorecard(message) -
Scorecard.GaugeView(message) -
Scorecard.SparkChartView(message) -
SectionHeader(message) -
SingleViewGroup(message) -
SingleViewGroup.DisplayType(enum) -
SortOrder(enum) -
SparkChartType(enum) -
TableDisplayOptions(message) -
Text(message) -
Text.Format(enum) -
Text.TextStyle(message) -
Text.TextStyle.FontSize(enum) -
Text.TextStyle.HorizontalAlignment(enum) -
Text.TextStyle.PaddingSize(enum) -
Text.TextStyle.PointerLocation(enum) -
Text.TextStyle.VerticalAlignment(enum) -
Threshold(message) -
Threshold.Color(enum) -
Threshold.Direction(enum) -
Threshold.TargetAxis(enum) -
TimeSeriesFilter(message) -
TimeSeriesFilterRatio(message) -
TimeSeriesFilterRatio.RatioPart(message) -
TimeSeriesQuery(message) -
TimeSeriesTable(message) -
TimeSeriesTable.ColumnSettings(message) -
TimeSeriesTable.ColumnSettings.CellAlignment(enum) -
TimeSeriesTable.MetricVisualization(enum) -
TimeSeriesTable.TableDataSet(message) -
Treemap(message) -
Treemap.TreemapDataSet(message) -
UpdateDashboardRequest(message) -
Widget(message) -
Widget.TemplateVariableCondition(message) -
Widget.TemplateVariableCondition.Comparator(enum) -
Widget.VisibilityCondition(message) -
XyChart(message) -
XyChart.Axis(message) -
XyChart.Axis.Scale(enum) -
XyChart.DataSet(message) -
XyChart.DataSet.PlotType(enum) -
XyChart.DataSet.TargetAxis(enum)
DashboardsService
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
rpc CreateDashboard(
CreateDashboardRequest
) returns ( Dashboard
)
Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API
. This method requires the monitoring.dashboards.create
permission on the specified project. For more information about permissions, see Cloud Identity and Access Management
.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.write
For more information, see the Authentication Overview .
-
rpc DeleteDashboard(
DeleteDashboardRequest
) returns ( Empty
)
Deletes an existing custom dashboard.
This method requires the monitoring.dashboards.delete
permission on the specified dashboard. For more information, see Cloud Identity and Access Management
.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.write
For more information, see the Authentication Overview .
-
rpc GetDashboard(
GetDashboardRequest
) returns ( Dashboard
)
Fetches a specific dashboard.
This method requires the monitoring.dashboards.get
permission on the specified dashboard. For more information, see Cloud Identity and Access Management
.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc ListDashboards(
ListDashboardsRequest
) returns ( ListDashboardsResponse
)
Lists the existing dashboards.
This method requires the monitoring.dashboards.list
permission on the specified project. For more information, see Cloud Identity and Access Management
.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc UpdateDashboard(
UpdateDashboardRequest
) returns ( Dashboard
)
Replaces an existing custom dashboard with a new definition.
This method requires the monitoring.dashboards.update
permission on the specified dashboard. For more information, see Cloud Identity and Access Management
.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.write
For more information, see the Authentication Overview .
-
Aggregation
Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.
Alignment consists of applying the per_series_aligner
operation to each time series after its data has been divided into regular alignment_period
time intervals. This process takes all
of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.
Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer
to all the time series, optionally sorting the time series into subsets with group_by_fields
, and applying the reducer to each subset.
The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation .
| Fields | |
|---|---|
alignment_period
|
The The value must be at least 60 seconds. If a per-series aligner other than The maximum value of the |
per_series_aligner
|
An Not all alignment operations may be applied to all time series. The valid choices depend on the Time series data must be aligned in order to perform cross-time series reduction. If |
cross_series_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 Time series data must first be aligned (see |
group_by_fields[]
|
The set of fields to preserve when |
Aligner
The Aligner
specifies the operation that will be applied to the data points in each alignment period in a time series. Except for ALIGN_NONE
, which specifies that no operation be applied, each alignment operation replaces the set of data values in each alignment period with a single value: the result of applying the operation to the data values. An aligned time series has a single data value at the end of each alignment_period
.
An alignment operation can change the data type of the values, too. For example, if you apply a counting operation to boolean values, the data value_type
in the original time series is BOOLEAN
, but the value_type
in the aligned result is INT64
.
| Enums | |
|---|---|
ALIGN_NONE
|
No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type
of the result is the same as the value_type
of the input. |
ALIGN_DELTA
|
Align and convert to This alignment is valid for |
ALIGN_RATE
|
Align and convert to a rate. The result is computed as This aligner is valid for If, by "rate", you mean "percentage change", see the |
ALIGN_INTERPOLATE
|
Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE
metrics with numeric values. The value_type
of the aligned result is the same as the value_type
of the input. |
ALIGN_NEXT_OLDER
|
Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE
metrics. The value_type
of the aligned result is the same as the value_type
of the input. |
ALIGN_MIN
|
Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric values. The value_type
of the aligned result is the same as the value_type
of the input. |
ALIGN_MAX
|
Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric values. The value_type
of the aligned result is the same as the value_type
of the input. |
ALIGN_MEAN
|
Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric values. The value_type
of the aligned result is DOUBLE
. |
ALIGN_COUNT
|
Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric or Boolean values. The value_type
of the aligned result is INT64
. |
ALIGN_SUM
|
Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric and distribution values. The value_type
of the aligned result is the same as the value_type
of the input. |
ALIGN_STDDEV
|
Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE
and DELTA
metrics with numeric values. The value_type
of the output is DOUBLE
. |
ALIGN_COUNT_TRUE
|
Align the time series by returning the number of True
values in each alignment period. This aligner is valid for GAUGE
metrics with Boolean values. The value_type
of the output is INT64
. |
ALIGN_COUNT_FALSE
|
Align the time series by returning the number of False
values in each alignment period. This aligner is valid for GAUGE
metrics with Boolean values. The value_type
of the output is INT64
. |
ALIGN_FRACTION_TRUE
|
Align the time series by returning the ratio of the number of True
values to the total number of values in each alignment period. This aligner is valid for GAUGE
metrics with Boolean values. The output value is in the range [0.0, 1.0] and has value_type
DOUBLE
. |
ALIGN_PERCENTILE_99
|
Align the time series by using percentile aggregation
. The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE
and DELTA
metrics with distribution values. The output is a GAUGE
metric with value_type
DOUBLE
. |
ALIGN_PERCENTILE_95
|
Align the time series by using percentile aggregation
. The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE
and DELTA
metrics with distribution values. The output is a GAUGE
metric with value_type
DOUBLE
. |
ALIGN_PERCENTILE_50
|
Align the time series by using percentile aggregation
. The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE
and DELTA
metrics with distribution values. The output is a GAUGE
metric with value_type
DOUBLE
. |
ALIGN_PERCENTILE_05
|
Align the time series by using percentile aggregation
. The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE
and DELTA
metrics with distribution values. The output is a GAUGE
metric with value_type
DOUBLE
. |
ALIGN_PERCENT_CHANGE
|
Align and convert to a percentage change. This aligner is valid for If the values of 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 |
Reducer
A Reducer operation describes how to aggregate data points from multiple 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.
| Enums | |
|---|---|
REDUCE_NONE
|
No cross-time series reduction. The output of the Aligner
is returned. |
REDUCE_MEAN
|
Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics with numeric or distribution values. The value_type
of the output is DOUBLE
. |
REDUCE_MIN
|
Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics with numeric values. The value_type
of the output is the same as the value_type
of the input. |
REDUCE_MAX
|
Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics with numeric values. The value_type
of the output is the same as the value_type
of the input. |
REDUCE_SUM
|
Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics with numeric and distribution values. The value_type
of the output is the same as the value_type
of the input. |
REDUCE_STDDEV
|
Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics with numeric or distribution values. The value_type
of the output is DOUBLE
. |
REDUCE_COUNT
|
Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics of numeric, Boolean, distribution, and string value_type
. The value_type
of the output is INT64
. |
REDUCE_COUNT_TRUE
|
Reduce by computing the number of True
-valued data points across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics of Boolean value_type
. The value_type
of the output is INT64
. |
REDUCE_COUNT_FALSE
|
Reduce by computing the number of False
-valued data points across time series for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics of Boolean value_type
. The value_type
of the output is INT64
. |
REDUCE_FRACTION_TRUE
|
Reduce by computing the ratio of the number of True
-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA
and GAUGE
metrics of Boolean value_type
. The output value is in the range [0.0, 1.0] and has value_type
DOUBLE
. |
REDUCE_PERCENTILE_99
|
Reduce by computing the 99th percentile
of data points across time series for each alignment period. This reducer is valid for GAUGE
and DELTA
metrics of numeric and distribution type. The value of the output is DOUBLE
. |
REDUCE_PERCENTILE_95
|
Reduce by computing the 95th percentile
of data points across time series for each alignment period. This reducer is valid for GAUGE
and DELTA
metrics of numeric and distribution type. The value of the output is DOUBLE
. |
REDUCE_PERCENTILE_50
|
Reduce by computing the 50th percentile
of data points across time series for each alignment period. This reducer is valid for GAUGE
and DELTA
metrics of numeric and distribution type. The value of the output is DOUBLE
. |
REDUCE_PERCENTILE_05
|
Reduce by computing the 5th percentile
of data points across time series for each alignment period. This reducer is valid for GAUGE
and DELTA
metrics of numeric and distribution type. The value of the output is DOUBLE
. |
AggregationFunction
Preview: An identifier for an aggregation function. Aggregation functions are SQL functions that group or transform data from multiple points to a single point. This is a preview feature and may be subject to change before final release.
type
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()
parameters[]
Optional. Parameters applied to the aggregation function. Only used for functions that require them.
Parameter
Preview: Parameter value applied to the aggregation function. This is a preview feature and may be subject to change before final release.
value
. Parameter value. value
can be only one of the following:int_value
int64
An integer parameter value.
double_value
double
A floating-point parameter value.
AlertChart
A chart that displays alert policy data.
| Fields | |
|---|---|
name
|
Required. The resource name of the alert policy. The format is:
|
Breakdown
Preview: A breakdown is an aggregation applied to the measures over a specified column. A breakdown can result in multiple series across a category for the provided measure. This is a preview feature and may be subject to change before final release.
| Fields | |
|---|---|
column
|
Required. The name of the column in the dataset containing the breakdown values. |
limit
|
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 |
aggregation_function
|
Required. The Aggregation function is applied across all data in each breakdown created. |
sort_order
|
Required. The sort order is applied to the values of the breakdown column. |
ChartOptions
Options to control visual rendering of a chart.
| Fields | |
|---|---|
mode
|
The chart mode. |
display_horizontal
|
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. |
Mode
Chart mode options.
| Enums | |
|---|---|
MODE_UNSPECIFIED
|
Mode is unspecified. The view will default to COLOR
. |
COLOR
|
The chart distinguishes data series using different color. Line colors may get reused when there are many lines in the chart. |
X_RAY
|
The chart uses the Stackdriver x-ray mode, in which each data set is plotted using the same semi-transparent color. |
STATS
|
The chart displays statistics such as average, median, 95th percentile, and more. |
CollapsibleGroup
A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.
| Fields | |
|---|---|
collapsed
|
The collapsed state of the widget on first page load. |
ColumnLayout
A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
| Fields | |
|---|---|
columns[]
|
The columns of content to display. |
Column
Defines the layout properties and content for a column.
| Fields | |
|---|---|
weight
|
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. |
widgets[]
|
The display widgets arranged vertically in this column. |
ColumnSortingOptions
Data structure to storing column's sort strategy
| Fields | |
|---|---|
column
|
Optional. Column name to sort data by |
direction
|
Optional. A sorting direction that determines ascending or descending order. This is a legacy field kept for backwards compatibility with table. |
CreateDashboardRequest
The CreateDashboard
request.
parent
string
Required. The project on which to execute the request. The format is:
projects/[PROJECT_ID_OR_NUMBER]
The [PROJECT_ID_OR_NUMBER]
must match the dashboard resource name.
Authorization requires the following IAM
permission on the specified resource parent
:
-
monitoring.dashboards.create
dashboard
Required. The initial dashboard specification.
validate_only
bool
If set, validate the request and preview the review, but do not actually save it.
Dashboard
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
name
string
Identifier. The resource name of the dashboard.
display_name
string
Required. The mutable, human-readable name.
etag
string
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. An etag
is returned in the response to GetDashboard
, and users are expected to put that etag in the request to UpdateDashboard
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.
dashboard_filters[]
Filters to reduce the amount of data charted based on the filter criteria.
labels
map<string, string>
Labels applied to the dashboard
annotations
Configuration for event annotations to display on this dashboard.
layout
. A dashboard's root container element that defines the layout style. layout
can be only one of the following:grid_layout
Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
mosaic_layout
The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
row_layout
The content is divided into equally spaced rows and the widgets are arranged horizontally.
column_layout
The content is divided into equally spaced columns and the widgets are arranged vertically.
DashboardAnnotations
Dashboard-level configuration for annotations
| Fields | |
|---|---|
default_resource_names[]
|
Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual
|
event_annotations[]
|
List of annotation configurations for this dashboard. Each entry specifies one event type. |
DashboardFilter
A filter to reduce the amount of data charted in relevant widgets.
label_key
string
Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise.
template_variable
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.
value_type
The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default.
filter_type
The specified filter type
default_value
. The default value used in the filter comparison default_value
can be only one of the following:string_value
string
A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED
string_array_value
An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED
value_source
. A definition of the set of valid values for the filter. This is optional but recommended for VALUE_ONLY filters. For other filter types, the set of valid values will be inferred from the charted data. value_source
can be only one of the following:time_series_query
A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported
string_array
A list of possible string values for the filter
FilterType
The type for the dashboard filter
| Enums | |
|---|---|
FILTER_TYPE_UNSPECIFIED
|
Filter type is unspecified. This is not valid in a well-formed request. |
RESOURCE_LABEL
|
Filter on a resource label value |
METRIC_LABEL
|
Filter on a metrics label value |
USER_METADATA_LABEL
|
Filter on a user metadata label value |
SYSTEM_METADATA_LABEL
|
Filter on a system metadata label value |
GROUP
|
Filter on a group id |
VALUE_ONLY
|
Filter that only contains a value. The label_key field must be unset for filters of this type. |
StringArray
An array of strings
| Fields | |
|---|---|
values[]
|
The values of the array |
ValueType
The type of the filter value
| Enums | |
|---|---|
VALUE_TYPE_UNSPECIFIED
|
Value type is unspecified |
STRING
|
String type |
STRING_ARRAY
|
String array type |
DeleteDashboardRequest
The DeleteDashboard
request.
name
string
Required. The resource name of the Dashboard. The format is:
projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
Authorization requires the following IAM
permission on the specified resource name
:
-
monitoring.dashboards.delete
Dimension
A chart dimension. Dimensions are a structured label, class, or category for a set of measurements in your data.
column
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 to metric_value
.
column_type
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.
max_bin_count
int32
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.
sort_order
The sort order applied to the sort column.
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. If sort_order
is set to NONE
, then this value is not used.
bin_size
. The values of bin_size
are used to configure the grouping of points for the dimension specified by the column
field. bin_size
can be only one of the following:time_bin_size
time_bin_size
is used when the data type of the specified dimension is a time type and the bin size is determined by a time duration. If column_type
is DATE
, this must be a whole value multiple of 1 day. If column_type
is TIME
, this must be less than or equal to 24 hours.
numeric_bin_size
int32
numeric_bin_size
is used when the column type used for a dimension is numeric or string. If the column
field is set to metric_value
, then numericBinSize
overrides maxBinCount
.
float_bin_size
double
Optional. float_bin_size
is used when the column type used for a dimension is a floating point numeric column.
ErrorReportingPanel
A widget that displays a list of error groups.
| Fields | |
|---|---|
project_names[]
|
The resource name of the Google Cloud Platform project. Written as Examples: |
services[]
|
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 Contains the service name for error reports extracted from Google App Engine logs or |
versions[]
|
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. |
EventAnnotation
Annotation configuration for one event type on a dashboard
| Fields | |
|---|---|
display_name
|
Solely for UI display. Should not be used programmatically. |
event_type
|
The type of event to display. |
filter
|
string filtering the events - event dependant. Example values:
|
enabled
|
Whether or not to show the events on the dashboard by default |
resource_names[]
|
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:
|
EventType
Predefined event types.
| Enums | |
|---|---|
EVENT_TYPE_UNSPECIFIED
|
No event type specified. |
GKE_WORKLOAD_DEPLOYMENT
|
Patch/update of GKE workload. |
GKE_POD_CRASH
|
Crash events for a GKE Pod. |
GKE_POD_UNSCHEDULABLE
|
Scheduling failures for GKE Pods. |
GKE_CONTAINER_CREATION_FAILED
|
Failure to create a GKE container. |
GKE_CLUSTER_CREATE_DELETE
|
Create/delete of a GKE cluster. |
GKE_CLUSTER_UPDATE
|
Update of a GKE cluster. |
GKE_NODE_POOL_UPDATE
|
Update of a GKE node pool. |
GKE_CLUSTER_AUTOSCALER
|
GKE cluster autoscaler event. |
GKE_POD_AUTOSCALER
|
GKE pod autoscaler event. |
VM_TERMINATION
|
Termination of a virtual machine. |
VM_GUEST_OS_ERROR
|
Guest OS error on a virtual machine. |
VM_START_FAILED
|
Start failure on a virtual machine. |
MIG_UPDATE
|
Update of a managed instance group. |
MIG_AUTOSCALER
|
Autoscaler event for a managed instance group. |
CLOUD_RUN_DEPLOYMENT
|
New deployment of a Cloud Run service. |
CLOUD_SQL_FAILOVER
|
Failover of a Cloud SQL instance. |
CLOUD_SQL_START_STOP
|
Start/stop of a Cloud SQL instance. |
CLOUD_SQL_STORAGE
|
Storage event for a Cloud SQL instance. |
UPTIME_CHECK_FAILURE
|
Failure of a Cloud Monitoring uptime check. |
CLOUD_ALERTING_ALERT
|
Alerts from Cloud Alerting |
SERVICE_HEALTH_INCIDENT
|
Incidents from Service Health |
SAP_BACKINT
|
Agent for SAP Backint related events. |
SAP_AVAILABILITY
|
Agent for SAP availability related events. |
SAP_OPERATIONS
|
Agent for SAP operations related events. |
GetDashboardRequest
The GetDashboard
request.
name
string
Required. The resource name of the Dashboard. The format is one of:
-
dashboards/[DASHBOARD_ID](for system dashboards) -
projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID](for custom dashboards).
Authorization requires the following IAM
permission on the specified resource name
:
-
monitoring.dashboards.get
GridLayout
A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.
| Fields | |
|---|---|
columns
|
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. |
widgets[]
|
The informational elements that are arranged into the columns row-first. |
IncidentList
A widget that displays a list of incidents
| Fields | |
|---|---|
monitored_resources[]
|
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. |
policy_names[]
|
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 |
ListDashboardsRequest
The ListDashboards
request.
parent
string
Required. The scope of the dashboards to list. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Authorization requires the following IAM
permission on the specified resource parent
:
-
monitoring.dashboards.list
page_size
int32
A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.
page_token
string
Optional. If this field is not empty then it must contain the nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
ListDashboardsResponse
The ListDashboards
request.
| Fields | |
|---|---|
dashboards[]
|
The list of requested dashboards. |
next_page_token
|
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
LogsPanel
A widget that displays a stream of log.
| Fields | |
|---|---|
filter
|
A filter that chooses which log entries to return. See Advanced Logs Queries . Only log entries that match the filter are returned. An empty filter matches all log entries. |
resource_names[]
|
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. |
Measure
A chart measure. Measures represent a measured property in your chart data such as rainfall in inches, number of units sold, revenue gained, etc.
| Fields | |
|---|---|
column
|
Required. The column name within in the dataset used for the measure. |
aggregation_function
|
Required. The aggregation function applied to the input column. This must not be set to |
MosaicLayout
A mosaic layout divides the available space into a grid of blocks, and overlays the grid with tiles. Unlike GridLayout
, tiles may span multiple grid blocks and can be placed at arbitrary locations in the grid.
| Fields | |
|---|---|
columns
|
The number of columns in the mosaic grid. The number of columns must be between 1 and 48, inclusive. |
tiles[]
|
The tiles to display. |
Tile
A single tile in the mosaic. The placement and size of the tile are configurable.
| Fields | |
|---|---|
x_pos
|
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. |
y_pos
|
The zero-indexed position of the tile in grid blocks relative to the top edge of the grid. |
width
|
The width of the tile, measured in grid blocks. Tiles must have a minimum width of 1. |
height
|
The height of the tile, measured in grid blocks. Tiles must have a minimum height of 1. |
widget
|
The informational widget contained in the tile. For example an |
OpsAnalyticsQuery
Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release.
| Fields | |
|---|---|
sql
|
A SQL query to fetch time series, category series, or numeric series data. |
PickTimeSeriesFilter
Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series
time series to pass through it, selecting them based on the relative ranking.
For example, if ranking_method
is METHOD_MEAN
, direction
is BOTTOM
, and num_time_series
is 3, then the 3 times series with the lowest mean values will pass through the filter.
| Fields | |
|---|---|
ranking_method
|
|
num_time_series
|
How many time series to allow to pass through the filter. |
direction
|
How to use the ranking to select time series that pass through the filter. |
interval
|
Select the top N streams/time series within this time interval |
Direction
Describes the ranking directions.
| Enums | |
|---|---|
DIRECTION_UNSPECIFIED
|
Not allowed. You must specify a different Direction
if you specify a PickTimeSeriesFilter
. |
TOP
|
Pass the highest num_time_series
ranking inputs. |
BOTTOM
|
Pass the lowest num_time_series
ranking inputs. |
Method
The value reducers that can be applied to a PickTimeSeriesFilter
.
| Enums | |
|---|---|
METHOD_UNSPECIFIED
|
Not allowed. You must specify a different Method
if you specify a PickTimeSeriesFilter
. |
METHOD_MEAN
|
Select the mean of all values. |
METHOD_MAX
|
Select the maximum value. |
METHOD_MIN
|
Select the minimum value. |
METHOD_SUM
|
Compute the sum of all values. |
METHOD_LATEST
|
Select the most recent value. |
PieChart
A widget that displays timeseries data as a pie or a donut.
| Fields | |
|---|---|
data_sets[]
|
Required. The queries for the chart's data. |
chart_type
|
Required. Indicates the visualization type for the PieChart. |
show_labels
|
Optional. Indicates whether or not the pie chart should show slices' labels |
PieChartDataSet
Groups a time series query definition.
| Fields | |
|---|---|
time_series_query
|
Required. The query for the PieChart. See, |
slice_name_template
|
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 |
min_alignment_period
|
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 |
dimensions[]
|
A dimension is a structured label, class, or category for a set of measurements in your data. |
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. |
PieChartType
Types for the pie chart.
| Enums | |
|---|---|
PIE_CHART_TYPE_UNSPECIFIED
|
The zero value. No type specified. Do not use. |
PIE
|
A Pie type PieChart. |
DONUT
|
Similar to PIE, but the DONUT type PieChart has a hole in the middle. |
RowLayout
A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
| Fields | |
|---|---|
rows[]
|
The rows of content to display. |
Row
Defines the layout properties and content for a row.
| Fields | |
|---|---|
weight
|
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. |
widgets[]
|
The display widgets arranged horizontally in this row. |
Scorecard
A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
time_series_query
Required. Fields for querying time series data from the Stackdriver metrics API.
thresholds[]
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.
dimensions[]
Optional. A dimension is a structured label, class, or category for a set of measurements in your data.
measures[]
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.
breakdowns[]
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.
data_view
. Defines the optional additional chart shown on the scorecard. If neither is included - then a default scorecard is shown. data_view
can be only one of the following:gauge_view
Will cause the scorecard to show a gauge chart.
spark_chart_view
Will cause the scorecard to show a spark chart.
blank_view
Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds.
GaugeView
A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).
| Fields | |
|---|---|
lower_bound
|
The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this. |
upper_bound
|
The upper bound for this gauge chart. The value of the chart should always be less than or equal to this. |
SparkChartView
A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.
| Fields | |
|---|---|
spark_chart_type
|
Required. The type of sparkchart to show in this chartView. |
min_alignment_period
|
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. |
SectionHeader
A widget that defines a new section header. Sections populate a table of contents and allow easier navigation of long-form content.
| Fields | |
|---|---|
subtitle
|
The subtitle of the section |
divider_below
|
Whether to insert a divider below the section in the table of contents |
SingleViewGroup
A widget that groups the other widgets by using a dropdown menu. All widgets that are within the area spanned by the grouping widget are considered member widgets.
| Fields | |
|---|---|
display_type
|
Optional. Determines how the widget selector will be displayed. |
DisplayType
A type indicating how the wiget selector will be displayed.
| Enums | |
|---|---|
DISPLAY_TYPE_UNSPECIFIED
|
Display type is not specified, defaults to DROPDOWN. |
DROPDOWN
|
Renders the widget selector as a dropdown. |
TAB
|
Renders the widget selector as a tab list. |
SortOrder
Sort order options.
| Enums | |
|---|---|
SORT_ORDER_UNSPECIFIED
|
An unspecified sort order. This option is invalid when sorting is required. |
SORT_ORDER_NONE
|
No sorting is applied. |
SORT_ORDER_ASCENDING
|
The lowest-valued entries are selected first. |
SORT_ORDER_DESCENDING
|
The highest-valued entries are selected first. |
SparkChartType
Defines the possible types of spark chart supported by the Scorecard
.
| Enums | |
|---|---|
SPARK_CHART_TYPE_UNSPECIFIED
|
Not allowed in well-formed requests. |
SPARK_LINE
|
The sparkline will be rendered as a small line chart. |
SPARK_BAR
|
The sparkbar will be rendered as a small bar chart. |
TableDisplayOptions
Table display options that can be reused.
| Fields | |
|---|---|
shown_columns[]
|
Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings |
Text
A widget that displays textual content.
| Fields | |
|---|---|
content
|
The text content to be displayed. |
format
|
How the text content is formatted. |
style
|
How the text is styled |
Format
The format type of the text content.
| Enums | |
|---|---|
FORMAT_UNSPECIFIED
|
Format is unspecified. Defaults to MARKDOWN. |
MARKDOWN
|
The text contains Markdown formatting. |
RAW
|
The text contains no special formatting. |
TextStyle
Properties that determine how the title and content are styled
| Fields | |
|---|---|
background_color
|
The background color as a hex string. "#RRGGBB" or "#RGB" |
text_color
|
The text color as a hex string. "#RRGGBB" or "#RGB" |
horizontal_alignment
|
The horizontal alignment of both the title and content |
vertical_alignment
|
The vertical alignment of both the title and content |
padding
|
The amount of padding around the widget |
font_size
|
Font sizes for both the title and content. The title will still be larger relative to the content. |
pointer_location
|
The pointer location for this widget (also sometimes called a "tail") |
FontSize
Specifies a font size for the title and content of a text widget
| Enums | |
|---|---|
FONT_SIZE_UNSPECIFIED
|
No font size specified, will default to FS_LARGE |
FS_EXTRA_SMALL
|
Extra small font size |
FS_SMALL
|
Small font size |
FS_MEDIUM
|
Medium font size |
FS_LARGE
|
Large font size |
FS_EXTRA_LARGE
|
Extra large font size |
HorizontalAlignment
The horizontal alignment of both the title and content on a text widget
| Enums | |
|---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED
|
No horizontal alignment specified, will default to H_LEFT |
H_LEFT
|
Left-align |
H_CENTER
|
Center-align |
H_RIGHT
|
Right-align |
PaddingSize
Specifies padding size around a text widget
| Enums | |
|---|---|
PADDING_SIZE_UNSPECIFIED
|
No padding size specified, will default to P_EXTRA_SMALL |
P_EXTRA_SMALL
|
Extra small padding |
P_SMALL
|
Small padding |
P_MEDIUM
|
Medium padding |
P_LARGE
|
Large padding |
P_EXTRA_LARGE
|
Extra large padding |
PointerLocation
Specifies where a visual pointer is placed on a text widget (also sometimes called a "tail")
| Enums | |
|---|---|
POINTER_LOCATION_UNSPECIFIED
|
No visual pointer |
PL_TOP
|
Placed in the middle of the top of the widget |
PL_RIGHT
|
Placed in the middle of the right side of the widget |
PL_BOTTOM
|
Placed in the middle of the bottom of the widget |
PL_LEFT
|
Placed in the middle of the left side of the widget |
PL_TOP_LEFT
|
Placed on the left side of the top of the widget |
PL_TOP_RIGHT
|
Placed on the right side of the top of the widget |
PL_RIGHT_TOP
|
Placed on the top of the right side of the widget |
PL_RIGHT_BOTTOM
|
Placed on the bottom of the right side of the widget |
PL_BOTTOM_RIGHT
|
Placed on the right side of the bottom of the widget |
PL_BOTTOM_LEFT
|
Placed on the left side of the bottom of the widget |
PL_LEFT_BOTTOM
|
Placed on the bottom of the left side of the widget |
PL_LEFT_TOP
|
Placed on the top of the left side of the widget |
VerticalAlignment
The vertical alignment of both the title and content on a text widget
| Enums | |
|---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED
|
No vertical alignment specified, will default to V_TOP |
V_TOP
|
Top-align |
V_CENTER
|
Center-align |
V_BOTTOM
|
Bottom-align |
Threshold
Defines a threshold for categorizing time series values.
| Fields | |
|---|---|
label
|
A label for the threshold. |
value
|
The value of the threshold. The value should be defined in the native scale of the metric. |
color
|
The state color for this threshold. Color is not allowed in a XyChart. |
direction
|
The direction for the current threshold. Direction is not allowed in a XyChart. |
target_axis
|
The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. |
Color
The color suggests an interpretation to the viewer when actual values cross the threshold. Comments on each color provide UX guidance on how users can be expected to interpret a given state color.
| Enums | |
|---|---|
COLOR_UNSPECIFIED
|
Color is unspecified. Not allowed in well-formed requests. |
YELLOW
|
Crossing the threshold is "concerning" behavior. |
RED
|
Crossing the threshold is "emergency" behavior. |
Direction
Whether the threshold is considered crossed by an actual value above or below its threshold value.
| Enums | |
|---|---|
DIRECTION_UNSPECIFIED
|
Not allowed in well-formed requests. |
ABOVE
|
The threshold will be considered crossed if the actual value is above the threshold value. |
BELOW
|
The threshold will be considered crossed if the actual value is below the threshold value. |
TargetAxis
An axis identifier.
| Enums | |
|---|---|
TARGET_AXIS_UNSPECIFIED
|
The target axis was not specified. Defaults to Y1. |
Y1
|
The y_axis (the right axis of chart). |
Y2
|
The y2_axis (the left axis of chart). |
TimeSeriesFilter
A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries
method.
filter
string
Required. The monitoring filter that identifies the metric types, resources, and projects to query.
aggregation
By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
secondary_aggregation
Apply a second aggregation after aggregation
is applied.
output_filter
. Selects an optional time series filter. output_filter
can be only one of the following:pick_time_series_filter
Ranking based time series filter.
TimeSeriesFilterRatio
A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series.
numerator
The numerator of the ratio.
denominator
The denominator of the ratio.
secondary_aggregation
Apply a second aggregation after the ratio is computed.
output_filter
. Selects an optional filter that is applied to the time series after computing the ratio. output_filter
can be only one of the following:pick_time_series_filter
Ranking based time series filter.
RatioPart
Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.
| Fields | |
|---|---|
filter
|
Required. The monitoring filter that identifies the metric types, resources, and projects to query. |
aggregation
|
By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. |
TimeSeriesQuery
TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
unit_override
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 the unit
field in MetricDescriptor
.
output_full_duration
bool
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
source
. Parameters needed to obtain data for the chart. source
can be only one of the following:time_series_filter
Filter parameters to fetch time series.
time_series_filter_ratio
Parameters to fetch a ratio between two time series filters.
time_series_query_language
string
A query used to fetch time series with MQL.
prometheus_query
string
A query used to fetch time series with PromQL.
ops_analytics_query
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.
TimeSeriesTable
A table that displays time series data.
| Fields | |
|---|---|
data_sets[]
|
Required. The data displayed in this table. |
metric_visualization
|
Optional. Store rendering strategy |
column_settings[]
|
Optional. The list of the persistent column settings for the table. |
ColumnSettings
The persistent settings for a table's columns.
| Fields | |
|---|---|
column
|
Required. The id of the column. |
visible
|
Required. Whether the column should be visible on page load. |
alignment
|
Optional. Whether the column should be left / middle / right aligned |
display_name
|
Optional. Display name of the column |
thresholds[]
|
Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. |
CellAlignment
The horizontal alignment of table cells in that column
| Enums | |
|---|---|
CELL_ALIGNMENT_UNSPECIFIED
|
No horizontal alignment specified; fall back to the default behavior. Label values are left aligned. Numeric values are right aligned. |
LEFT
|
Left-align |
CENTER
|
Center-align |
RIGHT
|
Right-align |
MetricVisualization
Enum for metric metric_visualization
| Enums | |
|---|---|
METRIC_VISUALIZATION_UNSPECIFIED
|
Unspecified state |
NUMBER
|
Default text rendering |
BAR
|
Horizontal bar rendering |
TableDataSet
Groups a time series query definition with table options.
| Fields | |
|---|---|
time_series_query
|
Required. Fields for querying time series data from the Stackdriver metrics API. |
table_template
|
Optional. A template string for naming |
min_alignment_period
|
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 |
table_display_options
|
Optional. Table display options for configuring how the table is rendered. |
Treemap
A widget that displays hierarchical data as a treemap.
data_sets[]
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.
treemap_hierarchy[]
string
Required. Ordered labels representing the hierarchical treemap structure.
TreemapDataSet
The data represented by the treemap. Needs to include the data itself, plus rules on how to organize it hierarchically.
| Fields | |
|---|---|
time_series_query
|
Required. The query that fetches the relevant data. See |
measures[]
|
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. |
breakdowns[]
|
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. |
UpdateDashboardRequest
The UpdateDashboard
request.
dashboard
validate_only
bool
If set, validate the request and preview the review, but do not actually save it.
Widget
Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
title
string
Optional. The title of the widget.
id
string
Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.
visibility_condition
Optional. If set, this widget is rendered only when the condition is evaluated to true.
content
. Content defines the component used to populate the widget. content
can be only one of the following:xy_chart
A chart of time series data.
scorecard
A scorecard summarizing time series data.
text
A raw string or markdown displaying textual content.
blank
A blank space.
alert_chart
A chart of alert policy data.
time_series_table
A widget that displays time series data in a tabular format.
collapsible_group
A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.
logs_panel
A widget that shows a stream of logs.
incident_list
A widget that shows list of incidents.
pie_chart
A widget that displays timeseries data as a pie chart.
treemap
A widget that displays data as a treemap.
error_reporting_panel
A widget that displays a list of error groups.
section_header
A widget that defines a section header for easier navigation of the dashboard.
single_view_group
A widget that groups the other widgets by using a dropdown menu.
TemplateVariableCondition
A condition whose evaluation is based on the value of a template variable.
| Fields | |
|---|---|
template_variable
|
The template variable whose value is evaluated. |
template_variable_value
|
The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. |
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. |
Comparator
Comparator options to evaluate when the template variable value matches.
| Enums | |
|---|---|
COMPARATOR_UNSPECIFIED
|
No comparator specified. Behavior defaults to REGEX_FULL_MATCH. |
REGEX_FULL_MATCH
|
Condition with this comparator evaluates to true when the value of the template variables matches the specified regex. |
VisibilityCondition
Condition that determines whether the widget should be displayed.
| Fields | |
|---|---|
template_variable_condition
|
A condition whose evaluation is based on the value of a template variable. |
XyChart
A chart that displays data on a 2D (X and Y axes) plane.
| Fields | |
|---|---|
data_sets[]
|
Required. The data displayed in this chart. |
timeshift_duration
|
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. |
thresholds[]
|
Threshold lines drawn horizontally across the chart. |
x_axis
|
The properties applied to the x-axis. |
y_axis
|
The properties applied to the y-axis. |
y2_axis
|
The properties applied to the y2-axis. |
chart_options
|
Display options for the chart. |
Axis
A chart axis.
| Fields | |
|---|---|
label
|
The label of the axis. |
scale
|
The axis scale. By default, a linear scale is used. |
Scale
Types of scales used in axes.
| Enums | |
|---|---|
SCALE_UNSPECIFIED
|
Scale is unspecified. The view will default to LINEAR
. |
LINEAR
|
Linear scale. |
LOG10
|
Logarithmic scale (base 10). |
DataSet
Groups a time series query definition with charting options.
| Fields | |
|---|---|
time_series_query
|
Required. Fields for querying time series data from the Stackdriver metrics API. |
plot_type
|
How this data should be plotted on the chart. |
legend_template
|
A template string for naming |
min_alignment_period
|
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 |
target_axis
|
Optional. The target axis to use for plotting the metric. |
dimensions[]
|
Optional. A collection of dimension columns. |
measures[]
|
Optional. A collection of measures. |
breakdowns[]
|
Optional. The collection of breakdowns to be applied to the dataset. |
sort[]
|
Optional. A collection of sort options, affects the order of the data and legend. |
PlotType
The types of plotting strategies for data sets.
| Enums | |
|---|---|
PLOT_TYPE_UNSPECIFIED
|
Plot type is unspecified. The view will default to LINE
. |
LINE
|
The data is plotted as a set of lines (one line per series). |
STACKED_AREA
|
The data is plotted as a set of filled areas (one area per series), with the areas stacked vertically (the base of each area is the top of its predecessor, and the base of the first area is the x-axis). Since the areas do not overlap, each is filled with a different opaque color. |
STACKED_BAR
|
The data is plotted as a set of rectangular boxes (one box per series), with the boxes stacked vertically (the base of each box is the top of its predecessor, and the base of the first box is the x-axis). Since the boxes do not overlap, each is filled with a different opaque color. |
HEATMAP
|
The data is plotted as a heatmap. The series being plotted must have a DISTRIBUTION
value type. The value of each bucket in the distribution is displayed as a color. This type is not currently available in the Stackdriver Monitoring application. |
TargetAxis
An axis identifier.
| Enums | |
|---|---|
TARGET_AXIS_UNSPECIFIED
|
The target axis was not specified. Defaults to Y1. |
Y1
|
The y_axis (the right axis of chart). |
Y2
|
The y2_axis (the left axis of chart). |
