Modules§

Structs§

  • 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.
  • 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.
  • 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.
  • The protocol for the CreateAlertPolicy request.
  • The CreateGroup request.
  • The CreateMetricDescriptor request.
  • The CreateNotificationChannel request.
  • The CreateServiceLevelObjective request.
  • The CreateService request.
  • 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.
  • 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 estimated count of values in the Distribution that fall within the specified min and 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 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 message definition for retrieving a Snooze. Users must specify the field, name, which identifies the Snooze.
  • 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.
  • 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 message definition for listing Snoozes associated with the given parent, satisfying the optional filter.
  • The results of a successful ListSnoozes call, containing the matching Snoozes.
  • 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 within min and max.
  • 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). 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.”
  • 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.
  • The context of a span. This is attached to an [Exemplar][google.api.Distribution.Exemplar] in [Distribution][google.api.Distribution] values during aggregation.
  • Describes a Synthetic Monitor to be invoked by Uptime.
  • A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.
  • Describes a time interval:
  • 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.
  • 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 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.
  • 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 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.

Enums§

  • Specifies an ordering relationship on two arguments, called left and right.
  • 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.
  • The tier of service for a Metrics Scope. Please see the service tiers documentation for more details.
  • The regions from which an Uptime check can be run.