Index
Distribution
(message)Distribution.BucketOptions
(message)Distribution.BucketOptions.Explicit
(message)Distribution.BucketOptions.Exponential
(message)Distribution.BucketOptions.Linear
(message)Distribution.Exemplar
(message)Distribution.Range
(message)LabelDescriptor
(message)LabelDescriptor.ValueType
(enum)LaunchStage
(enum)Metric
(message)MetricDescriptor
(message)MetricDescriptor.MetricDescriptorMetadata
(message)MetricDescriptor.MetricKind
(enum)MetricDescriptor.ValueType
(enum)MonitoredResource
(message)MonitoredResourceDescriptor
(message)MonitoredResourceMetadata
(message)
Distribution
Distribution
contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.
Although it is not forbidden, it is generally a bad idea to include nonfinite values (infinities or NaNs) in the population of values, as this will render the mean
and sum_of_squared_deviation
fields meaningless.
Fields  

count 
The number of values in the population. Must be nonnegative. This value must equal the sum of the values in 
mean 
The arithmetic mean of the values in the population. If 
sum_of_squared_deviation 
The sum of squared deviations from the mean of the values in the population. For values x_i this is:
Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If 
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. 
bucket_options 
Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries. 
bucket_counts[] 
Required in the Stackdriver Monitoring API v3. The values for each bucket specified in 
exemplars[] 
Must be in increasing order of 
BucketOptions
BucketOptions
describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions
does not include the number of values in each bucket.
A bucket has 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 socalled because both bounds are finite.
Fields  

Union field options . Exactly one of these three fields must be set. options can be only one of the following: 

linear_buckets 
The linear bucket. 

exponential_buckets 
The exponential buckets. 

explicit_buckets 
The explicit buckets. 
Explicit
Specifies a set of buckets with arbitrary widths.
There are size(bounds) + 1
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N1): bounds[i] Lower bound (1 <= i < N); bounds[i  1]
The bounds
field must contain at least one element. If bounds
has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
Fields  

bounds[] 
The values must be monotonically increasing. 
Exponential
Specifies an exponential 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.
There are num_finite_buckets + 2
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i  1)).
Fields  

num_finite_buckets 
Must be greater than 0. 
growth_factor 
Must be greater than 1. 
scale 
Must be greater than 0. 
Linear
Specifies a linear 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.
There are num_finite_buckets + 2
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i  1)).
Fields  

num_finite_buckets 
Must be greater than 0. 
width 
Must be greater than 0. 
offset 
Lower bound of the first bucket. 
Exemplar
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
Fields  

value 
Value of the exemplar point. This value determines to which bucket the exemplar belongs. 
timestamp 
The observation (sampling) time of the above value. 
attachments[] 
Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. 
Range
The range of the population values.
Fields  

min 
The minimum of the population values. 
max 
The maximum of the population values. 
LabelDescriptor
A description of a label.
Fields  

key 
The key for this label. The key must meet the following criteria:

value_type 
The type of data that can be assigned to the label. 
description 
A humanreadable description for the label. 
ValueType
Value types that can be used as label values.
Enums  

STRING 
A variablelength string, not to exceed 1,024 characters. This is the default value type. 
BOOL 
Boolean; true or false. 
INT64 
A 64bit signed integer. 
LaunchStage
The launch stage as defined by Google Cloud Platform Launch Stages.
Enums  

LAUNCH_STAGE_UNSPECIFIED 
Do not use this default value. 
EARLY_ACCESS 
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backwardincompatible ways, and are not guaranteed to be released. 
ALPHA 
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limiteduse tests  just like they would in normal production cases. 
BETA 
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. 
GA 
GA features are open to all developers and are considered stable and fully qualified for production use. 
DEPRECATED 
Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. 
Metric
A specific metric, identified by specifying values for all of the labels of a
.MetricDescriptor
Fields  

type 
An existing metric type, see 
labels 
The set of label values that uniquely identify this metric. All labels listed in the 
MetricDescriptor
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
Fields  

name 
The resource name of the metric descriptor. 
type 
The metric type, including its DNS name prefix. The type is not URLencoded. All userdefined metric types have the DNS name

labels[] 
The set of labels that can be used to describe a specific instance of this metric type. For example, the 
metric_kind 
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of 
value_type 
Whether the measurement is an integer, a floatingpoint number, etc. Some combinations of 
unit 
Grammar The grammar also includes these connectors:
The grammar for a unit is as follows:
Notes:

description 
A detailed description of the metric, which can be used in documentation. 
display_name 
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with uservisible concepts, such as Quota. 
metadata 
Optional. Metadata which can be used to guide usage of the metric. 
launch_stage 
Optional. The launch stage of the metric definition. 
monitored_resource_types[] 
Readonly. If present, then a 
MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
Fields  

launch_stage 
Deprecated. Must use the 
sample_period 
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. 
ingest_delay 
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. 
MetricKind
The kind of measurement. It describes how the data is reported.
Enums  

METRIC_KIND_UNSPECIFIED 
Do not use this default value. 
GAUGE 
An instantaneous measurement of a value. 
DELTA 
The change in a value during a time interval. 
CUMULATIVE 
A value accumulated over a time interval. Cumulative measurements in a time series should have 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. 
ValueType
The value type of a metric.
Enums  

VALUE_TYPE_UNSPECIFIED 
Do not use this default value. 
BOOL 
The value is a boolean. This value type can be used only if the metric kind is GAUGE . 
INT64 
The value is a signed 64bit integer. 
DOUBLE 
The value is a double precision floating point number. 
STRING 
The value is a text string. This value type can be used only if the metric kind is GAUGE . 
DISTRIBUTION 
The value is a . 
MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type
field identifies a MonitoredResourceDescriptor
object that describes the resource's schema. Information in the labels
field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor
for "gce_instance"
has labels "instance_id"
and "zone"
:
{ "type": "gce_instance",
"labels": { "instance_id": "12345678901234",
"zone": "uscentral1a" }}
Fields  

type 
Required. The monitored resource type. This field must match the 
labels 
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels 
MonitoredResourceDescriptor
An object that describes the schema of a MonitoredResource
object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance"
and specifies the use of the labels "instance_id"
and "zone"
to identify particular VM instances.
Different APIs can support different monitored resource types. APIs generally provide a list
method that returns the monitored resource descriptors used by the API.
Fields  

name 
Optional. The resource name of the monitored resource descriptor: 
type 
Required. The monitored resource type. For example, the type 
display_name 
Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, 
description 
Optional. A detailed description of the monitored resource type that might be used in documentation. 
labels[] 
Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels 
launch_stage 
Optional. The launch stage of the monitored resource definition. 
MonitoredResourceMetadata
Auxiliary metadata for a MonitoredResource
object. MonitoredResource
objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
Fields  

system_labels 
Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example:

user_labels 
Output only. A map of userdefined metadata labels. 