Package types (2.1.0)

API documentation for monitoring_dashboard_v1.types package.



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


Options to control visual rendering of a chart. .. attribute:: mode

The chart mode.



A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.


The CreateDashboard request. .. attribute:: parent

Required. The project on which to execute the request. The format is:



The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.

:type: str


A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.


The DeleteDashboard request. .. attribute:: name

Required. The resource name of the Dashboard. The format is:



:type: str


The GetDashboard request. .. attribute:: name

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

    :type: str


A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.


The ListDashboards request. .. attribute:: parent

Required. The scope of the dashboards to list. The format is:



:type: str


The ListDashboards request. .. attribute:: dashboards

The list of requested dashboards.

:type: Sequence[]


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.


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.


A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.


A widget showing the latest value of a metric, and how this value relates to one or more thresholds.


Defines the possible types of spark chart supported by the Scorecard.


A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API.


A widget that displays textual content. .. attribute:: content

The text content to be displayed.

:type: str


Defines a threshold for categorizing time series values. .. attribute:: label

A label for the threshold.

:type: str


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.


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.


TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.


The UpdateDashboard request. .. attribute:: dashboard

Required. The dashboard that will replace the existing dashboard.



Widget contains a single dashboard component and configuration of how to present the component in the dashboard.


A chart that displays data on a 2D (X and Y axes) plane. .. attribute:: data_sets

Required. The data displayed in this chart.

:type: Sequence[]