API documentation for monitoring_dashboard_v1.types package.
Classes
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 <https://cloud.google.com/monitoring/api/v3/aggregation>__.
AlertChart
A chart that displays alert policy data. .. attribute:: name
Required. The resource name of the alert policy. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
:type: str
ChartOptions
Options to control visual rendering of a chart. .. attribute:: mode
The chart mode.
:type: google.cloud.monitoring_dashboard_v1.types.ChartOptions.Mode
ColumnLayout
A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
CreateDashboardRequest
The CreateDashboard request.
.. attribute:: parent
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.
:type: str
Dashboard
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
DeleteDashboardRequest
The DeleteDashboard request.
.. attribute:: name
Required. The resource name of the Dashboard. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
:type: str
GetDashboardRequest
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
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.
ListDashboardsRequest
The ListDashboards request.
.. attribute:: parent
Required. The scope of the dashboards to list. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]
:type: str
ListDashboardsResponse
The ListDashboards request.
.. attribute:: dashboards
The list of requested dashboards.
:type: Sequence[google.cloud.monitoring_dashboard_v1.types.Dashboard]
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.
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.
RowLayout
A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
Scorecard
A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
SparkChartType
Defines the possible types of spark chart supported by the
Scorecard.
StatisticalTimeSeriesFilter
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.
Text
A widget that displays textual content. .. attribute:: content
The text content to be displayed.
:type: str
Threshold
Defines a threshold for categorizing time series values. .. attribute:: label
A label for the threshold.
:type: str
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 https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list`__
method.
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.
TimeSeriesQuery
TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
UpdateDashboardRequest
The UpdateDashboard request.
.. attribute:: dashboard
Required. The dashboard that will replace the existing dashboard.
Widget
Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
XyChart
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[google.cloud.monitoring_dashboard_v1.types.XyChart.DataSet]