Google Cloud Monitoring v3 API - Namespace Google.Cloud.Monitoring.V3 (3.2.0)

Stay organized with collections Save and categorize content based on your preferences.

Classes

Aggregation

Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.

Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.

Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.

The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation.

Aggregation.Types

Container for nested types declared in the Aggregation message type.

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.

AlertPolicy.Types

Container for nested types declared in the AlertPolicy message type.

AlertPolicy.Types.AlertStrategy

Control over how the notification channels in notification_channels are notified when this alert fires.

AlertPolicy.Types.AlertStrategy.Types

Container for nested types declared in the AlertStrategy message type.

AlertPolicy.Types.AlertStrategy.Types.NotificationRateLimit

Control over the rate of notifications sent to this alert policy's notification channels.

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

AlertPolicy.Types.Condition.Types

Container for nested types declared in the Condition message type.

AlertPolicy.Types.Condition.Types.LogMatch

A condition type that checks whether a log message in the scoping project satisfies the given filter. Logs from other projects in the metrics scope are not evaluated.

AlertPolicy.Types.Condition.Types.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.

AlertPolicy.Types.Condition.Types.MetricThreshold

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

AlertPolicy.Types.Condition.Types.MonitoringQueryLanguageCondition

A condition type that allows alert policies to be defined using Monitoring Query Language.

AlertPolicy.Types.Condition.Types.Trigger

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

AlertPolicy.Types.Documentation

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

AlertPolicyConditionName

Resource name for the AlertPolicyCondition resource.

AlertPolicyName

Resource name for the AlertPolicy resource.

AlertPolicyService

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Cloud 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 Cloud Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud console.

AlertPolicyService.AlertPolicyServiceBase

Base class for server-side implementations of AlertPolicyService

AlertPolicyService.AlertPolicyServiceClient

Client for AlertPolicyService

AlertPolicyServiceClient

AlertPolicyService client wrapper, for convenient use.

AlertPolicyServiceClientBuilder

Builder class for AlertPolicyServiceClient to provide simple configuration of credentials, endpoint etc.

AlertPolicyServiceClientImpl

AlertPolicyService client wrapper implementation, for convenient use.

AlertPolicyServiceSettings

Settings for AlertPolicyServiceClient instances.

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.

BasicSli.Types

Container for nested types declared in the BasicSli message type.

BasicSli.Types.AvailabilityCriteria

Future parameters for the availability SLI.

BasicSli.Types.LatencyCriteria

Parameters for a latency threshold SLI.

CreateAlertPolicyRequest

The protocol for the CreateAlertPolicy request.

CreateGroupRequest

The CreateGroup request.

CreateMetricDescriptorRequest

The CreateMetricDescriptor request.

CreateNotificationChannelRequest

The CreateNotificationChannel request.

CreateServiceLevelObjectiveRequest

The CreateServiceLevelObjective request.

CreateServiceRequest

The CreateService request.

CreateSnoozeRequest

The message definition for creating a Snooze. Users must provide the body of the Snooze to be created but must omit the Snooze field, name.

CreateTimeSeriesError

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

CreateTimeSeriesRequest

The CreateTimeSeries request.

CreateTimeSeriesSummary

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

CreateTimeSeriesSummary.Types

Container for nested types declared in the CreateTimeSeriesSummary message type.

CreateTimeSeriesSummary.Types.Error

Detailed information about an error category.

CreateUptimeCheckConfigRequest

The protocol for the CreateUptimeCheckConfig request.

DeleteAlertPolicyRequest

The protocol for the DeleteAlertPolicy request.

DeleteGroupRequest

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

DeleteMetricDescriptorRequest

The DeleteMetricDescriptor request.

DeleteNotificationChannelRequest

The DeleteNotificationChannel request.

DeleteServiceLevelObjectiveRequest

The DeleteServiceLevelObjective request.

DeleteServiceRequest

The DeleteService request.

DeleteUptimeCheckConfigRequest

The protocol for the DeleteUptimeCheckConfig request.

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 estimated count of values in the Distribution that fall within the specified min and max.

DroppedLabels

A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.

The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.

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.

GetAlertPolicyRequest

The protocol for the GetAlertPolicy request.

GetGroupRequest

The GetGroup request.

GetMetricDescriptorRequest

The GetMetricDescriptor request.

GetMonitoredResourceDescriptorRequest

The GetMonitoredResourceDescriptor request.

GetNotificationChannelDescriptorRequest

The GetNotificationChannelDescriptor response.

GetNotificationChannelRequest

The GetNotificationChannel request.

GetNotificationChannelVerificationCodeRequest

The GetNotificationChannelVerificationCode request.

GetNotificationChannelVerificationCodeResponse

The GetNotificationChannelVerificationCode request.

GetServiceLevelObjectiveRequest

The GetServiceLevelObjective request.

GetServiceRequest

The GetService request.

GetSnoozeRequest

The message definition for retrieving a Snooze. Users must specify the field, name, which identifies the Snooze.

GetUptimeCheckConfigRequest

The protocol for the GetUptimeCheckConfig request.

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.

GroupName

Resource name for the Group resource.

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.

GroupService.GroupServiceBase

Base class for server-side implementations of GroupService

GroupService.GroupServiceClient

Client for GroupService

GroupServiceClient

GroupService client wrapper, for convenient use.

GroupServiceClientBuilder

Builder class for GroupServiceClient to provide simple configuration of credentials, endpoint etc.

GroupServiceClientImpl

GroupService client wrapper implementation, for convenient use.

GroupServiceSettings

Settings for GroupServiceClient instances.

InternalChecker

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

InternalChecker.Types

Container for nested types declared in the InternalChecker message type.

LabelValue

A label value.

ListAlertPoliciesRequest

The protocol for the ListAlertPolicies request.

ListAlertPoliciesResponse

The protocol for the ListAlertPolicies response.

ListGroupMembersRequest

The ListGroupMembers request.

ListGroupMembersResponse

The ListGroupMembers response.

ListGroupsRequest

The ListGroup request.

ListGroupsResponse

The ListGroups response.

ListMetricDescriptorsRequest

The ListMetricDescriptors request.

ListMetricDescriptorsResponse

The ListMetricDescriptors response.

ListMonitoredResourceDescriptorsRequest

The ListMonitoredResourceDescriptors request.

ListMonitoredResourceDescriptorsResponse

The ListMonitoredResourceDescriptors response.

ListNotificationChannelDescriptorsRequest

The ListNotificationChannelDescriptors request.

ListNotificationChannelDescriptorsResponse

The ListNotificationChannelDescriptors response.

ListNotificationChannelsRequest

The ListNotificationChannels request.

ListNotificationChannelsResponse

The ListNotificationChannels response.

ListServiceLevelObjectivesRequest

The ListServiceLevelObjectives request.

ListServiceLevelObjectivesResponse

The ListServiceLevelObjectives response.

ListServicesRequest

The ListServices request.

ListServicesResponse

The ListServices response.

ListSnoozesRequest

The message definition for listing Snoozes associated with the given parent, satisfying the optional filter.

ListSnoozesResponse

The results of a successful ListSnoozes call, containing the matching Snoozes.

ListTimeSeriesRequest

The ListTimeSeries request.

ListTimeSeriesRequest.Types

Container for nested types declared in the ListTimeSeriesRequest message type.

ListTimeSeriesResponse

The ListTimeSeries response.

ListUptimeCheckConfigsRequest

The protocol for the ListUptimeCheckConfigs request.

ListUptimeCheckConfigsResponse

The protocol for the ListUptimeCheckConfigs response.

ListUptimeCheckIpsRequest

The protocol for the ListUptimeCheckIps request.

ListUptimeCheckIpsResponse

The protocol for the ListUptimeCheckIps response.

MetricDescriptorName

Resource name for the MetricDescriptor resource.

MetricService

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

MetricService.MetricServiceBase

Base class for server-side implementations of MetricService

MetricService.MetricServiceClient

Client for MetricService

MetricServiceClient

MetricService client wrapper, for convenient use.

MetricServiceClientBuilder

Builder class for MetricServiceClient to provide simple configuration of credentials, endpoint etc.

MetricServiceClientImpl

MetricService client wrapper implementation, for convenient use.

MetricServiceSettings

Settings for MetricServiceClient instances.

MonitoredResourceDescriptorName

Resource name for the MonitoredResourceDescriptor resource.

MutationRecord

Describes a change made to a configuration.

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.

NotificationChannel.Types

Container for nested types declared in the NotificationChannel message type.

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.

NotificationChannelDescriptorName

Resource name for the NotificationChannelDescriptor resource.

NotificationChannelName

Resource name for the NotificationChannel resource.

NotificationChannelService

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

NotificationChannelService.NotificationChannelServiceBase

Base class for server-side implementations of NotificationChannelService

NotificationChannelService.NotificationChannelServiceClient

Client for NotificationChannelService

NotificationChannelServiceClient

NotificationChannelService client wrapper, for convenient use.

NotificationChannelServiceClientBuilder

Builder class for NotificationChannelServiceClient to provide simple configuration of credentials, endpoint etc.

NotificationChannelServiceClientImpl

NotificationChannelService client wrapper implementation, for convenient use.

NotificationChannelServiceSettings

Settings for NotificationChannelServiceClient instances.

Point

A single data point in a time series.

QueryError

An error associated with a query in the time series query language format.

QueryErrorList

This is an error detail intended to be used with INVALID_ARGUMENT errors.

QueryService

The QueryService API is used to manage time series data in Stackdriver Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric.

QueryService.QueryServiceBase

Base class for server-side implementations of QueryService

QueryService.QueryServiceClient

Client for QueryService

QueryServiceClient

QueryService client wrapper, for convenient use.

QueryServiceClientBuilder

Builder class for QueryServiceClient to provide simple configuration of credentials, endpoint etc.

QueryServiceClientImpl

QueryService client wrapper implementation, for convenient use.

QueryServiceSettings

Settings for QueryServiceClient instances.

QueryTimeSeriesRequest

The QueryTimeSeries request.

QueryTimeSeriesResponse

The QueryTimeSeries response.

Range

Range of numerical values within min and max.

RequestBasedSli

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

SendNotificationChannelVerificationCodeRequest

The SendNotificationChannelVerificationCode request.

Service

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

Service.Types

Container for nested types declared in the Service message type.

Service.Types.AppEngine

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

Service.Types.CloudEndpoints

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

Service.Types.ClusterIstio

Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type.

Service.Types.Custom

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

Service.Types.IstioCanonicalService

Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.

Service.Types.MeshIstio

Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.

Service.Types.Telemetry

Configuration for how to query telemetry on a Service.

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.

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

ServiceLevelObjective.Types

Container for nested types declared in the ServiceLevelObjective message type.

ServiceLevelObjectiveName

Resource name for the ServiceLevelObjective resource.

ServiceMonitoringService

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

ServiceMonitoringService.ServiceMonitoringServiceBase

Base class for server-side implementations of ServiceMonitoringService

ServiceMonitoringService.ServiceMonitoringServiceClient

Client for ServiceMonitoringService

ServiceMonitoringServiceClient

ServiceMonitoringService client wrapper, for convenient use.

ServiceMonitoringServiceClientBuilder

Builder class for ServiceMonitoringServiceClient to provide simple configuration of credentials, endpoint etc.

ServiceMonitoringServiceClientImpl

ServiceMonitoringService client wrapper implementation, for convenient use.

ServiceMonitoringServiceSettings

Settings for ServiceMonitoringServiceClient instances.

ServiceName

Resource name for the Service resource.

Snooze

A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.

Snooze.Types

Container for nested types declared in the Snooze message type.

Snooze.Types.Criteria

Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.

SnoozeName

Resource name for the Snooze resource.

SnoozeService

The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.

SnoozeService.SnoozeServiceBase

Base class for server-side implementations of SnoozeService

SnoozeService.SnoozeServiceClient

Client for SnoozeService

SnoozeServiceClient

SnoozeService client wrapper, for convenient use.

SnoozeServiceClientBuilder

Builder class for SnoozeServiceClient to provide simple configuration of credentials, endpoint etc.

SnoozeServiceClientImpl

SnoozeService client wrapper implementation, for convenient use.

SnoozeServiceSettings

Settings for SnoozeServiceClient instances.

SpanContext

The context of a span. This is attached to an [Exemplar][google.api.Distribution.Exemplar] in [Distribution][google.api.Distribution] values during aggregation.

It contains the name of a span with format:

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

TextLocator

A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.

For example, suppose the request field text contains:

text: "The quick brown fox jumps over the lazy dog."

Then the locator:

source: "text" start_position { line: 1 column: 17 } end_position { line: 1 column: 19 }

refers to the part of the text: "fox".

TextLocator.Types

Container for nested types declared in the TextLocator message type.

TextLocator.Types.Position

The position of a byte within the text.

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. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.

  • For GAUGE metrics, 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. The end time of a new interval must be at least a millisecond after the end time of the previous interval.

  • For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.

  • For CUMULATIVE metrics, the start time and end time must 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. The new start time must be at least a millisecond after the end time of the previous interval.

  • The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous 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.

TimeSeriesData

Represents the values of a time series associated with a TimeSeriesDescriptor.

TimeSeriesData.Types

Container for nested types declared in the TimeSeriesData message type.

TimeSeriesData.Types.PointData

A point's value columns and time interval. Each point has one or more point values corresponding to the entries in point_descriptors field in the TimeSeriesDescriptor associated with this object.

TimeSeriesDescriptor

A descriptor for the labels and points in a time series.

TimeSeriesDescriptor.Types

Container for nested types declared in the TimeSeriesDescriptor message type.

TimeSeriesDescriptor.Types.ValueDescriptor

A descriptor for the value columns in a data point.

TimeSeriesName

Resource name for the TimeSeries resource.

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.

TypedValue

A single strongly-typed value.

UpdateAlertPolicyRequest

The protocol for the UpdateAlertPolicy request.

UpdateGroupRequest

The UpdateGroup request.

UpdateNotificationChannelRequest

The UpdateNotificationChannel request.

UpdateServiceLevelObjectiveRequest

The UpdateServiceLevelObjective request.

UpdateServiceRequest

The UpdateService request.

UpdateSnoozeRequest

The message definition for updating a Snooze. The field, snooze.name identifies the Snooze to be updated. The remainder of snooze gives the content the Snooze in question will be assigned.

What fields can be updated depends on the start time and end time of the Snooze.

  • end time is in the past: These Snoozes are considered read-only and cannot be updated.
  • start time is in the past and end time is in the future: display_name and interval.end_time can be updated.
  • start time is in the future: display_name, interval.start_time and interval.end_time can be updated.

UpdateUptimeCheckConfigRequest

The protocol for the UpdateUptimeCheckConfig request.

UptimeCheckConfig

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

UptimeCheckConfig.Types

Container for nested types declared in the UptimeCheckConfig message type.

UptimeCheckConfig.Types.ContentMatcher

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

UptimeCheckConfig.Types.ContentMatcher.Types

Container for nested types declared in the ContentMatcher message type.

UptimeCheckConfig.Types.HttpCheck

Information involved in an HTTP/HTTPS Uptime check request.