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.
Protobuf type google.monitoring.dashboard.v1.Aggregation
Aggregation.Builder
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.
Protobuf type google.monitoring.dashboard.v1.Aggregation
AlertChart
A chart that displays alert policy data.
Protobuf type google.monitoring.dashboard.v1.AlertChart
AlertChart.Builder
A chart that displays alert policy data.
Protobuf type google.monitoring.dashboard.v1.AlertChart
AlertChartProto
ChartOptions
Options to control visual rendering of a chart.
Protobuf type google.monitoring.dashboard.v1.ChartOptions
ChartOptions.Builder
Options to control visual rendering of a chart.
Protobuf type google.monitoring.dashboard.v1.ChartOptions
CollapsibleGroup
A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.
Protobuf type google.monitoring.dashboard.v1.CollapsibleGroup
CollapsibleGroup.Builder
A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.
Protobuf type google.monitoring.dashboard.v1.CollapsibleGroup
CollapsibleGroupProto
ColumnLayout
A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
Protobuf type google.monitoring.dashboard.v1.ColumnLayout
ColumnLayout.Builder
A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
Protobuf type google.monitoring.dashboard.v1.ColumnLayout
ColumnLayout.Column
Defines the layout properties and content for a column.
Protobuf type google.monitoring.dashboard.v1.ColumnLayout.Column
ColumnLayout.Column.Builder
Defines the layout properties and content for a column.
Protobuf type google.monitoring.dashboard.v1.ColumnLayout.Column
CommonProto
CreateDashboardRequest
The CreateDashboard request.
Protobuf type google.monitoring.dashboard.v1.CreateDashboardRequest
CreateDashboardRequest.Builder
The CreateDashboard request.
Protobuf type google.monitoring.dashboard.v1.CreateDashboardRequest
Dashboard
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
Protobuf type google.monitoring.dashboard.v1.Dashboard
Dashboard.Builder
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
Protobuf type google.monitoring.dashboard.v1.Dashboard
DashboardFilter
A filter to reduce the amount of data charted in relevant widgets.
Protobuf type google.monitoring.dashboard.v1.DashboardFilter
DashboardFilter.Builder
A filter to reduce the amount of data charted in relevant widgets.
Protobuf type google.monitoring.dashboard.v1.DashboardFilter
DashboardFilterProto
DashboardName
DashboardName.Builder
Builder for projects/{project}/dashboards/{dashboard}.
DashboardsProto
DashboardsServiceGrpc
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
DashboardsServiceGrpc.DashboardsServiceBlockingStub
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
DashboardsServiceGrpc.DashboardsServiceFutureStub
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
DashboardsServiceGrpc.DashboardsServiceImplBase
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
DashboardsServiceGrpc.DashboardsServiceStub
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
DashboardsServiceProto
DeleteDashboardRequest
The DeleteDashboard request.
Protobuf type google.monitoring.dashboard.v1.DeleteDashboardRequest
DeleteDashboardRequest.Builder
The DeleteDashboard request.
Protobuf type google.monitoring.dashboard.v1.DeleteDashboardRequest
GetDashboardRequest
The GetDashboard request.
Protobuf type google.monitoring.dashboard.v1.GetDashboardRequest
GetDashboardRequest.Builder
The GetDashboard request.
Protobuf type google.monitoring.dashboard.v1.GetDashboardRequest
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.
Protobuf type google.monitoring.dashboard.v1.GridLayout
GridLayout.Builder
A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.
Protobuf type google.monitoring.dashboard.v1.GridLayout
LayoutsProto
ListDashboardsRequest
The ListDashboards request.
Protobuf type google.monitoring.dashboard.v1.ListDashboardsRequest
ListDashboardsRequest.Builder
The ListDashboards request.
Protobuf type google.monitoring.dashboard.v1.ListDashboardsRequest
ListDashboardsResponse
The ListDashboards request.
Protobuf type google.monitoring.dashboard.v1.ListDashboardsResponse
ListDashboardsResponse.Builder
The ListDashboards request.
Protobuf type google.monitoring.dashboard.v1.ListDashboardsResponse
LogsPanel
A widget that displays a stream of log.
Protobuf type google.monitoring.dashboard.v1.LogsPanel
LogsPanel.Builder
A widget that displays a stream of log.
Protobuf type google.monitoring.dashboard.v1.LogsPanel
LogsPanelProto
MetricsProto
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.
Protobuf type google.monitoring.dashboard.v1.MosaicLayout
MosaicLayout.Builder
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.
Protobuf type google.monitoring.dashboard.v1.MosaicLayout
MosaicLayout.Tile
A single tile in the mosaic. The placement and size of the tile are configurable.
Protobuf type google.monitoring.dashboard.v1.MosaicLayout.Tile
MosaicLayout.Tile.Builder
A single tile in the mosaic. The placement and size of the tile are configurable.
Protobuf type google.monitoring.dashboard.v1.MosaicLayout.Tile
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.
Protobuf type google.monitoring.dashboard.v1.PickTimeSeriesFilter
PickTimeSeriesFilter.Builder
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.
Protobuf type google.monitoring.dashboard.v1.PickTimeSeriesFilter
ProjectName
ProjectName.Builder
Builder for projects/{project}.
RowLayout
A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
Protobuf type google.monitoring.dashboard.v1.RowLayout
RowLayout.Builder
A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
Protobuf type google.monitoring.dashboard.v1.RowLayout
RowLayout.Row
Defines the layout properties and content for a row.
Protobuf type google.monitoring.dashboard.v1.RowLayout.Row
RowLayout.Row.Builder
Defines the layout properties and content for a row.
Protobuf type google.monitoring.dashboard.v1.RowLayout.Row
Scorecard
A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
Protobuf type google.monitoring.dashboard.v1.Scorecard
Scorecard.Builder
A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
Protobuf type google.monitoring.dashboard.v1.Scorecard
Scorecard.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).
Protobuf type google.monitoring.dashboard.v1.Scorecard.GaugeView
Scorecard.GaugeView.Builder
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).
Protobuf type google.monitoring.dashboard.v1.Scorecard.GaugeView
Scorecard.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.
Protobuf type google.monitoring.dashboard.v1.Scorecard.SparkChartView
Scorecard.SparkChartView.Builder
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.
Protobuf type google.monitoring.dashboard.v1.Scorecard.SparkChartView
ScorecardProto
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.
Protobuf type google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter
StatisticalTimeSeriesFilter.Builder
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.
Protobuf type google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter
TableDisplayOptions
Table display options that can be reused.
Protobuf type google.monitoring.dashboard.v1.TableDisplayOptions
TableDisplayOptions.Builder
Table display options that can be reused.
Protobuf type google.monitoring.dashboard.v1.TableDisplayOptions
TableDisplayOptionsProto
TableProto
Text
A widget that displays textual content.
Protobuf type google.monitoring.dashboard.v1.Text
Text.Builder
A widget that displays textual content.
Protobuf type google.monitoring.dashboard.v1.Text
TextProto
Threshold
Defines a threshold for categorizing time series values.
Protobuf type google.monitoring.dashboard.v1.Threshold
Threshold.Builder
Defines a threshold for categorizing time series values.
Protobuf type google.monitoring.dashboard.v1.Threshold
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.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilter
TimeSeriesFilter.Builder
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.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilter
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.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilterRatio
TimeSeriesFilterRatio.Builder
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.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilterRatio
TimeSeriesFilterRatio.RatioPart
Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilterRatio.RatioPart
TimeSeriesFilterRatio.RatioPart.Builder
Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilterRatio.RatioPart
TimeSeriesQuery
TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesQuery
TimeSeriesQuery.Builder
TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesQuery
TimeSeriesTable
A table that displays time series data.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable
TimeSeriesTable.Builder
A table that displays time series data.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable
TimeSeriesTable.ColumnSettings
The persistent settings for a table's columns.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable.ColumnSettings
TimeSeriesTable.ColumnSettings.Builder
The persistent settings for a table's columns.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable.ColumnSettings
TimeSeriesTable.TableDataSet
Groups a time series query definition with table options.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable.TableDataSet
TimeSeriesTable.TableDataSet.Builder
Groups a time series query definition with table options.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesTable.TableDataSet
UpdateDashboardRequest
The UpdateDashboard request.
Protobuf type google.monitoring.dashboard.v1.UpdateDashboardRequest
UpdateDashboardRequest.Builder
The UpdateDashboard request.
Protobuf type google.monitoring.dashboard.v1.UpdateDashboardRequest
Widget
Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
Protobuf type google.monitoring.dashboard.v1.Widget
Widget.Builder
Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
Protobuf type google.monitoring.dashboard.v1.Widget
WidgetProto
XyChart
A chart that displays data on a 2D (X and Y axes) plane.
Protobuf type google.monitoring.dashboard.v1.XyChart
XyChart.Axis
A chart axis.
Protobuf type google.monitoring.dashboard.v1.XyChart.Axis
XyChart.Axis.Builder
A chart axis.
Protobuf type google.monitoring.dashboard.v1.XyChart.Axis
XyChart.Builder
A chart that displays data on a 2D (X and Y axes) plane.
Protobuf type google.monitoring.dashboard.v1.XyChart
XyChart.DataSet
Groups a time series query definition with charting options.
Protobuf type google.monitoring.dashboard.v1.XyChart.DataSet
XyChart.DataSet.Builder
Groups a time series query definition with charting options.
Protobuf type google.monitoring.dashboard.v1.XyChart.DataSet
XyChartProto
Interfaces
AggregationOrBuilder
AlertChartOrBuilder
ChartOptionsOrBuilder
CollapsibleGroupOrBuilder
ColumnLayout.ColumnOrBuilder
ColumnLayoutOrBuilder
CreateDashboardRequestOrBuilder
DashboardFilterOrBuilder
DashboardOrBuilder
DeleteDashboardRequestOrBuilder
GetDashboardRequestOrBuilder
GridLayoutOrBuilder
ListDashboardsRequestOrBuilder
ListDashboardsResponseOrBuilder
LogsPanelOrBuilder
MosaicLayout.TileOrBuilder
MosaicLayoutOrBuilder
PickTimeSeriesFilterOrBuilder
RowLayout.RowOrBuilder
RowLayoutOrBuilder
Scorecard.GaugeViewOrBuilder
Scorecard.SparkChartViewOrBuilder
ScorecardOrBuilder
StatisticalTimeSeriesFilterOrBuilder
TableDisplayOptionsOrBuilder
TextOrBuilder
ThresholdOrBuilder
TimeSeriesFilterOrBuilder
TimeSeriesFilterRatio.RatioPartOrBuilder
TimeSeriesFilterRatioOrBuilder
TimeSeriesQueryOrBuilder
TimeSeriesTable.ColumnSettingsOrBuilder
TimeSeriesTable.TableDataSetOrBuilder
TimeSeriesTableOrBuilder
UpdateDashboardRequestOrBuilder
WidgetOrBuilder
XyChart.AxisOrBuilder
XyChart.DataSetOrBuilder
XyChartOrBuilder
Enums
Aggregation.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.
Protobuf enum google.monitoring.dashboard.v1.Aggregation.Aligner
Aggregation.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.
Protobuf enum google.monitoring.dashboard.v1.Aggregation.Reducer
ChartOptions.Mode
Chart mode options.
Protobuf enum google.monitoring.dashboard.v1.ChartOptions.Mode
Dashboard.LayoutCase
DashboardFilter.DefaultValueCase
DashboardFilter.FilterType
The type for the dashboard filter
Protobuf enum google.monitoring.dashboard.v1.DashboardFilter.FilterType
PickTimeSeriesFilter.Direction
Describes the ranking directions.
Protobuf enum google.monitoring.dashboard.v1.PickTimeSeriesFilter.Direction
PickTimeSeriesFilter.Method
The value reducers that can be applied to a PickTimeSeriesFilter.
Protobuf enum google.monitoring.dashboard.v1.PickTimeSeriesFilter.Method
Scorecard.DataViewCase
SparkChartType
Defines the possible types of spark chart supported by the Scorecard.
Protobuf enum google.monitoring.dashboard.v1.SparkChartType
StatisticalTimeSeriesFilter.Method
The filter methods that can be applied to a stream.
Protobuf enum google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter.Method
Text.Format
The format type of the text content.
Protobuf enum google.monitoring.dashboard.v1.Text.Format
Threshold.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.
Protobuf enum google.monitoring.dashboard.v1.Threshold.Color
Threshold.Direction
Whether the threshold is considered crossed by an actual value above or below its threshold value.
Protobuf enum google.monitoring.dashboard.v1.Threshold.Direction
Threshold.TargetAxis
An axis identifier.
Protobuf enum google.monitoring.dashboard.v1.Threshold.TargetAxis
TimeSeriesFilter.OutputFilterCase
TimeSeriesFilterRatio.OutputFilterCase
TimeSeriesQuery.SourceCase
TimeSeriesTable.MetricVisualization
Enum for metric metric_visualization
Protobuf enum google.monitoring.dashboard.v1.TimeSeriesTable.MetricVisualization
Widget.ContentCase
XyChart.Axis.Scale
Types of scales used in axes.
Protobuf enum google.monitoring.dashboard.v1.XyChart.Axis.Scale
XyChart.DataSet.PlotType
The types of plotting strategies for data sets.
Protobuf enum google.monitoring.dashboard.v1.XyChart.DataSet.PlotType
XyChart.DataSet.TargetAxis
An axis identifier.
Protobuf enum google.monitoring.dashboard.v1.XyChart.DataSet.TargetAxis