ja-JP
ja-JP

Service: Monitoring (ntt.monitoring.v3 - v3)

Service Monitoring

Index

Resources

MonitoredResourceDescriptor

An object that describes the schema of a [MonitoredResource][google.api.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
string

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". NOTE: currently only "monitoredResourceDescriptors/{type}" form is supported.

type
string

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.

display_name
string

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, "Google Cloud SQL Database".

description
string

Optional. A detailed description of the monitored resource type that might be used in documentation.

labels
repeated LabelDescriptor

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 "database_id" and "zone".

promoted_label_key_sets
repeated LabelKeySet

Promoted Label Key Sets allow defining multiple indexing rules for underlying backend enabling query optimizations. Metric promoted label sets are combined with MonitoredResource promoted label sets and result in PromotedKeySet.

Operations

BatchGetMonitoredResourceDescriptors
rpc BatchGetMonitoredResourceDescriptors(BatchGetMonitoredResourceDescriptorsRequest) returns (BatchGetMonitoredResourceDescriptorsResponse)

BatchGetMonitoredResourceDescriptors

WatchMonitoredResourceDescriptor
rpc WatchMonitoredResourceDescriptor(WatchMonitoredResourceDescriptorRequest) returns (WatchMonitoredResourceDescriptorResponse)

WatchMonitoredResourceDescriptor

WatchMonitoredResourceDescriptors
rpc WatchMonitoredResourceDescriptors(WatchMonitoredResourceDescriptorsRequest) returns (WatchMonitoredResourceDescriptorsResponse)

WatchMonitoredResourceDescriptors

CreateMonitoredResourceDescriptor
rpc CreateMonitoredResourceDescriptor(CreateMonitoredResourceDescriptorRequest) returns (MonitoredResourceDescriptor)

CreateMonitoredResourceDescriptor

UpdateMonitoredResourceDescriptor
rpc UpdateMonitoredResourceDescriptor(UpdateMonitoredResourceDescriptorRequest) returns (MonitoredResourceDescriptor)

UpdateMonitoredResourceDescriptor

DeleteMonitoredResourceDescriptor
rpc DeleteMonitoredResourceDescriptor(DeleteMonitoredResourceDescriptorRequest) returns (Empty)

DeleteMonitoredResourceDescriptor

GetMonitoredResourceDescriptor
rpc GetMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest) returns (MonitoredResourceDescriptor)

GetMonitoredResourceDescriptor

ListMonitoredResourceDescriptors
rpc ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest) returns (ListMonitoredResourceDescriptorsResponse)

ListMonitoredResourceDescriptors

DummyMonitoredResourceDescriptorMethod
rpc DummyMonitoredResourceDescriptorMethod(DummyMonitoredResourceDescriptorMethodRequest) returns (Empty)

DummyMonitoredResourceDescriptorMethod

Messages

BatchGetMonitoredResourceDescriptorsRequest

Request message for method [BatchGetMonitoredResourceDescriptors][ntt.monitoring.v3.BatchGetMonitoredResourceDescriptors]

Fields
parent
string

Optional parent ntt.monitoring.v3.MonitoredResourceDescriptor

names
repeated string

Names of MonitoredResourceDescriptors

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetMonitoredResourceDescriptorsResponse

BatchGetMonitoredResourceDescriptorsResponse

Fields
monitored_resource_descriptors
repeated MonitoredResourceDescriptor

found MonitoredResourceDescriptors

missing
repeated string

list of not found MonitoredResourceDescriptors

WatchMonitoredResourceDescriptorRequest

Request message for method [WatchMonitoredResourceDescriptor][ntt.monitoring.v3.WatchMonitoredResourceDescriptor]

Fields
name
string

Reference to ntt.monitoring.v3.MonitoredResourceDescriptor

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchMonitoredResourceDescriptorResponse

WatchMonitoredResourceDescriptorResponse

Fields
change
MonitoredResourceDescriptorChange
WatchMonitoredResourceDescriptorsRequest

Request message for method [WatchMonitoredResourceDescriptors][ntt.monitoring.v3.WatchMonitoredResourceDescriptors]

Fields
page_size
int32

Requested page size. Server may return fewer MonitoredResourceDescriptors than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to MonitoredResourceDescriptor that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to MonitoredResourceDescriptor that don't affect any of masked fields won't be sent back.

WatchMonitoredResourceDescriptorsResponse

WatchMonitoredResourceDescriptorsResponse

Fields
monitored_resource_descriptor_changes
repeated MonitoredResourceDescriptorChange

Changes of MonitoredResourceDescriptors

page_token_change
WatchMonitoredResourceDescriptorsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchMonitoredResourceDescriptorsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateMonitoredResourceDescriptorRequest

Request message for method [CreateMonitoredResourceDescriptor][ntt.monitoring.v3.CreateMonitoredResourceDescriptor]

Fields
monitored_resource_descriptor
MonitoredResourceDescriptor

MonitoredResourceDescriptor resource body

UpdateMonitoredResourceDescriptorRequest

Request message for method [UpdateMonitoredResourceDescriptor][ntt.monitoring.v3.UpdateMonitoredResourceDescriptor]

Fields
monitored_resource_descriptor
MonitoredResourceDescriptor

MonitoredResourceDescriptor resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteMonitoredResourceDescriptorRequest

Request message for method [DeleteMonitoredResourceDescriptor][ntt.monitoring.v3.DeleteMonitoredResourceDescriptor]

Fields
name
string

Reference of ntt.monitoring.v3.MonitoredResourceDescriptor

GetMonitoredResourceDescriptorRequest

Request message for method [GetMonitoredResourceDescriptor][ntt.monitoring.v1alpha.GetMonitoredResourceDescriptor]

Fields
name
string

The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database.

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

ListMonitoredResourceDescriptorsRequest

Request message for method [ListMonitoredResourceDescriptors][ntt.monitoring.v1alpha.ListMonitoredResourceDescriptors]

Fields
filter
string

An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:

 resource.type = starts_with("gce_") AND resource.label:id
page_size
int32

A positive number that is the maximum number of results to return.

order_by
string
page_token
string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

ListMonitoredResourceDescriptorsResponse

Response message for method [ListMonitoredResourceDescriptors][ntt.monitoring.v1alpha.ListMonitoredResourceDescriptors]

Fields
monitored_resource_descriptors
repeated MonitoredResourceDescriptor

The monitored resource descriptors that are available to this project and that match filter, if present.

next_page_token
string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

prev_page_token
string
DummyMonitoredResourceDescriptorMethodRequest

Request message for method [DummyMonitoredResourceDescriptorMethod][ntt.monitoring.v1alpha.DummyMonitoredResourceDescriptorMethod]

Fields
none

Project

Project Resource

Fields
name
string

Name of Project

title
string

Operations

GetProject
rpc GetProject(GetProjectRequest) returns (Project)

GetProject

BatchGetProjects
rpc BatchGetProjects(BatchGetProjectsRequest) returns (BatchGetProjectsResponse)

BatchGetProjects

ListProjects
rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse)

ListProjects

WatchProject
rpc WatchProject(WatchProjectRequest) returns (WatchProjectResponse)

WatchProject

WatchProjects
rpc WatchProjects(WatchProjectsRequest) returns (WatchProjectsResponse)

WatchProjects

CreateProject
rpc CreateProject(CreateProjectRequest) returns (Project)

CreateProject

UpdateProject
rpc UpdateProject(UpdateProjectRequest) returns (Project)

UpdateProject

DeleteProject
rpc DeleteProject(DeleteProjectRequest) returns (Empty)

DeleteProject

Messages

GetProjectRequest

Request message for method [GetProject][ntt.monitoring.v3.GetProject]

Fields
name
string

Reference of ntt.monitoring.v3.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsRequest

Request message for method [BatchGetProjects][ntt.monitoring.v3.BatchGetProjects]

Fields
parent
string

Optional parent ntt.monitoring.v3.Project

names
repeated string

Names of Projects

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsResponse

BatchGetProjectsResponse

Fields
projects
repeated Project

found Projects

missing
repeated string

list of not found Projects

ListProjectsRequest

Request message for method [ListProjects][ntt.monitoring.v3.ListProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProjectsResponse.next_page_token][ntt.monitoring.v3.ListProjectsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProjectsResponse

Request message for method [ListProjects][ntt.monitoring.v3.ListProjects]

Fields
projects
repeated Project

The list of Projects

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.monitoring.v3.ListProjectsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.monitoring.v3.ListProjectsRequest.page_token]

WatchProjectRequest

Request message for method [WatchProject][ntt.monitoring.v3.WatchProject]

Fields
name
string

Reference to ntt.monitoring.v3.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProjectResponse

WatchProjectResponse

Fields
change
ProjectChange
WatchProjectsRequest

Request message for method [WatchProjects][ntt.monitoring.v3.WatchProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Project that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Project that don't affect any of masked fields won't be sent back.

WatchProjectsResponse

WatchProjectsResponse

Fields
project_changes
repeated ProjectChange

Changes of Projects

page_token_change
WatchProjectsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProjectsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProjectRequest

Request message for method [CreateProject][ntt.monitoring.v3.CreateProject]

Fields
project
Project

Project resource body

UpdateProjectRequest

Request message for method [UpdateProject][ntt.monitoring.v3.UpdateProject]

Fields
project
Project

Project resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProjectRequest

Request message for method [DeleteProject][ntt.monitoring.v3.DeleteProject]

Fields
name
string

Reference of ntt.monitoring.v3.Project

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
string

The resource name of the metric descriptor.

type
string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example:

 "custom.googleapis.com/invoice/paid/amount"
 "external.googleapis.com/prometheus/up"
 "appengine.googleapis.com/http/server/response_latencies"
labels
repeated LabelDescriptor

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

metric_kind
MetricDescriptor.MetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

value_type
MetricDescriptor.ValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

unit
string

The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure standard:

Basic units (UNIT)

  • bit bit
  • By byte
  • s second
  • min minute
  • h hour
  • d day

Prefixes (PREFIX)

  • k kilo (10**3)
  • M mega (10**6)
  • G giga (10**9)
  • T tera (10**12)
  • P peta (10**15)
  • E exa (10**18)
  • Z zetta (10**21)
  • Y yotta (10**24)
  • m milli (10**-3)
  • u micro (10**-6)
  • n nano (10**-9)
  • p pico (10**-12)
  • f femto (10**-15)
  • a atto (10**-18)
  • z zepto (10**-21)
  • y yocto (10**-24)
  • Ki kibi (2**10)
  • Mi mebi (2**20)
  • Gi gibi (2**30)
  • Ti tebi (2**40)

Grammar

The grammar also includes these connectors:

  • / division (as an infix operator, e.g. 1/s).
  • . multiplication (as an infix operator, e.g. GBy.d)

The grammar for a unit is as follows:

 Expression = Component { "." Component } { "/" Component } ;

 Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
           | Annotation
           | "1"
           ;

 Annotation = "{" NAME "}" ;

Notes:

  • Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
  • NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
  • 1 represents dimensionless value 1, such as in 1/s.
  • % represents dimensionless value 1/100, and annotates values giving a percentage.
description
string

A detailed description of the metric, which can be used in documentation.

display_name
string

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 user-visible concepts, such as Quota.

metadata
MetricDescriptor.MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

distribution_bucket_options
Distribution.BucketOptions

Distribution bucketing options - define only when ValueType is Distribution. Used for validating input.

promoted_label_key_sets
repeated LabelKeySet

Promoted Label Key Sets allow defining multiple indexing rules for underlying backend enabling query optimizations. Metric promoted label sets are combined with MonitoredResource promoted label sets and result in PromotedKeySet.

Operations

BatchGetMetricDescriptors
rpc BatchGetMetricDescriptors(BatchGetMetricDescriptorsRequest) returns (BatchGetMetricDescriptorsResponse)

BatchGetMetricDescriptors

WatchMetricDescriptor
rpc WatchMetricDescriptor(WatchMetricDescriptorRequest) returns (WatchMetricDescriptorResponse)

WatchMetricDescriptor

WatchMetricDescriptors
rpc WatchMetricDescriptors(WatchMetricDescriptorsRequest) returns (WatchMetricDescriptorsResponse)

WatchMetricDescriptors

UpdateMetricDescriptor
rpc UpdateMetricDescriptor(UpdateMetricDescriptorRequest) returns (MetricDescriptor)

UpdateMetricDescriptor

GetMetricDescriptor
rpc GetMetricDescriptor(GetMetricDescriptorRequest) returns (MetricDescriptor)

GetMetricDescriptor

CreateMetricDescriptor
rpc CreateMetricDescriptor(CreateMetricDescriptorRequest) returns (MetricDescriptor)

CreateMetricDescriptor

DeleteMetricDescriptor
rpc DeleteMetricDescriptor(DeleteMetricDescriptorRequest) returns (Empty)

DeleteMetricDescriptor

ListMetricDescriptors
rpc ListMetricDescriptors(ListMetricDescriptorsRequest) returns (ListMetricDescriptorsResponse)

ListMetricDescriptors

DummyMetricDescriptorMethod
rpc DummyMetricDescriptorMethod(DummyMetricDescriptorMethodRequest) returns (Empty)

DummyMetricDescriptorMethod

Messages

MetricDescriptor.MetricDescriptorMetadata

Additional annotations that can be used to guide the usage of a metric.

Fields
launch_stage
.ntt.api.LaunchStage

The launch stage of the metric definition.

BatchGetMetricDescriptorsRequest

Request message for method [BatchGetMetricDescriptors][ntt.monitoring.v3.BatchGetMetricDescriptors]

Fields
parent
string

Optional parent ntt.monitoring.v3.MetricDescriptor

names
repeated string

Names of MetricDescriptors

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetMetricDescriptorsResponse

BatchGetMetricDescriptorsResponse

Fields
metric_descriptors
repeated MetricDescriptor

found MetricDescriptors

missing
repeated string

list of not found MetricDescriptors

WatchMetricDescriptorRequest

Request message for method [WatchMetricDescriptor][ntt.monitoring.v3.WatchMetricDescriptor]

Fields
name
string

Reference to ntt.monitoring.v3.MetricDescriptor

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchMetricDescriptorResponse

WatchMetricDescriptorResponse

Fields
change
MetricDescriptorChange
WatchMetricDescriptorsRequest

Request message for method [WatchMetricDescriptors][ntt.monitoring.v3.WatchMetricDescriptors]

Fields
parent
string

Parent reference of ntt.monitoring.v3.MetricDescriptor

page_size
int32

Requested page size. Server may return fewer MetricDescriptors than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to MetricDescriptor that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to MetricDescriptor that don't affect any of masked fields won't be sent back.

WatchMetricDescriptorsResponse

WatchMetricDescriptorsResponse

Fields
metric_descriptor_changes
repeated MetricDescriptorChange

Changes of MetricDescriptors

page_token_change
WatchMetricDescriptorsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchMetricDescriptorsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

UpdateMetricDescriptorRequest

Request message for method [UpdateMetricDescriptor][ntt.monitoring.v3.UpdateMetricDescriptor]

Fields
metric_descriptor
MetricDescriptor

MetricDescriptor resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

GetMetricDescriptorRequest

Request message for method [GetMetricDescriptor][ntt.monitoring.v1alpha.GetMetricDescriptor]

Fields
name
string

The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count".

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

CreateMetricDescriptorRequest

Request message for method [CreateMetricDescriptor][ntt.monitoring.v1alpha.CreateMetricDescriptor]

Fields
parent
string

The project on which to execute the request. The format is "projects/{project_id_or_number}". TODO: enable when multi-parents are supported

metric_descriptor
MetricDescriptor

The new custom metric descriptor.

DeleteMetricDescriptorRequest

Request message for method [DeleteMetricDescriptor][ntt.monitoring.v1alpha.DeleteMetricDescriptor]

Fields
name
string

The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric".

ListMetricDescriptorsRequest

Request message for method [ListMetricDescriptors][ntt.monitoring.v1alpha.ListMetricDescriptors]

Fields
parent
string

The project on which to execute the request. The format is "projects/{project_id_or_number}". TODO: enable when multi-parents are supported

filter
string

If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

 metric.type = starts_with("custom.googleapis.com/")
page_size
int32

A positive number that is the maximum number of results to return.

page_token
string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

ListMetricDescriptorsResponse

Response message for method [ListMetricDescriptors][ntt.monitoring.v1alpha.ListMetricDescriptors]

Fields
metric_descriptors
repeated MetricDescriptor

The metric descriptors that are available to the project and that match the value of filter, if present.

next_page_token
string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

prev_page_token
string
DummyMetricDescriptorMethodRequest

Request message for method [DummyMetricDescriptorMethod][ntt.monitoring.v1alpha.DummyMetricDescriptorMethod]

Fields
parent
string

Enums

MetricDescriptor.MetricKind

The kind of measurement. It describes how the data is reported.

Values
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.

MetricDescriptor.ValueType

The value type of a metric.

Values
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 64-bit 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 [Distribution][google.api.Distribution].

MONEY

The value is money.

TimeSerie

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.

Fields
key
bytes

TimeSerie key identifies unique TimeSeries tuple: <project, metric.type, metric.labels, resource.type, resource.labels>

Kind/ValueType are not present in key Key is not to be decoded outside of service, but treated as opaque string

project
string

Internal use - for bulk reporting of TimeSeries

metric
Metric

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

resource
MonitoredResource

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

metadata
MonitoredResourceMetadata

Output only. The associated monitored resource metadata. When reading a a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored.

metric_kind
MetricDescriptor.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.

value_type
MetricDescriptor.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
repeated Point

The data points of this time series. When listing time series, points are returned in reverse time order.

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.

Operations

ListTimeSeries
rpc ListTimeSeries(ListTimeSeriesRequest) returns (ListTimeSeriesResponse)

ListTimeSeries

CreateTimeSeries
rpc CreateTimeSeries(CreateTimeSeriesRequest) returns (CreateTimeSeriesResponse)

CreateTimeSeries

DummyTimeSerieMethod
rpc DummyTimeSerieMethod(DummyTimeSerieMethodRequest) returns (Empty)

DummyTimeSerieMethod

Messages

ListTimeSeriesRequest

Request message for method [ListTimeSeries][ntt.monitoring.v1alpha.ListTimeSeries]

Fields
parent
string

The project on which to execute the request. The format is "projects/{project_id_or_number}".

filter
string

A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

 metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
     metric.label.instance_name = "my-instance-name"
interval
TimeInterval

The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

aggregation
Aggregation

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

order_by
string

Unsupported: must be left blank. The points in each time series are returned in reverse time order.

view
TimeSeriesView

Specifies which information is returned about the time series.

page_size
int32

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

page_token
string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

ListTimeSeriesResponse

Response message for method [ListTimeSeries][ntt.monitoring.v1alpha.ListTimeSeries]

Fields
time_series
repeated TimeSerie

One or more time series that match the filter included in the request.

next_page_token
string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

execution_errors
repeated .ntt.rpc.Status

Query execution errors that may have caused the time series data returned to be incomplete.

CreateTimeSeriesRequest

Request message for method [CreateTimeSeries][ntt.monitoring.v1alpha.CreateTimeSeries]

Fields
parent
string

The project on which to execute the request. The format is "projects/{project_id_or_number}".

time_series
repeated TimeSerie

The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

CreateTimeSeriesResponse

Response message for method [CreateTimeSeries][ntt.monitoring.v1alpha.CreateTimeSeries]

Fields
time_serie_keys
bytes

Time Serie keys indexed by Create position - present only when given TimeSerie didn't use Key field

DummyTimeSerieMethodRequest

Request message for method [DummyTimeSerieMethod][ntt.monitoring.v1alpha.DummyTimeSerieMethod]

Fields
parent
string

PhantomTimeSerie

PhantomTimeSerie generates data in absence of real data

Fields
metadata
.ntt.types.Meta

Common resource Metadata

name
string

Name of PhantomTimeSeries

key
bytes

TimeSerie key identifies unique TimeSeries tuple: <project, metric.type, metric.labels, resource.type, resource.labels>

Kind/ValueType are not present in key Key is not to be decoded outside of service, but treated as opaque string

project
string

Internal use - for bulk reporting of TimeSeries

metric
Metric

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

resource
MonitoredResource

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

metric_kind
MetricDescriptor.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.

value_type
MetricDescriptor.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.

value
TypedValue

Phantom value

Operations

GetPhantomTimeSerie
rpc GetPhantomTimeSerie(GetPhantomTimeSerieRequest) returns (PhantomTimeSerie)

GetPhantomTimeSerie

BatchGetPhantomTimeSeries
rpc BatchGetPhantomTimeSeries(BatchGetPhantomTimeSeriesRequest) returns (BatchGetPhantomTimeSeriesResponse)

BatchGetPhantomTimeSeries

ListPhantomTimeSeries
rpc ListPhantomTimeSeries(ListPhantomTimeSeriesRequest) returns (ListPhantomTimeSeriesResponse)

ListPhantomTimeSeries

WatchPhantomTimeSerie
rpc WatchPhantomTimeSerie(WatchPhantomTimeSerieRequest) returns (WatchPhantomTimeSerieResponse)

WatchPhantomTimeSerie

WatchPhantomTimeSeries
rpc WatchPhantomTimeSeries(WatchPhantomTimeSeriesRequest) returns (WatchPhantomTimeSeriesResponse)

WatchPhantomTimeSeries

CreatePhantomTimeSerie
rpc CreatePhantomTimeSerie(CreatePhantomTimeSerieRequest) returns (PhantomTimeSerie)

CreatePhantomTimeSerie

DeletePhantomTimeSerie
rpc DeletePhantomTimeSerie(DeletePhantomTimeSerieRequest) returns (Empty)

DeletePhantomTimeSerie

Messages

GetPhantomTimeSerieRequest

Request message for method [GetPhantomTimeSerie][ntt.monitoring.v3.GetPhantomTimeSerie]

Fields
name
string

Reference of ntt.monitoring.v3.PhantomTimeSerie

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetPhantomTimeSeriesRequest

Request message for method [BatchGetPhantomTimeSeries][ntt.monitoring.v3.BatchGetPhantomTimeSeries]

Fields
parent
string

Optional parent ntt.monitoring.v3.PhantomTimeSerie

names
repeated string

Names of PhantomTimeSeries

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetPhantomTimeSeriesResponse

BatchGetPhantomTimeSeriesResponse

Fields
phantom_time_series
repeated PhantomTimeSerie

found PhantomTimeSeries

missing
repeated string

list of not found PhantomTimeSeries

ListPhantomTimeSeriesRequest

Request message for method [ListPhantomTimeSeries][ntt.monitoring.v3.ListPhantomTimeSeries]

Fields
parent
string

Parent name of ntt.monitoring.v3.PhantomTimeSerie

page_size
int32

Requested page size. Server may return fewer PhantomTimeSeries than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListPhantomTimeSeriesResponse.next_page_token][ntt.monitoring.v3.ListPhantomTimeSeriesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListPhantomTimeSeriesResponse

Request message for method [ListPhantomTimeSeries][ntt.monitoring.v3.ListPhantomTimeSeries]

Fields
phantom_time_series
repeated PhantomTimeSerie

The list of PhantomTimeSeries

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListPhantomTimeSeriesRequest.page_token][ntt.monitoring.v3.ListPhantomTimeSeriesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListPhantomTimeSeriesRequest.page_token][ntt.monitoring.v3.ListPhantomTimeSeriesRequest.page_token]

WatchPhantomTimeSerieRequest

Request message for method [WatchPhantomTimeSerie][ntt.monitoring.v3.WatchPhantomTimeSerie]

Fields
name
string

Reference to ntt.monitoring.v3.PhantomTimeSerie

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchPhantomTimeSerieResponse

WatchPhantomTimeSerieResponse

Fields
change
PhantomTimeSerieChange
WatchPhantomTimeSeriesRequest

Request message for method [WatchPhantomTimeSeries][ntt.monitoring.v3.WatchPhantomTimeSeries]

Fields
parent
string

Parent reference of ntt.monitoring.v3.PhantomTimeSerie

page_size
int32

Requested page size. Server may return fewer PhantomTimeSeries than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to PhantomTimeSerie that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to PhantomTimeSerie that don't affect any of masked fields won't be sent back.

WatchPhantomTimeSeriesResponse

WatchPhantomTimeSeriesResponse

Fields
phantom_time_serie_changes
repeated PhantomTimeSerieChange

Changes of PhantomTimeSeries

page_token_change
WatchPhantomTimeSeriesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchPhantomTimeSeriesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreatePhantomTimeSerieRequest

Request message for method [CreatePhantomTimeSerie][ntt.monitoring.v3.CreatePhantomTimeSerie]

Fields
parent
string

Parent reference of ntt.monitoring.v3.PhantomTimeSerie

phantom_time_serie
PhantomTimeSerie

PhantomTimeSerie resource body

DeletePhantomTimeSerieRequest

Request message for method [DeletePhantomTimeSerie][ntt.monitoring.v3.DeletePhantomTimeSerie]

Fields
name
string

Reference of ntt.monitoring.v3.PhantomTimeSerie

Shared Resources

Operations
Messages
Aggregation

Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation.

Fields
alignment_period
.google.protobuf.Duration

The alignment period for per-[time series][ntt.monitoring.v3.TimeSeries] alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.

per_series_aligner
Aggregation.Aligner

The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.

Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

cross_series_reducer
Aggregation.Reducer

The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.

Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

group_by_fields
repeated string

The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.

BulkTimeSeries

Used for reporting rollups

Fields
time_series
repeated TimeSerie
CreateTimeSeriesError

Describes the result of a failed request to write data to a time series.

Fields
time_series
TimeSerie

The time series, including the Metric, MonitoredResource, and Points (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation.

status
.ntt.rpc.Status

The status of the requested write operation.

Distribution

Distribution contains summary statistics for a population of values and, optionally, 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 sum_of_squared_deviation fields meaningless.

Fields
count
int64

The number of values in the population. Must be non-negative.

mean
double

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

sum_of_squared_deviation
double

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
Distribution.Range

If specified, contains the range of the population values. The field must not be present if the count is zero.

bucket_options
Distribution.BucketOptions

Defines the histogram bucket boundaries.

bucket_counts
repeated int64

If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.

Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).

The size of bucket_counts must be no greater than N as defined in bucket_options.

Any suffix of trailing zero bucket_count fields may be omitted.

Distribution.BucketOptions

A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.

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 is 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.

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

If bucket_boundaries is not given, then no bucket_counts may be given.

Fields
linear_buckets
Distribution.BucketOptions.Linear

The linear bucket.

exponential_buckets
Distribution.BucketOptions.Exponential

The exponential buckets.

explicit_buckets
Distribution.BucketOptions.Explicit

The explicit buckets.

Distribution.BucketOptions.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.

Fields
bounds
repeated double

The values must be monotonically increasing.

Distribution.BucketOptions.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 num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:

Upper bound (0 <= i < N-1):     scale * (growth_factor ^ i).
Lower bound (1 <= i < N):       scale * (growth_factor ^ (i - 1)).
Fields
num_finite_buckets
int32

Must be greater than 0.

growth_factor
double

Must be greater than 1.

scale
double

Must be greater than 0.

Distribution.BucketOptions.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 num_finite_buckets + 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)).
Fields
num_finite_buckets
int32

Must be greater than 0.

width
double

Must be greater than 0.

offset
double

Lower bound of the first bucket.

Distribution.Range

The range of the population values.

Fields
min
double

The minimum of the population values.

max
double

The maximum of the population values.

LabelDescriptor

A description of a label.

Fields
key
string

The label key.

value_type
LabelDescriptor.ValueType

The type of data that can be assigned to the label.

description
string

A human-readable description for the label.

default_value
string

Default value for string label - this value is used in two cases:

  1. to populate missing labels while creating TimeSeries
  2. to populate missing remaining kvs while querying TimeSeries - usually applies to old data
LabelKeySet

LabelKeySet is used for defining PromotedLabelKeySets on Metric descriptors

Fields
label_keys
repeated string
write_only
bool

if set, index will not be considered for queries, but will be written to. useful for transition periods.

Metric

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

Fields
type
string

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

labels
string

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

reduced_labels
repeated string

reduced labels in aggregations

MetricDescriptorChange

MetricDescriptorChange is used by Watch notifications Responses to describe change of single MetricDescriptor One of Added, Modified, Removed

Fields
added
MetricDescriptorChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
MetricDescriptorChange.Modified

Modified is returned when watched document is modified

removed
MetricDescriptorChange.Removed

Removed is returned when MetricDescriptor is deleted or leaves Query view

MetricDescriptorChange.Added

MetricDescriptor has been added to query view

Fields
metric_descriptor
MetricDescriptor
view_index
int32

Integer describing index of added MetricDescriptor in resulting query view.

MetricDescriptorChange.Modified

MetricDescriptor changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified MetricDescriptor

metric_descriptor
MetricDescriptor

New version of MetricDescriptor or masked difference, depending on mask_changes instrumentation of issued [WatchMetricDescriptorRequest] or [WatchMetricDescriptorsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified MetricDescriptor. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying MetricDescriptor new index in resulting query view.

MetricDescriptorChange.Removed

Removed is returned when MetricDescriptor is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed MetricDescriptor index.

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][google.api.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][google.api.MonitoredResourceDescriptor] for "gce_instance" has labels "instance_id" and "zone":

 { "type": "gce_instance",
   "labels": { "instance_id": "12345678901234",
               "zone": "us-central1-a" }}
Fields
type
string

Required. The monitored resource type. This field must match the type field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Compute Engine VM instance is gce_instance.

labels
string

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".

reduced_labels
repeated string

reduced labels in aggregations

MonitoredResourceDescriptorChange

MonitoredResourceDescriptorChange is used by Watch notifications Responses to describe change of single MonitoredResourceDescriptor One of Added, Modified, Removed

Fields
added
MonitoredResourceDescriptorChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
MonitoredResourceDescriptorChange.Modified

Modified is returned when watched document is modified

removed
MonitoredResourceDescriptorChange.Removed

Removed is returned when MonitoredResourceDescriptor is deleted or leaves Query view

MonitoredResourceDescriptorChange.Added

MonitoredResourceDescriptor has been added to query view

Fields
monitored_resource_descriptor
MonitoredResourceDescriptor
view_index
int32

Integer describing index of added MonitoredResourceDescriptor in resulting query view.

MonitoredResourceDescriptorChange.Modified

MonitoredResourceDescriptor changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified MonitoredResourceDescriptor

monitored_resource_descriptor
MonitoredResourceDescriptor

New version of MonitoredResourceDescriptor or masked difference, depending on mask_changes instrumentation of issued [WatchMonitoredResourceDescriptorRequest] or [WatchMonitoredResourceDescriptorsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified MonitoredResourceDescriptor. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying MonitoredResourceDescriptor new index in resulting query view.

MonitoredResourceDescriptorChange.Removed

Removed is returned when MonitoredResourceDescriptor is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed MonitoredResourceDescriptor index.

MonitoredResourceMetadata

Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object. [MonitoredResource][google.api.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
user_labels
string

Output only. A map of user-defined metadata labels.

PhantomTimeSerieChange

PhantomTimeSerieChange is used by Watch notifications Responses to describe change of single PhantomTimeSerie One of Added, Modified, Removed

Fields
added
PhantomTimeSerieChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
PhantomTimeSerieChange.Modified

Modified is returned when watched document is modified

removed
PhantomTimeSerieChange.Removed

Removed is returned when PhantomTimeSerie is deleted or leaves Query view

PhantomTimeSerieChange.Added

PhantomTimeSerie has been added to query view

Fields
phantom_time_serie
PhantomTimeSerie
view_index
int32

Integer describing index of added PhantomTimeSerie in resulting query view.

PhantomTimeSerieChange.Modified

PhantomTimeSerie changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified PhantomTimeSerie

phantom_time_serie
PhantomTimeSerie

New version of PhantomTimeSerie or masked difference, depending on mask_changes instrumentation of issued [WatchPhantomTimeSerieRequest] or [WatchPhantomTimeSeriesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified PhantomTimeSerie. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying PhantomTimeSerie new index in resulting query view.

PhantomTimeSerieChange.Removed

Removed is returned when PhantomTimeSerie is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed PhantomTimeSerie index.

PhantomTimeSeriesBulkChange
Fields
resync
bool

add partitioning information (e.g. project, hash key to invalidate whole group upon resync)

partition
bytes

partition identifier (e.g. project, key_hash)

added
repeated PhantomTimeSerie
removed
repeated PhantomTimeSerie
Point

A single data point in a time series.

Fields
interval
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
TypedValue

The value of the data point.

aggregation
Aggregation

Additional aggregation info Used internally for batching rollup points

ProjectChange

ProjectChange is used by Watch notifications Responses to describe change of single Project One of Added, Modified, Removed

Fields
added
ProjectChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProjectChange.Modified

Modified is returned when watched document is modified

removed
ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

ProjectChange.Added

Project has been added to query view

Fields
project
Project
view_index
int32

Integer describing index of added Project in resulting query view.

ProjectChange.Modified

Project changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Project

project
Project

New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Project. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Project new index in resulting query view.

ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Project index.

TimeInterval

A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.

Fields
end_time
.google.protobuf.Timestamp

Required. The end of the time interval.

start_time
.google.protobuf.Timestamp

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

TypedValue

A single strongly-typed value.

Fields
bool_value
bool

A Boolean value: true or false.

int64_value
int64

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

double_value
double

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

string_value
string

A variable-length string value.

distribution_value
Distribution

A distribution value.

Enums

Aggregation.Aligner

The Aligner describes how to bring the data points in a single time series into temporal alignment.

Values
ALIGN_NONE

No alignment. Raw data is returned. Not valid if cross-time series reduction is requested. The value type of the result is the same as the value type of the input.

ALIGN_DELTA

Align and convert to delta metric type. This alignment is valid for cumulative metrics and delta metrics. Aligning an existing delta metric to a delta metric requires that the alignment period be increased. The value type of the result is the same as the value type of the input.

One can think of this aligner as a rate but without time units; that is, the output is conceptually (second_point - first_point).

ALIGN_RATE

Align and convert to a rate. This alignment is valid for cumulative metrics and delta metrics with numeric values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

One can think of this aligner as conceptually providing the slope of the line that passes through the value at the start and end of the window. In other words, this is conceptually ((y1 - y0)/(t1 - t0)), and the output unit is one that has a "/time" dimension.

If, by rate, you are looking for percentage change, see the ALIGN_PERCENT_CHANGE aligner option.

ALIGN_INTERPOLATE

Align by interpolating between adjacent points around the period boundary. This alignment is valid for gauge metrics with numeric values. The value type of the result is the same as the value type of the input.

ALIGN_NEXT_OLDER

Align by shifting the oldest data point before the period boundary to the boundary. This alignment is valid for gauge metrics. The value type of the result is the same as the value type of the input.

ALIGN_MIN

Align time series via aggregation. The resulting data point in the alignment period is the minimum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.

ALIGN_MAX

Align time series via aggregation. The resulting data point in the alignment period is the maximum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.

ALIGN_MEAN

Align time series via aggregation. The resulting data point in the alignment period is the average or arithmetic mean of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_COUNT

Align time series via aggregation. The resulting data point in the alignment period is the count of all data points in the period. This alignment is valid for gauge and delta metrics with numeric or Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

ALIGN_SUM

Align time series via aggregation. The resulting data point in the alignment period is the sum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.

ALIGN_STDDEV

Align time series via aggregation. The resulting data point in the alignment period is the standard deviation of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_COUNT_TRUE

Align time series via aggregation. The resulting data point in the alignment period is the count of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

ALIGN_COUNT_FALSE

Align time series via aggregation. The resulting data point in the alignment period is the count of False-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

ALIGN_FRACTION_TRUE

Align time series via aggregation. The resulting data point in the alignment period is the fraction of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The output value is in the range [0, 1] and has value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_PERCENTILE_99

Align time series via aggregation. The resulting data point in the alignment period is the 99th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_PERCENTILE_95

Align time series via aggregation. The resulting data point in the alignment period is the 95th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_PERCENTILE_50

Align time series via aggregation. The resulting data point in the alignment period is the 50th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_PERCENTILE_05

Align time series via aggregation. The resulting data point in the alignment period is the 5th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

ALIGN_PERCENT_CHANGE

Align and convert to a percentage change. This alignment is valid for gauge and delta metrics with numeric values. This alignment conceptually computes the equivalent of "((current - previous)/previous)*100" where previous value is determined based on the alignmentPeriod. In the event that previous is 0 the calculated value is infinity with the exception that if both (current - previous) and previous are 0 the calculated value is 0. A 10 minute moving mean is computed at each point of the time window prior to the above calculation to smooth the metric and prevent false positives from very short lived spikes. Only applicable for data that is >= 0. Any values < 0 are treated as no data. While delta metrics are accepted by this alignment special care should be taken that the values for the metric will always be positive. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Aggregation.Reducer

A Reducer describes how to aggregate data points from multiple time series into a single time series.

Values
REDUCE_NONE

No cross-time series reduction. The output of the aligner is returned.

REDUCE_MEAN

Reduce by computing the mean across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

REDUCE_MIN

Reduce by computing the minimum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.

REDUCE_MAX

Reduce by computing the maximum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.

REDUCE_SUM

Reduce by computing the sum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.

REDUCE_STDDEV

Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

REDUCE_COUNT

Reduce by computing the count of data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of numeric, Boolean, distribution, and string value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

REDUCE_COUNT_TRUE

Reduce by computing the count of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

REDUCE_COUNT_FALSE

Reduce by computing the count of False-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

REDUCE_FRACTION_TRUE

Reduce by computing the fraction of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The output value is in the range [0, 1] and has value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

REDUCE_PERCENTILE_99

Reduce by computing 99th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

REDUCE_PERCENTILE_95

Reduce by computing 95th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

REDUCE_PERCENTILE_50

Reduce by computing 50th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

REDUCE_PERCENTILE_05

Reduce by computing 5th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

LabelDescriptor.ValueType

Value types that can be used as label values.

Values
STRING

A variable-length string. This is the default.

BOOL

Boolean; true or false.

INT64

A 64-bit signed integer.

TimeSeriesView

Controls which fields are returned by ListTimeSeries.

Values
FULL

Returns the identity of the metric(s), the time series, and the time series data.

HEADERS

Returns the identity of the metric and the time series resource, but not the time series data.