Package types (2.1.0)

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 <https://cloud.google.com/monitoring/api/v3/aggregation>__.

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 <https://cloud.google.com/monitoring/alerts/>__.

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.

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

The protocol for the CreateAlertPolicy request.

The CreateGroup request.

The CreateMetricDescriptor request.

The CreateNotificationChannel request.

The CreateServiceLevelObjective request.

The CreateService request.

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

The CreateTimeSeries request.

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

The protocol for the CreateUptimeCheckConfig request.

The protocol for the DeleteAlertPolicy request.

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

The DeleteMetricDescriptor request.

The DeleteNotificationChannel request.

The DeleteServiceLevelObjective request.

The DeleteService request.

The protocol for the DeleteUptimeCheckConfig request.

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.

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.

The protocol for the GetAlertPolicy request.

The GetGroup request.

The GetMetricDescriptor request.

The GetMonitoredResourceDescriptor request.

The GetNotificationChannelDescriptor response.

The GetNotificationChannel request.

The GetNotificationChannelVerificationCode request.

The GetNotificationChannelVerificationCode request.

The GetServiceLevelObjective request.

The GetService request.

The protocol for the GetUptimeCheckConfig request.

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.

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.

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

A label value.

The protocol for the ListAlertPolicies request.

The protocol for the ListAlertPolicies response.

The ListGroupMembers request.

The ListGroupMembers response.

The ListGroup request.

The ListGroups response.

The ListMetricDescriptors request.

The ListMetricDescriptors response.

The ListMonitoredResourceDescriptors request.

The ListMonitoredResourceDescriptors response.

The ListNotificationChannelDescriptors request.

The ListNotificationChannelDescriptors response.

The ListNotificationChannels request.

The ListNotificationChannels response.

The ListServiceLevelObjectives request.

The ListServiceLevelObjectives response.

The ListServices request.

The ListServices response.

The ListTimeSeries request.

The ListTimeSeries response.

The protocol for the ListUptimeCheckConfigs request.

The protocol for the ListUptimeCheckConfigs response.

The protocol for the ListUptimeCheckIps request.

The protocol for the ListUptimeCheckIps response.

Describes a change made to a configuration.

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.

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.

A single data point in a time series.

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

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

The QueryTimeSeries request.

The QueryTimeSeries response.

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.

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

The SendNotificationChannelVerificationCode request.

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia <https://en.wikipedia.org/wiki/Service-orientation>__). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

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.

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

The tier of service for a Workspace. Please see the service tiers documentation <https://cloud.google.com/monitoring/workspaces/tiers>__ for more details.

The context of a span, attached to Exemplars][google.api.Distribution.Exemplars] 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]

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

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 https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#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 millisecond 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.

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.

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

A descriptor for the labels and points in a timeseries.

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.

A single strongly-typed value.

The protocol for the UpdateAlertPolicy request.

The UpdateGroup request.

The UpdateNotificationChannel request.

The UpdateServiceLevelObjective request.

The UpdateService request.

The protocol for the UpdateUptimeCheckConfig request.

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

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

The regions from which an Uptime check can be run.

The VerifyNotificationChannel request.

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.