Package google.monitoring.v3

Index

AlertPolicyService

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.

CreateAlertPolicy

rpc CreateAlertPolicy(CreateAlertPolicyRequest) returns (AlertPolicy)

Creates a new alerting policy.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteAlertPolicy

rpc DeleteAlertPolicy(DeleteAlertPolicyRequest) returns (Empty)

Deletes an alerting policy.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetAlertPolicy

rpc GetAlertPolicy(GetAlertPolicyRequest) returns (AlertPolicy)

Gets a single alerting policy.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListAlertPolicies

rpc ListAlertPolicies(ListAlertPoliciesRequest) returns (ListAlertPoliciesResponse)

Lists the existing alerting policies for the project.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

UpdateAlertPolicy

rpc UpdateAlertPolicy(UpdateAlertPolicyRequest) returns (AlertPolicy)

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GroupService

The Group API lets you inspect and manage your groups.

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

CreateGroup

rpc CreateGroup(CreateGroupRequest) returns (Group)

Creates a new group.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteGroup

rpc DeleteGroup(DeleteGroupRequest) returns (Empty)

Deletes an existing group.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetGroup

rpc GetGroup(GetGroupRequest) returns (Group)

Gets a single group.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListGroupMembers

rpc ListGroupMembers(ListGroupMembersRequest) returns (ListGroupMembersResponse)

Lists the monitored resources that are members of a group.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListGroups

rpc ListGroups(ListGroupsRequest) returns (ListGroupsResponse)

Lists the existing groups.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

UpdateGroup

rpc UpdateGroup(UpdateGroupRequest) returns (Group)

Updates an existing group. You can change any group attributes except name.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

MetricService

Manages metric descriptors, monitored resource descriptors, and time series data.

CreateMetricDescriptor

rpc CreateMetricDescriptor(CreateMetricDescriptorRequest) returns (MetricDescriptor)

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

CreateTimeSeries

rpc CreateTimeSeries(CreateTimeSeriesRequest) returns (Empty)

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

DeleteMetricDescriptor

rpc DeleteMetricDescriptor(DeleteMetricDescriptorRequest) returns (Empty)

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetMetricDescriptor

rpc GetMetricDescriptor(GetMetricDescriptorRequest) returns (MetricDescriptor)

Gets a single metric descriptor. This method does not require a Stackdriver account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

GetMonitoredResourceDescriptor

rpc GetMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest) returns (MonitoredResourceDescriptor)

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

ListMetricDescriptors

rpc ListMetricDescriptors(ListMetricDescriptorsRequest) returns (ListMetricDescriptorsResponse)

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

ListMonitoredResourceDescriptors

rpc ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest) returns (ListMonitoredResourceDescriptorsResponse)

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.

ListTimeSeries

rpc ListTimeSeries(ListTimeSeriesRequest) returns (ListTimeSeriesResponse)

Lists time series that match a filter. This method does not require a Stackdriver account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

NotificationChannelService

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

CreateNotificationChannel

rpc CreateNotificationChannel(CreateNotificationChannelRequest) returns (NotificationChannel)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteNotificationChannel

rpc DeleteNotificationChannel(DeleteNotificationChannelRequest) returns (Empty)

Deletes a notification channel.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetNotificationChannel

rpc GetNotificationChannel(GetNotificationChannelRequest) returns (NotificationChannel)

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

GetNotificationChannelDescriptor

rpc GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest) returns (NotificationChannelDescriptor)

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

GetNotificationChannelVerificationCode

rpc GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest) returns (GetNotificationChannelVerificationCodeResponse)

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).

There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

ListNotificationChannelDescriptors

rpc ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest) returns (ListNotificationChannelDescriptorsResponse)

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListNotificationChannels

rpc ListNotificationChannels(ListNotificationChannelsRequest) returns (ListNotificationChannelsResponse)

Lists the notification channels that have been created for the project.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

SendNotificationChannelVerificationCode

rpc SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest) returns (Empty)

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

UpdateNotificationChannel

rpc UpdateNotificationChannel(UpdateNotificationChannelRequest) returns (NotificationChannel)

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

VerifyNotificationChannel

rpc VerifyNotificationChannel(VerifyNotificationChannelRequest) returns (NotificationChannel)

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

ServiceMonitoringService

The Stackdriver Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

CreateService

rpc CreateService(CreateServiceRequest) returns (Service)

Create a Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

CreateServiceLevelObjective

rpc CreateServiceLevelObjective(CreateServiceLevelObjectiveRequest) returns (ServiceLevelObjective)

Create a ServiceLevelObjective for the given Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteService

rpc DeleteService(DeleteServiceRequest) returns (Empty)

Soft delete this Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteServiceLevelObjective

rpc DeleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest) returns (Empty)

Delete the given ServiceLevelObjective.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetService

rpc GetService(GetServiceRequest) returns (Service)

Get the named Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

GetServiceLevelObjective

rpc GetServiceLevelObjective(GetServiceLevelObjectiveRequest) returns (ServiceLevelObjective)

Get a ServiceLevelObjective by name.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListServiceLevelObjectives

rpc ListServiceLevelObjectives(ListServiceLevelObjectivesRequest) returns (ListServiceLevelObjectivesResponse)

List the ServiceLevelObjectives for the given Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListServices

rpc ListServices(ListServicesRequest) returns (ListServicesResponse)

List Services for this workspace.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

UpdateService

rpc UpdateService(UpdateServiceRequest) returns (Service)

Update this Service.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

UpdateServiceLevelObjective

rpc UpdateServiceLevelObjective(UpdateServiceLevelObjectiveRequest) returns (ServiceLevelObjective)

Update the given ServiceLevelObjective.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

UptimeCheckService

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud Console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

CreateUptimeCheckConfig

rpc CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest) returns (UptimeCheckConfig)

Creates a new Uptime check configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

DeleteUptimeCheckConfig

rpc DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest) returns (Empty)

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

GetUptimeCheckConfig

rpc GetUptimeCheckConfig(GetUptimeCheckConfigRequest) returns (UptimeCheckConfig)

Gets a single Uptime check configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListUptimeCheckConfigs

rpc ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest) returns (ListUptimeCheckConfigsResponse)

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

ListUptimeCheckIps

rpc ListUptimeCheckIps(ListUptimeCheckIpsRequest) returns (ListUptimeCheckIpsResponse)

Returns the list of IP addresses that checkers run from

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Authentication Overview.

UpdateUptimeCheckConfig

rpc UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest) returns (UptimeCheckConfig)

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring

For more information, see the Authentication Overview.

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

Duration

The alignment period for per-time series 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

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

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[]

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.

Aligner

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

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

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

Reducer

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

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

AlertPolicy

A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting.

Fields
name

string

Required if the policy exists. The resource name for this policy. The syntax is:

projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

[ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

display_name

string

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

documentation

Documentation

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

user_labels

map<string, string>

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

conditions[]

Condition

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions.

combiner

ConditionCombinerType

How to combine the results of multiple conditions to determine if an incident should be opened.

enabled

BoolValue

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

validity

Status

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

notification_channels[]

string

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The syntax of the entries in this field is:

projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]

creation_record

MutationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

mutation_record

MutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

Condition

A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.

Fields
name

string

Required if the condition exists. The unique resource name for this condition. Its syntax is:

projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]

[CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.

When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.

When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.

Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.

display_name

string

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.

Union field condition. Only one of the following condition types will be specified. condition can be only one of the following:
condition_threshold

MetricThreshold

A condition that compares a time series against a threshold.

condition_absent

MetricAbsence

A condition that checks that a time series continues to receive new data points.

MetricAbsence

A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration.

Fields
filter

string

A filter that identifies which time series should be compared with the threshold.

The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.

aggregations[]

Aggregation

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.

This field is similar to the one in the ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

duration

Duration

The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.

trigger

Trigger

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations.

MetricThreshold

A condition type that compares a collection of time series against a threshold.

Fields
filter

string

A filter that identifies which time series should be compared with the threshold.

The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.

aggregations[]

Aggregation

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.

This field is similar to the one in the ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

denominator_filter

string

A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.

The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.

denominator_aggregations[]

Aggregation

Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).

When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.

comparison

ComparisonType

The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side.

Only COMPARISON_LT and COMPARISON_GT are supported currently.

threshold_value

double

A value against which to compare the time series.

duration

Duration

The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.

trigger

Trigger

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

Trigger

Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used.

Fields
Union field type. A type of trigger. type can be only one of the following:
count

int32

The absolute number of time series that must fail the predicate for the condition to be triggered.

percent

double

The percentage of time series that must fail the predicate for the condition to be triggered.

ConditionCombinerType

Operators for combining conditions.

Enums
COMBINE_UNSPECIFIED An unspecified combiner.
AND Combine conditions using the logical AND operator. An incident is created only if all conditions are met simultaneously. This combiner is satisfied if all conditions are met, even if they are met on completely different resources.
OR Combine conditions using the logical OR operator. An incident is created if any of the listed conditions is met.
AND_WITH_MATCHING_RESOURCE Combine conditions using logical AND operator, but unlike the regular AND option, an incident is created only if all conditions are met simultaneously on at least one resource.

Documentation

A content string and a MIME type that describes the content string's format.

Fields
content

string

The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.

mime_type

string

The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

BasicSli

An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.

Fields
method[]

string

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

location[]

string

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

version[]

string

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

Union field sli_criteria. This SLI can be evaluated on the basis of availability or latency. sli_criteria can be only one of the following:
availability

AvailabilityCriteria

Good service is defined to be the count of requests made to this service that return successfully.

latency

LatencyCriteria

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

AvailabilityCriteria

Future parameters for the availability SLI.

LatencyCriteria

Parameters for a latency threshold SLI.

Fields
threshold

Duration

Good service is defined to be the count of requests made to this service that return in no more than threshold.

ComparisonType

Specifies an ordering relationship on two arguments, here called left and right.

Enums
COMPARISON_UNSPECIFIED No ordering relationship is specified.
COMPARISON_GT The left argument is greater than the right argument.
COMPARISON_GE The left argument is greater than or equal to the right argument.
COMPARISON_LT The left argument is less than the right argument.
COMPARISON_LE The left argument is less than or equal to the right argument.
COMPARISON_EQ The left argument is equal to the right argument.
COMPARISON_NE The left argument is not equal to the right argument.

CreateAlertPolicyRequest

The protocol for the CreateAlertPolicy request.

Fields
name

string

The project in which to create the alerting policy. The format is projects/[PROJECT_ID].

Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.alertPolicies.create

alert_policy

AlertPolicy

The requested alerting policy. You should omit the name field in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value.

CreateGroupRequest

The CreateGroup request.

Fields
name

string

The project in which to create the group. The format is "projects/{project_id_or_number}".

group

Group

A group definition. It is an error to define the name field because the system assigns the name.

validate_only

bool

If true, validate this request but do not create the group.

CreateMetricDescriptorRequest

The CreateMetricDescriptor request.

Fields
name

string

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

metric_descriptor

MetricDescriptor

The new custom metric descriptor.

CreateNotificationChannelRequest

The CreateNotificationChannel request.

Fields
name

string

The project on which to execute the request. The format is:

projects/[PROJECT_ID]

Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.create

notification_channel

NotificationChannel

The definition of the NotificationChannel to create.

CreateServiceLevelObjectiveRequest

The CreateServiceLevelObjective request.

Fields
parent

string

Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}.

service_level_objective_id

string

Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9-]+

service_level_objective

ServiceLevelObjective

The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.

CreateServiceRequest

The CreateService request.

Fields
parent

string

Resource name of the parent workspace. Of the form projects/{project_id}.

service_id

string

Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9-]+

service

Service

The Service to create.

CreateTimeSeriesError

DEPRECATED. Used to hold per-time-series error status.

Fields
time_series
(deprecated)

TimeSeries

DEPRECATED. Time series ID that resulted in the status error.

status
(deprecated)

Status

DEPRECATED. The status of the requested write operation for time_series.

CreateTimeSeriesRequest

The CreateTimeSeries request.

Fields
name

string

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

time_series[]

TimeSeries

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.

The maximum number of TimeSeries objects per Create request is 200.

CreateTimeSeriesSummary

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

Fields
total_point_count

int32

The number of points in the request.

success_point_count

int32

The number of points that were successfully written.

errors[]

Error

The number of points that failed to be written. Order is not guaranteed.

Error

Detailed information about an error category.

Fields
status

Status

The status of the requested write operation.

point_count

int32

The number of points that couldn't be written because of status.

CreateUptimeCheckConfigRequest

The protocol for the CreateUptimeCheckConfig request.

Fields
parent

string

The project in which to create the Uptime check. The format is projects/[PROJECT_ID].

Authorization requires the following Google IAM permission on the specified resource parent:

  • monitoring.uptimeCheckConfigs.create

uptime_check_config

UptimeCheckConfig

The new Uptime check configuration.

DeleteAlertPolicyRequest

The protocol for the DeleteAlertPolicy request.

Fields
name

string

The alerting policy to delete. The format is:

projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.alertPolicies.delete

DeleteGroupRequest

The DeleteGroup request. The default behavior is to be able to delete a single group without any descendants.

Fields
name

string

The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}".

recursive

bool

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

DeleteMetricDescriptorRequest

The DeleteMetricDescriptor request.

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

DeleteNotificationChannelRequest

The DeleteNotificationChannel request.

Fields
name

string

The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.delete

force

bool

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

DeleteServiceLevelObjectiveRequest

The DeleteServiceLevelObjective request.

Fields
name

string

Resource name of the ServiceLevelObjective to delete. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}.

DeleteServiceRequest

The DeleteService request.

Fields
name

string

Resource name of the Service to delete. Of the form projects/{project_id}/service/{service_id}.

DeleteUptimeCheckConfigRequest

The protocol for the DeleteUptimeCheckConfig request.

Fields
name

string

The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.uptimeCheckConfigs.delete

DistributionCut

A DistributionCut defines a TimeSeries and thresholds used for measuring good service and total service. The TimeSeries must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE. The computed good_service will be the count of values x in the Distribution such that range.min <= x < range.max.

Fields
distribution_filter

string

A monitoring filter specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.

range

Range

Range of values considered "good." For a one-sided range, set one bound to an infinite value.

DroppedLabels

A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.

These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.

Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.

Fields
label

map<string, string>

Map from label to its value, for all labels dropped in any aggregation.

GetAlertPolicyRequest

The protocol for the GetAlertPolicy request.

Fields
name

string

The alerting policy to retrieve. The format is

projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.alertPolicies.get

GetGroupRequest

The GetGroup request.

Fields
name

string

The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}".

GetMetricDescriptorRequest

The GetMetricDescriptor request.

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

GetMonitoredResourceDescriptorRequest

The GetMonitoredResourceDescriptor request.

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.

GetNotificationChannelDescriptorRequest

The GetNotificationChannelDescriptor response.

Fields
name

string

The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}.

GetNotificationChannelRequest

The GetNotificationChannel request.

Fields
name

string

The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.get

GetNotificationChannelVerificationCodeRequest

The GetNotificationChannelVerificationCode request.

Fields
name

string

The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.getVerificationCode

expire_time

Timestamp

The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).

GetNotificationChannelVerificationCodeResponse

The GetNotificationChannelVerificationCode request.

Fields
code

string

The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number).

expire_time

Timestamp

The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration.

GetServiceLevelObjectiveRequest

The GetServiceLevelObjective request.

Fields
name

string

Resource name of the ServiceLevelObjective to get. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}.

view

View

View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.

GetServiceRequest

The GetService request.

Fields
name

string

Resource name of the Service. Of the form projects/{project_id}/services/{service_id}.

GetUptimeCheckConfigRequest

The protocol for the GetUptimeCheckConfig request.

Fields
name

string

The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.uptimeCheckConfigs.get

Group

The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.

Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.

For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.

The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.

Fields
name

string

Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.

display_name

string

A user-assigned name for this group, used only for display purposes.

parent_name

string

The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".

filter

string

The filter used to determine which monitored resources belong to this group.

is_cluster

bool

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

GroupResourceType

The supported resource types that can be used as values of group_resource.resource_type. INSTANCE includes gce_instance and aws_ec2_instance resource types. The resource types gae_app and uptime_url are not valid here because group checks on App Engine modules and URLs are not allowed.

Enums
RESOURCE_TYPE_UNSPECIFIED Default value (not valid).
INSTANCE A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS).
AWS_ELB_LOAD_BALANCER A group of Amazon ELB load balancers.

InternalChecker

An internal checker allows Uptime checks to run on private/internal GCP resources.

Fields
name

string

A unique resource name for this InternalChecker. The format is:

projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].

[PROJECT_ID] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker.

display_name

string

The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.

network

string

The GCP VPC network where the internal resource lives (ex: "default").

gcp_zone

string

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.

peer_project_id

string

The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.

state

State

The current operational state of the internal checker.

State

Operational states for an internal checker.

Enums
UNSPECIFIED An internal checker should never be in the unspecified state.
CREATING The checker is being created, provisioned, and configured. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker, as well as by examining the long running Operation that created it.
RUNNING The checker is running and available for use. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker as well as by examining the long running Operation that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state.

ListAlertPoliciesRequest

The protocol for the ListAlertPolicies request.

Fields
name

string

The project whose alert policies are to be listed. The format is

projects/[PROJECT_ID]

Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.alertPolicies.list

filter

string

If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

For more details, see sorting and filtering.

order_by

string

A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

For more details, see sorting and filtering.

page_size

int32

The maximum number of results to return in a single response.

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 more results from the previous method call.

ListAlertPoliciesResponse

The protocol for the ListAlertPolicies response.

Fields
alert_policies[]

AlertPolicy

The returned alert policies.

next_page_token

string

If there might be more results than were 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.

ListGroupMembersRequest

The ListGroupMembers request.

Fields
name

string

The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}".

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.

filter

string

An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

resource.type = "gce_instance"

interval

TimeInterval

An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.

ListGroupMembersResponse

The ListGroupMembers response.

Fields
members[]

MonitoredResource

A set of monitored resources in the group.

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.

total_size

int32

The total number of elements matching this request.

ListGroupsRequest

The ListGroup request.

Fields
name

string

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

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.

Union field filter. An optional filter consisting of a single group name. The filters limit the groups returned based on their parent-child relationship with the specified group. If no filter is specified, all groups are returned. filter can be only one of the following:
children_of_group

string

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

ancestors_of_group

string

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

descendants_of_group

string

A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.

ListGroupsResponse

The ListGroups response.

Fields
group[]

Group

The groups that match the specified filters.

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.

ListMetricDescriptorsRequest

The ListMetricDescriptors request.

Fields
name

string

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

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.

ListMetricDescriptorsResponse

The ListMetricDescriptors response.

Fields
metric_descriptors[]

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.

ListMonitoredResourceDescriptorsRequest

The ListMonitoredResourceDescriptors request.

Fields
name

string

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

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.

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.

ListMonitoredResourceDescriptorsResponse

The ListMonitoredResourceDescriptors response.

Fields
resource_descriptors[]

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.

ListNotificationChannelDescriptorsRequest

The ListNotificationChannelDescriptors request.

Fields
name

string

The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

projects/[PROJECT_ID]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannelDescriptors.list

page_size

int32

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

page_token

string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

ListNotificationChannelDescriptorsResponse

The ListNotificationChannelDescriptors response.

Fields
channel_descriptors[]

NotificationChannelDescriptor

The monitored resource descriptors supported for the specified project, optionally filtered.

next_page_token

string

If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned.

ListNotificationChannelsRequest

The ListNotificationChannels request.

Fields
name

string

The project on which to execute the request. The format is projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.list

filter

string

If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

For more details, see sorting and filtering.

order_by

string

A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

For more details, see sorting and filtering.

page_size

int32

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

page_token

string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

ListNotificationChannelsResponse

The ListNotificationChannels response.

Fields
notification_channels[]

NotificationChannel

The notification channels defined for the specified project.

next_page_token

string

If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned.

ListServiceLevelObjectivesRequest

The ListServiceLevelObjectives request.

Fields
parent

string

Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}.

filter

string

A filter specifying what ServiceLevelObjectives to return.

page_size

int32

A non-negative number that is the maximum number of results to return. When 0, use default page size.

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.

view

View

View of the ServiceLevelObjectives to return. If DEFAULT, return each ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.

ListServiceLevelObjectivesResponse

The ListServiceLevelObjectives response.

Fields
service_level_objectives[]

ServiceLevelObjective

The ServiceLevelObjectives matching the specified filter.

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.

ListServicesRequest

The ListServices request.

Fields
parent

string

Resource name of the parent Workspace. Of the form projects/{project_id}.

filter

string

A filter specifying what Services to return. The filter currently supports the following fields:

- `identifier_case`
- `app_engine.module_id`
- `cloud_endpoints.service`
- `cluster_istio.location`
- `cluster_istio.cluster_name`
- `cluster_istio.service_namespace`
- `cluster_istio.service_name`

identifier_case refers to which option in the identifier oneof is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options are "CUSTOM", "APP_ENGINE", "CLOUD_ENDPOINTS", and "CLUSTER_ISTIO".

page_size

int32

A non-negative number that is the maximum number of results to return. When 0, use default page size.

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.

ListServicesResponse

The ListServices response.

Fields
services[]

Service

The Services matching the specified filter.

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.

ListTimeSeriesRequest

The ListTimeSeries request.

Fields
name

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

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

order_by

string

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

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.

TimeSeriesView

Controls which fields are returned by ListTimeSeries.

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

ListTimeSeriesResponse

The ListTimeSeries response.

Fields
time_series[]

TimeSeries

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[]

Status

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

ListUptimeCheckConfigsRequest

The protocol for the ListUptimeCheckConfigs request.

Fields
parent

string

The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID].

Authorization requires the following Google IAM permission on the specified resource parent:

  • monitoring.uptimeCheckConfigs.list

page_size

int32

The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be 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 more results from the previous method call.

ListUptimeCheckConfigsResponse

The protocol for the ListUptimeCheckConfigs response.

Fields
uptime_check_configs[]

UptimeCheckConfig

The returned Uptime check configurations.

next_page_token

string

This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).

total_size

int32

The total number of Uptime check configurations for the project, irrespective of any pagination.

ListUptimeCheckIpsRequest

The protocol for the ListUptimeCheckIps request.

Fields
page_size

int32

The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented

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 more results from the previous method call. NOTE: this field is not yet implemented

ListUptimeCheckIpsResponse

The protocol for the ListUptimeCheckIps response.

Fields
uptime_check_ips[]

UptimeCheckIp

The returned list of IP addresses (including region and location) that the checkers run from.

next_page_token

string

This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented

MutationRecord

Describes a change made to a configuration.

Fields
mutate_time

Timestamp

When the change occurred.

mutated_by

string

The email address of the user making the change.

NotificationChannel

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

Fields
type

string

The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

name

string

The full REST resource name for this channel. The syntax is:

projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]

The [CHANNEL_ID] is automatically assigned by the server on creation.

display_name

string

An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

description

string

An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.

labels

map<string, string>

Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.

user_labels

map<string, string>

User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

verification_status

VerificationStatus

Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.

If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.

If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.

This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

enabled

BoolValue

Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.

VerificationStatus

Indicates whether the channel has been verified or not. It is illegal to specify this field in a CreateNotificationChannel or an UpdateNotificationChannel operation.

Enums
VERIFICATION_STATUS_UNSPECIFIED Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
UNVERIFIED The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
VERIFIED It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

NotificationChannelDescriptor

A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

Fields
name

string

The full REST resource name for this descriptor. The syntax is:

projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]

In the above, [TYPE] is the value of the type field.

type

string

The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.

display_name

string

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

description

string

A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.

labels[]

LabelDescriptor

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

supported_tiers[]
(deprecated)

ServiceTier

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

Point

A single data point in a time series.

Fields
interval

TimeInterval

The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. 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.

Range

Range of numerical values, inclusive of min and exclusive of max. If the open range "< range.max" is desired, set range.min = -infinity. If the open range ">= range.min" is desired, set range.max = infinity.

Fields
min

double

Range minimum.

max

double

Range maximum.

RequestBasedSli

Service Level Indicators for which atomic units of service are counted directly.

Fields
Union field method. The means to compute a ratio of good_service to total_service. method can be only one of the following:
good_total_ratio

TimeSeriesRatio

good_total_ratio is used when the ratio of good_service to total_service is computed from two TimeSeries.

distribution_cut

DistributionCut

distribution_cut is used when good_service is a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution.

SendNotificationChannelVerificationCodeRequest

The SendNotificationChannelVerificationCode request.

Fields
name

string

The notification channel to which to send a verification code.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.sendVerificationCode

Service

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Stackdriver Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

Fields
name

string

Resource name for this Service. Of the form projects/{project_id}/services/{service_id}.

display_name

string

Name used for UI elements listing this Service.

telemetry

Telemetry

Configuration for how to query telemetry on a Service.

Union field identifier. REQUIRED. Service-identifying atoms specifying the underlying service. identifier can be only one of the following:
custom

Custom

Custom service type.

app_engine

AppEngine

Type used for App Engine services.

cloud_endpoints

CloudEndpoints

Type used for Cloud Endpoints services.

cluster_istio

ClusterIstio

Type used for Istio services that live in a Kubernetes cluster.

AppEngine

App Engine service. Learn more at https://cloud.google.com/appengine.

Fields
module_id

string

The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource: https://cloud.google.com/monitoring/api/resources#tag_gae_app

CloudEndpoints

Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.

Fields
service

string

The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource: https://cloud.google.com/monitoring/api/resources#tag_api

ClusterIstio

Istio service. Learn more at http://istio.io.

Fields
location

string

The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.

cluster_name

string

The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources.

service_namespace

string

The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.

service_name

string

The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.

Custom

Custom view of service telemetry. Currently a place-holder pending final design.

Telemetry

Configuration for how to query telemetry on a Service.

Fields
resource_name

string

The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.

ServiceLevelIndicator

A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries.

Fields
Union field type. Service level indicators can be grouped by whether the "unit" of service being measured is based on counts of good requests or on counts of good time windows type can be only one of the following:
basic_sli

BasicSli

Basic SLI on a well-known service type.

request_based

RequestBasedSli

Request-based SLIs

windows_based

WindowsBasedSli

Windows-based SLIs

ServiceLevelObjective

A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."

Fields
name

string

Resource name for this ServiceLevelObjective. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}.

display_name

string

Name used for UI elements listing this SLO.

service_level_indicator

ServiceLevelIndicator

The definition of good service, used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality.

goal

double

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 1.

Union field period. The time period over which the objective will be evaluated. period can be only one of the following:
rolling_period

Duration

A rolling time period, semantically "in the past <rolling_period>". Must be an integer multiple of 1 day no larger than 30 days.

calendar_period

CalendarPeriod

A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

View

ServiceLevelObjective.View determines what form of ServiceLevelObjective is returned from GetServiceLevelObjective, ListServiceLevelObjectives, and ListServiceLevelObjectiveVersions RPCs.

Enums
VIEW_UNSPECIFIED Same as FULL.
FULL Return the embedded ServiceLevelIndicator in the form in which it was defined. If it was defined using a BasicSli, return that BasicSli.
EXPLICIT For ServiceLevelIndicators using BasicSli articulation, instead return the ServiceLevelIndicator with its mode of computation fully spelled out as a RequestBasedSli. For ServiceLevelIndicators using RequestBasedSli or WindowsBasedSli, return the ServiceLevelIndicator as it was provided.

ServiceTier

The tier of service for a Workspace.

Enums
SERVICE_TIER_UNSPECIFIED An invalid sentinel value, used to indicate that a tier has not been provided explicitly.
SERVICE_TIER_BASIC A free tier of service that provided access to basic features.
SERVICE_TIER_PREMIUM A paid tier of service that provided access to all features.

SpanContext

The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.

It contains the name of a span with format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

Fields
span_name

string

The resource name of the span in the following format:

projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.

[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

TimeInterval

A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time.

  • For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements.

  • For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time.

  • In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time.

Fields
end_time

Timestamp

Required. The end of the time interval.

start_time

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.

TimeSeries

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

Fields
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

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

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[]

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.

TimeSeriesRatio

A TimeSeriesRatio specifies two TimeSeries to use for computing the good_service / total_service ratio. The specified TimeSeries must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. The TimeSeriesRatio must specify exactly two of good, bad, and total, and the relationship good_service + bad_service = total_service will be assumed.

Fields
good_service_filter

string

A monitoring filter specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

bad_service_filter

string

A monitoring filter specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

total_service_filter

string

A monitoring filter specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

TypedValue

A single strongly-typed value.

Fields
Union field value. The typed value field. value can be only one of the following:
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.

UpdateAlertPolicyRequest

The protocol for the UpdateAlertPolicy request.

Fields
update_mask

FieldMask

Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.

Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.

If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:

  • The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents.
  • Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.

alert_policy

AlertPolicy

Required. The updated alerting policy or the updated values for the fields listed in update_mask. If update_mask is not empty, any fields in this policy that are not in update_mask are ignored.

Authorization requires the following Google IAM permission on the specified resource alertPolicy:

  • monitoring.alertPolicies.update

UpdateGroupRequest

The UpdateGroup request.

Fields
group

Group

The new definition of the group. All fields of the existing group, excepting name, are replaced with the corresponding fields of this group.

validate_only

bool

If true, validate this request but do not update the existing group.

UpdateNotificationChannelRequest

The UpdateNotificationChannel request.

Fields
update_mask

FieldMask

The fields to update.

notification_channel

NotificationChannel

A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the update_mask.

UpdateServiceLevelObjectiveRequest

The UpdateServiceLevelObjective request.

Fields
service_level_objective

ServiceLevelObjective

The ServiceLevelObjective to draw updates from. The given name specifies the resource to update.

update_mask

FieldMask

A set of field paths defining which fields to use for the update.

UpdateServiceRequest

The UpdateService request.

Fields
service

Service

The Service to draw updates from. The given name specifies the resource to update.

update_mask

FieldMask

A set of field paths defining which fields to use for the update.

UpdateUptimeCheckConfigRequest

The protocol for the UpdateUptimeCheckConfig request.

Fields
update_mask

FieldMask

Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.

uptime_check_config

UptimeCheckConfig

Required. If an updateMask has been specified, this field gives the values for the set of fields mentioned in the updateMask. If an updateMask has not been given, this Uptime check configuration replaces the current configuration. If a field is mentioned in updateMask but the corresonding field is omitted in this partial Uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server.

The following fields can be updated: display_name, http_check, tcp_check, timeout, content_matchers, and selected_regions.

Authorization requires the following Google IAM permission on the specified resource uptimeCheckConfig:

  • monitoring.uptimeCheckConfigs.update

UptimeCheckConfig

This message configures which resources and services to monitor for availability.

Fields
name

string

A unique resource name for this Uptime check configuration. The format is:

projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

display_name

string

A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

period

Duration

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

timeout

Duration

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

content_matchers[]

ContentMatcher

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

selected_regions[]

UptimeCheckRegion

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

is_internal
(deprecated)

bool

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

internal_checkers[]
(deprecated)

InternalChecker

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Union field resource. The resource the check is checking. Required. resource can be only one of the following:
monitored_resource

MonitoredResource

The monitored resource associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer

resource_group

ResourceGroup

The group resource associated with the configuration.

Union field check_request_type. The type of Uptime check request. check_request_type can be only one of the following:
http_check

HttpCheck

Contains information needed to make an HTTP or HTTPS check.

tcp_check

TcpCheck

Contains information needed to make a TCP check.

ContentMatcher

Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.

Fields
content

string

String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.

matcher

ContentMatcherOption

The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

ContentMatcherOption

Options to perform content matching.

Enums
CONTENT_MATCHER_OPTION_UNSPECIFIED No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING.
CONTAINS_STRING Selects substring matching. The match succeeds if the output contains the content string. This is the default value for checks without a matcher option, or where the value of matcher is CONTENT_MATCHER_OPTION_UNSPECIFIED.
NOT_CONTAINS_STRING Selects negation of substring matching. The match succeeds if the output does NOT contain the content string.
MATCHES_REGEX Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the content string.
NOT_MATCHES_REGEX Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string.

HttpCheck

Information involved in an HTTP/HTTPS Uptime check request.

Fields
use_ssl

bool

If true, use HTTPS instead of HTTP to run the check.

path

string

Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.

port

int32

Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.

auth_info

BasicAuthentication

The authentication information. Optional when creating an HTTP check; defaults to empty.

mask_headers

bool

Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.

headers

map<string, string>

The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.

validate_ssl

bool

Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is false, setting validate_ssl to true has no effect.

BasicAuthentication

The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication is supported in Uptime checks.

Fields
username

string

The username to use when authenticating with the HTTP server.

password

string

The password to use when authenticating with the HTTP server.

ResourceGroup

The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.

Fields
group_id

string

The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID]/groups/[GROUP_ID].

resource_type

GroupResourceType

The resource type of the group members.

TcpCheck

Information required for a TCP Uptime check request.

Fields
port

int32

The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required.

UptimeCheckIp

Contains the region, location, and list of IP addresses where checkers in the location run from.

Fields
region

UptimeCheckRegion

A broad region category in which the IP address is located.

location

string

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

ip_address

string

The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.

UptimeCheckRegion

The regions from which an Uptime check can be run.

Enums
REGION_UNSPECIFIED Default value if no region is specified. Will result in Uptime checks running from all regions.
USA Allows checks to run from locations within the United States of America.
EUROPE Allows checks to run from locations within the continent of Europe.
SOUTH_AMERICA Allows checks to run from locations within the continent of South America.
ASIA_PACIFIC Allows checks to run from locations within the Asia Pacific area (ex: Singapore).

VerifyNotificationChannelRequest

The VerifyNotificationChannel request.

Fields
name

string

The notification channel to verify.

Authorization requires the following Google IAM permission on the specified resource name:

  • monitoring.notificationChannels.verify

code

string

The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).

WindowsBasedSli

A WindowsBasedSli defines good_service as the count of time windows for which the provided service was of good quality. Criteria for determining if service was good are embedded in the window_criterion.

Fields
window_period

Duration

Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.

Union field window_criterion. The criterion to use for evaluating window goodness. window_criterion can be only one of the following:
good_bad_metric_filter

string

A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

good_total_ratio_threshold

PerformanceThreshold

A window is good if its performance is high enough.

metric_mean_in_range

MetricRange

A window is good if the metric's value is in a good range, averaged across returned streams.

metric_sum_in_range

MetricRange

A window is good if the metric's value is in a good range, summed across returned streams.

MetricRange

A MetricRange is used when each window is good when the value x of a single TimeSeries satisfies range.min <= x < range.max. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE.

Fields
time_series

string

A monitoring filter specifying the TimeSeries to use for evaluating window quality.

range

Range

Range of values considered "good." For a one-sided range, set one bound to an infinite value.

PerformanceThreshold

A PerformanceThreshold is used when each window is good when that window has a sufficiently high performance.

Fields
threshold

double

If window performance >= threshold, the window is counted as good.

Union field type. The means, either a request-based SLI or a basic SLI, by which to compute performance over a window. type can be only one of the following:
performance

RequestBasedSli

RequestBasedSli to evaluate to judge window quality.

basic_sli_performance

BasicSli

BasicSli to evaluate to judge window quality.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Stackdriver Monitoring
Precisa de ajuda? Acesse nossa página de suporte.