TypedValue

A single strongly-typed value.

JSON representation
{

  // Union field value can be only one of the following:
  "boolValue": boolean,
  "int64Value": string,
  "doubleValue": number,
  "stringValue": string,
  "distributionValue": {
    object(Distribution)
  },
  // End of list of possible types for union field value.
}
Fields
Union field value. The typed value field. value can be only one of the following:
boolValue

boolean

A Boolean value: true or false.

int64Value

string (int64 format)

A 64-bit integer. Its range is approximately ±9.2x1018.

doubleValue

number

A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.

stringValue

string

A variable-length string value.

distributionValue

object(Distribution)

A distribution value.

Distribution

Distribution contains summary statistics for a population of values and, optionally in some implementations, contains a histogram representing the distribution of those values across a specified set of histogram buckets.

The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).

Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sumOfSquaredDeviation fields meaningless.

JSON representation
{
  "count": string,
  "mean": number,
  "sumOfSquaredDeviation": number,
  "range": {
    object(Range)
  },
  "bucketOptions": {
    object(BucketOptions)
  },
  "bucketCounts": [
    string
  ],
}
Fields
count

string (int64 format)

The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucketCounts if a histogram is provided.

mean

number

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

sumOfSquaredDeviation

number

The sum of squared deviations from the mean of the values in the population. For values x_i this is:

Sum[i=1..n]((x_i - mean)^2)

Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.

If count is zero then this field must be zero.

range

object(Range)

If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.

bucketOptions

object(BucketOptions)

Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.

bucketCounts[]

string (int64 format)

Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucketOptions. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucketCounts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.

Range

The range of the population values.

JSON representation
{
  "min": number,
  "max": number,
}
Fields
min

number

The minimum of the population values.

max

number

The maximum of the population values.

BucketOptions

A Distribution object can contain a histogram of the values in the population. The bucketOptions field describes a sequence of non-overlapping buckets used for the histogram and the bucketCounts field provides the data for the histogram. In some implementations of Distribution, the histogram is optional. In other implementations, it is required.

Buckets. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

The BucketOptions object describes bucket boundaries in one of three ways. Two of the ways describe the boundaries by giving parameters for a formula to generate boundaries and the third way gives the bucket boundaries explicitly.

JSON representation
{

  // Union field options can be only one of the following:
  "linearBuckets": {
    object(Linear)
  },
  "exponentialBuckets": {
    object(Exponential)
  },
  "explicitBuckets": {
    object(Explicit)
  },
  // End of list of possible types for union field options.
}
Fields
Union field options. Exactly one of these three fields must be set. options can be only one of the following:
linearBuckets

object(Linear)

The linear bucket.

exponentialBuckets

object(Exponential)

The exponential buckets.

explicitBuckets

object(Explicit)

The explicit buckets.

Linear

Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.

Defines numFiniteBuckets + 2 (= N) buckets with these boundaries for bucket i:

Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).

JSON representation
{
  "numFiniteBuckets": number,
  "width": number,
  "offset": number,
}
Fields
numFiniteBuckets

number

Must be greater than 0.

width

number

Must be greater than 0.

offset

number

Lower bound of the first bucket.

Exponential

Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.

Defines numFiniteBuckets + 2 (= N) buckets with these boundaries for bucket i:

Upper bound (0 <= i < N-1): scale * (growthFactor ^ i). Lower bound (1 <= i < N): scale * (growthFactor ^ (i - 1)).

JSON representation
{
  "numFiniteBuckets": number,
  "growthFactor": number,
  "scale": number,
}
Fields
numFiniteBuckets

number

Must be greater than 0.

growthFactor

number

Must be greater than 1.

scale

number

Must be greater than 0.

Explicit

A set of buckets with arbitrary widths.

Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:

Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1]

There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.

JSON representation
{
  "bounds": [
    number
  ],
}
Fields
bounds[]

number

The values must be monotonically increasing.

Send feedback about...

Stackdriver Monitoring