Package types (2.4.2)

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. .. attribute:: name

Required. The project in which to create the alerting policy. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container.

:type: str

The CreateGroup request. .. attribute:: name

Required. The project in which to create the group. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The CreateMetricDescriptor request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The CreateNotificationChannel request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

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.

:type: str

The CreateServiceLevelObjective request. .. attribute:: parent

Required. Resource name of the parent Service. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

:type: str

The CreateService request. .. attribute:: parent

Required. Resource name of the parent workspace. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

DEPRECATED. Used to hold per-time-series error status. .. attribute:: time_series

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

:type: google.cloud.monitoring_v3.types.TimeSeries

The CreateTimeSeries request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

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

The protocol for the CreateUptimeCheckConfig request. .. attribute:: parent

Required. The project in which to create the Uptime check. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The protocol for the DeleteAlertPolicy request. .. attribute:: name

Required. The alerting policy to delete. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy][google.monitoring.v3.AlertPolicy].

:type: str

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

The DeleteMetricDescriptor request. .. attribute:: name

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

:type: str

The DeleteNotificationChannel request. .. attribute:: name

Required. The channel for which to execute the request. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

:type: str

The DeleteServiceLevelObjective request. .. attribute:: name

Required. Resource name of the ServiceLevelObjective to delete. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

:type: str

The DeleteService request. .. attribute:: name

Required. Resource name of the Service to delete. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

:type: str

The protocol for the DeleteUptimeCheckConfig request. .. attribute:: name

Required. The Uptime check configuration to delete. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

:type: str

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

The protocol for the GetAlertPolicy request. .. attribute:: name

Required. The alerting policy to retrieve. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

:type: str

The GetGroup request. .. attribute:: name

Required. The group to retrieve. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

:type: str

The GetMetricDescriptor request. .. attribute:: name

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

:type: str

The GetMonitoredResourceDescriptor request. .. attribute:: name

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

:type: str

The GetNotificationChannelDescriptor response. .. attribute:: name

Required. The channel type for which to execute the request. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]

:type: str

The GetNotificationChannel request. .. attribute:: name

Required. The channel for which to execute the request. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

:type: str

The GetNotificationChannelVerificationCode request. .. attribute:: name

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

:type: str

The GetNotificationChannelVerificationCode request. .. attribute:: code

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

:type: str

The GetServiceLevelObjective request. .. attribute:: name

Required. Resource name of the ServiceLevelObjective to get. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

:type: str

The GetService request. .. attribute:: name

Required. Resource name of the Service. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

:type: str

The protocol for the GetUptimeCheckConfig request. .. attribute:: name

Required. The Uptime check configuration to retrieve. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

:type: str

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. .. attribute:: bool_value

A bool label value.

:type: bool

The protocol for the ListAlertPolicies request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

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][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.

:type: str

The protocol for the ListAlertPolicies response. .. attribute:: alert_policies

The returned alert policies.

:type: Sequence[google.cloud.monitoring_v3.types.AlertPolicy]

The ListGroupMembers request. .. attribute:: name

Required. The group whose members are listed. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

:type: str

The ListGroupMembers response. .. attribute:: members

A set of monitored resources in the group.

:type: Sequence[google.api.monitored_resource_pb2.MonitoredResource]

The ListGroup request. .. attribute:: name

Required. The project whose groups are to be listed. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The ListGroups response. .. attribute:: group

The groups that match the specified filters.

:type: Sequence[google.cloud.monitoring_v3.types.Group]

The ListMetricDescriptors request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The ListMetricDescriptors response. .. attribute:: metric_descriptors

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

:type: Sequence[google.api.metric_pb2.MetricDescriptor]

The ListMonitoredResourceDescriptors request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The ListMonitoredResourceDescriptors response. .. attribute:: resource_descriptors

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

:type: Sequence[google.api.monitored_resource_pb2.MonitoredResourceDescriptor]

The ListNotificationChannelDescriptors request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

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

:type: str

The ListNotificationChannelDescriptors response. .. attribute:: channel_descriptors

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

:type: Sequence[google.cloud.monitoring_v3.types.NotificationChannelDescriptor]

The ListNotificationChannels request. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

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][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation.

:type: str

The ListNotificationChannels response. .. attribute:: notification_channels

The notification channels defined for the specified project.

:type: Sequence[google.cloud.monitoring_v3.types.NotificationChannel]

The ListServiceLevelObjectives request. .. attribute:: parent

Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are:

::

   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
   workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-

:type: str

The ListServiceLevelObjectives response. .. attribute:: service_level_objectives

The ServiceLevelObjective\ s matching the specified filter.

:type: Sequence[google.cloud.monitoring_v3.types.ServiceLevelObjective]

The ListServices request. .. attribute:: parent

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are:

::

   projects/[PROJECT_ID_OR_NUMBER]
   workspaces/[HOST_PROJECT_ID_OR_NUMBER]

:type: str

The ListServices response. .. attribute:: services

The Service\ s matching the specified filter.

:type: Sequence[google.cloud.monitoring_v3.types.Service]

The ListTimeSeries request. .. attribute:: name

Required. The project, organization or folder on which to execute the request. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]
   organizations/[ORGANIZATION_ID]
   folders/[FOLDER_ID]

:type: str

The ListTimeSeries response. .. attribute:: time_series

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

:type: Sequence[google.cloud.monitoring_v3.types.TimeSeries]

The protocol for the ListUptimeCheckConfigs request. .. attribute:: parent

Required. The project whose Uptime check configurations are listed. The format is:

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The protocol for the ListUptimeCheckConfigs response. .. attribute:: uptime_check_configs

The returned Uptime check configurations.

:type: Sequence[google.cloud.monitoring_v3.types.UptimeCheckConfig]

The protocol for the ListUptimeCheckIps request. .. attribute:: page_size

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

:type: int

The protocol for the ListUptimeCheckIps response. .. attribute:: uptime_check_ips

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

:type: Sequence[google.cloud.monitoring_v3.types.UptimeCheckIp]

Describes a change made to a configuration. .. attribute:: mutate_time

When the change occurred.

:type: google.protobuf.timestamp_pb2.Timestamp

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. .. attribute:: interval

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.

:type: google.cloud.monitoring_v3.types.TimeInterval

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. .. attribute:: name

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

::

   projects/[PROJECT_ID_OR_NUMBER]

:type: str

The QueryTimeSeries response. .. attribute:: time_series_descriptor

The descriptor for the time series data.

:type: google.cloud.monitoring_v3.types.TimeSeriesDescriptor

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. .. attribute:: name

Required. The notification channel to which to send a verification code.

:type: str

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 </monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#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 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.

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 time series. .. attribute:: label_descriptors

Descriptors for the labels.

:type: Sequence[google.api.label_pb2.LabelDescriptor]

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. .. attribute:: bool_value

A Boolean value: true or false.

:type: bool

The protocol for the UpdateAlertPolicy request. .. attribute:: update_mask

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.

  :type: google.protobuf.field_mask_pb2.FieldMask

The UpdateGroup request. .. attribute:: group

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

:type: google.cloud.monitoring_v3.types.Group

The UpdateNotificationChannel request. .. attribute:: update_mask

The fields to update.

:type: google.protobuf.field_mask_pb2.FieldMask

The UpdateServiceLevelObjective request. .. attribute:: service_level_objective

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

:type: google.cloud.monitoring_v3.types.ServiceLevelObjective

The UpdateService request. .. attribute:: service

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

:type: google.cloud.monitoring_v3.types.Service

The protocol for the UpdateUptimeCheckConfig request. .. attribute:: update_mask

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.

:type: google.protobuf.field_mask_pb2.FieldMask

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. .. attribute:: name

Required. The notification channel to verify.

:type: str

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.