TimeSeries

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

JSON representation
{
  "metric": {
    object(Metric)
  },
  "resource": {
    object(MonitoredResource)
  },
  "metricKind": enum(MetricKind),
  "valueType": enum(ValueType),
  "points": [
    {
      object(Point)
    }
  ],
}
Fields
metric

object(Metric)

The associated metric. A fully-specified metric used to identify the time series.

resource

object(MonitoredResource)

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.

metricKind

enum(MetricKind)

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

valueType

enum(ValueType)

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

points[]

object(Point)

The data points of this time series. When listing time series, the order of the points is specified by the list method.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

Metric

A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.

JSON representation
{
  "type": string,
  "labels": {
    string: string,
    ...
  },
}
Fields
type

string

An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.

labels

map (key: string, value: string)

The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Point

A single data point in a time series.

JSON representation
{
  "interval": {
    object(TimeInterval)
  },
  "value": {
    object(TypedValue)
  },
}
Fields
interval

object(TimeInterval)

The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

value

object(TypedValue)

The value of the data point.

Send feedback about...

Stackdriver Monitoring