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.NotificationChannelStrategy
Control over how the notification channels in notification_channels
are notified when this alert fires, on a per-channel basis.
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.MetricThreshold.Types
Container for nested types declared in the MetricThreshold message type.
AlertPolicy.Types.Condition.Types.MetricThreshold.Types.ForecastOptions
Options used when forecasting the time series and testing the predicted value against the threshold.
AlertPolicy.Types.Condition.Types.MonitoringQueryLanguageCondition
A condition type that allows alert policies to be defined using Monitoring Query Language.
AlertPolicy.Types.Condition.Types.PrometheusQueryLanguageCondition
A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL).
The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.
A Prometheus alerting rule is described here. The semantics of a Prometheus alerting rule is described here.
A Prometheus rule group is described here. The semantics of a Prometheus rule group is described here.
Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.
The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).
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.