Timeseries

For a list of methods for this resource, see the end of this page.

Resource representations

The monitoring data is organized as metrics and stored as data points that are recorded over time. Each data point represents information like the CPU utilization of your virtual machine. A historical record of these data points is called a time series.

{
  "timeseriesDesc": timeseriesDescriptors Resource,
  "points": [
    {
      "start": datetime,
      "end": datetime,
      "boolValue": boolean,
      "int64Value": long,
      "doubleValue": double,
      "stringValue": string,
      "distributionValue": {
        "underflowBucket": {
          "upperBound": double,
          "count": long
        },
        "buckets": [
          {
            "lowerBound": double,
            "upperBound": double,
            "count": long
          }
        ],
        "overflowBucket": {
          "lowerBound": double,
          "count": long
        }
      }
    }
  ]
}
Property name Value Description Notes
points[] list The data points of this time series. The points are listed in order of their end timestamp, from younger to older.
points[].boolValue boolean The value of this data point. Either "true" or "false".
points[].distributionValue nested object The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram.
points[].distributionValue.buckets[] list The finite buckets.
points[].distributionValue.buckets[].count long The number of events whose values are in the interval defined by this bucket.
points[].distributionValue.buckets[].lowerBound double The lower bound of the value interval of this bucket (inclusive).
points[].distributionValue.buckets[].upperBound double The upper bound of the value interval of this bucket (exclusive).
points[].distributionValue.overflowBucket nested object The overflow bucket.
points[].distributionValue.overflowBucket.count long The number of events whose values are in the interval defined by this bucket.
points[].distributionValue.overflowBucket.lowerBound double The lower bound of the value interval of this bucket (inclusive).
points[].distributionValue.underflowBucket nested object The underflow bucket.
points[].distributionValue.underflowBucket.count long The number of events whose values are in the interval defined by this bucket.
points[].distributionValue.underflowBucket.upperBound double The upper bound of the value interval of this bucket (exclusive).
points[].doubleValue double The value of this data point as a double-precision floating-point number.
points[].end datetime The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
points[].int64Value long The value of this data point as a 64-bit integer.
points[].start datetime The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
points[].stringValue string The value of this data point in string format.
timeseriesDesc nested object The descriptor of this time series.

Methods

list
List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
write

Write data points to one or more time series for one or more metrics.

See custom metrics for details of the use of this API.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Stackdriver Monitoring