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
Documentation that is included in the notifications and incidents pertaining to this policy.
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.
FunctionName
Resource name for the Function
resource.
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 Snooze
s associated with the given
parent
, satisfying the optional filter
.
ListSnoozesResponse
The results of a successful ListSnoozes
call, containing the matching
Snooze
s.
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 Cloud 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.BasicService
A well-known service type, defined by its service type and service labels. Documentation and examples here.
Service.Types.CloudEndpoints
Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.
Service.Types.CloudRun
Cloud Run service. Learn more at https://cloud.google.com/run.
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
Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.
Service.Types.GkeNamespace
GKE Namespace. The field names correspond to the resource metadata labels
on monitored resources that fall under a namespace (for example,
k8s_container
or k8s_pod
).
Service.Types.GkeService
GKE Service. The "service" here represents a
Kubernetes service
object.
The field names correspond to the resource labels on k8s_service
monitored
resources.
Service.Types.GkeWorkload
A GKE Workload (Deployment, StatefulSet, etc). The field names correspond
to the metadata labels on monitored resources that fall under a workload
(for example, k8s_container
or k8s_pod
).
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 Metrics Scope'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 AlertPolicy
s that this Snooze
applies to. The
Snooze
will suppress alerts that come from one of the AlertPolicy
s
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]
SyntheticMonitorTarget
Describes a Synthetic Monitor to be invoked by Uptime.
SyntheticMonitorTarget.Types
Container for nested types declared in the SyntheticMonitorTarget message type.
SyntheticMonitorTarget.Types.CloudFunctionV2Target
A Synthetic Monitor deployed to a Cloud Functions V2 instance.
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
Describes a time interval:
- Reads: A half-open time interval. It includes the end time but
excludes the start time:
(startTime, endTime]
. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. - Writes: A closed time interval. It extends from the start time to the end
time,
and includes both:
[startTime, endTime]
. Valid time intervals depend on theMetricKind
of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future.- For
GAUGE
metrics, thestartTime
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 forGAUGE
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. ForDELTA
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.
- For
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
Snooze
s are considered read-only and cannot be updated. - start time is in the past and end time is in the future:
display_name
andinterval.end_time
can be updated. - start time is in the future:
display_name
,interval.start_time
andinterval.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 MB of an HTTP or HTTPS check's response (and the first 1 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.ContentMatcher.Types.JsonPathMatcher
Information needed to perform a JSONPath content match.
Used for ContentMatcherOption::MATCHES_JSON_PATH
and
ContentMatcherOption::NOT_MATCHES_JSON_PATH
.
UptimeCheckConfig.Types.ContentMatcher.Types.JsonPathMatcher.Types
Container for nested types declared in the JsonPathMatcher message type.
UptimeCheckConfig.Types.HttpCheck
Information involved in an HTTP/HTTPS Uptime check request.
UptimeCheckConfig.Types.HttpCheck.Types
Container for nested types declared in the HttpCheck message type.
UptimeCheckConfig.Types.HttpCheck.Types.BasicAuthentication
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication is supported in Uptime checks.
UptimeCheckConfig.Types.HttpCheck.Types.ResponseStatusCode
A status to accept. Either a status code class like "2xx", or an integer status code like "200".
UptimeCheckConfig.Types.HttpCheck.Types.ResponseStatusCode.Types
Container for nested types declared in the ResponseStatusCode message type.
UptimeCheckConfig.Types.HttpCheck.Types.ServiceAgentAuthentication
Contains information needed for generating an OpenID Connect token. The OIDC token will be generated for the Monitoring service agent service account.
UptimeCheckConfig.Types.HttpCheck.Types.ServiceAgentAuthentication.Types
Container for nested types declared in the ServiceAgentAuthentication message type.
UptimeCheckConfig.Types.PingConfig
Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain.
UptimeCheckConfig.Types.ResourceGroup
The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
UptimeCheckConfig.Types.TcpCheck
Information required for a TCP Uptime check request.
UptimeCheckConfigName
Resource name for the UptimeCheckConfig
resource.
UptimeCheckIp
Contains the region, location, and list of IP addresses where checkers in the location run from.
UptimeCheckService
The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Cloud Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Cloud Monitoring, and then clicking on "Uptime".
UptimeCheckService.UptimeCheckServiceBase
Base class for server-side implementations of UptimeCheckService
UptimeCheckService.UptimeCheckServiceClient
Client for UptimeCheckService
UptimeCheckServiceClient
UptimeCheckService client wrapper, for convenient use.
UptimeCheckServiceClientBuilder
Builder class for UptimeCheckServiceClient to provide simple configuration of credentials, endpoint etc.
UptimeCheckServiceClientImpl
UptimeCheckService client wrapper implementation, for convenient use.
UptimeCheckServiceSettings
Settings for UptimeCheckServiceClient instances.
VerifyNotificationChannelRequest
The VerifyNotificationChannel
request.
WindowsBasedSli
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
.
WindowsBasedSli.Types
Container for nested types declared in the WindowsBasedSli message type.
WindowsBasedSli.Types.MetricRange
A MetricRange
is used when each window is good when the value x of a
single TimeSeries
satisfies range.min <= x <= range.max
. The provided
TimeSeries
must have ValueType = INT64
or ValueType = DOUBLE
and
MetricKind = GAUGE
.
WindowsBasedSli.Types.PerformanceThreshold
A PerformanceThreshold
is used when each window is good when that window
has a sufficiently high performance
.
WorkspaceName
Resource name for the Workspace
resource.
Enums
Aggregation.Types.Aligner
The Aligner
specifies the operation that will be applied to the data
points in each alignment period in a time series. Except for
ALIGN_NONE
, which specifies that no operation be applied, each alignment
operation replaces the set of data values in each alignment period with
a single value: the result of applying the operation to the data values.
An aligned time series has a single data value at the end of each
alignment_period
.
An alignment operation can change the data type of the values, too. For
example, if you apply a counting operation to boolean values, the data
value_type
in the original time series is BOOLEAN
, but the value_type
in the aligned result is INT64
.
Aggregation.Types.Reducer
A Reducer operation describes how to aggregate data points from multiple time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.
AlertPolicy.Types.Condition.ConditionOneofCase
Enum of possible cases for the "condition" oneof.
AlertPolicy.Types.Condition.Types.EvaluationMissingData
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. This control doesn't affect metric-absence policies.
AlertPolicy.Types.Condition.Types.Trigger.TypeOneofCase
Enum of possible cases for the "type" oneof.
AlertPolicy.Types.ConditionCombinerType
Operators for combining conditions.
AlertPolicy.Types.Severity
An enumeration of possible severity level for an Alert Policy.
AlertPolicyConditionName.ResourceNameType
The possible contents of AlertPolicyConditionName.
AlertPolicyName.ResourceNameType
The possible contents of AlertPolicyName.
BasicSli.SliCriteriaOneofCase
Enum of possible cases for the "sli_criteria" oneof.
ComparisonType
Specifies an ordering relationship on two arguments, called left
and
right
.
FunctionName.ResourceNameType
The possible contents of FunctionName.
GroupName.ResourceNameType
The possible contents of GroupName.
GroupResourceType
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.
InternalChecker.Types.State
Operational states for an internal checker.
LabelValue.ValueOneofCase
Enum of possible cases for the "value" oneof.
ListGroupsRequest.FilterOneofCase
Enum of possible cases for the "filter" oneof.
ListTimeSeriesRequest.Types.TimeSeriesView
Controls which fields are returned by ListTimeSeries*
.
MetricDescriptorName.ResourceNameType
The possible contents of MetricDescriptorName.
MonitoredResourceDescriptorName.ResourceNameType
The possible contents of MonitoredResourceDescriptorName.
NotificationChannel.Types.VerificationStatus
Indicates whether the channel has been verified or not. It is illegal
to specify this field in a
[CreateNotificationChannel
][google.monitoring.v3.NotificationChannelService.CreateNotificationChannel]
or an
[UpdateNotificationChannel
][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
operation.
NotificationChannelDescriptorName.ResourceNameType
The possible contents of NotificationChannelDescriptorName.
NotificationChannelName.ResourceNameType
The possible contents of NotificationChannelName.
RequestBasedSli.MethodOneofCase
Enum of possible cases for the "method" oneof.
Service.IdentifierOneofCase
Enum of possible cases for the "identifier" oneof.
ServiceLevelIndicator.TypeOneofCase
Enum of possible cases for the "type" oneof.
ServiceLevelObjective.PeriodOneofCase
Enum of possible cases for the "period" oneof.
ServiceLevelObjective.Types.View
ServiceLevelObjective.View
determines what form of
ServiceLevelObjective
is returned from GetServiceLevelObjective
,
ListServiceLevelObjectives
, and ListServiceLevelObjectiveVersions
RPCs.
ServiceLevelObjectiveName.ResourceNameType
The possible contents of ServiceLevelObjectiveName.
ServiceName.ResourceNameType
The possible contents of ServiceName.
ServiceTier
The tier of service for a Metrics Scope. Please see the service tiers documentation for more details.
SnoozeName.ResourceNameType
The possible contents of SnoozeName.
SyntheticMonitorTarget.TargetOneofCase
Enum of possible cases for the "target" oneof.
TimeSeriesName.ResourceNameType
The possible contents of TimeSeriesName.
TypedValue.ValueOneofCase
Enum of possible cases for the "value" oneof.
UptimeCheckConfig.CheckRequestTypeOneofCase
Enum of possible cases for the "check_request_type" oneof.
UptimeCheckConfig.ResourceOneofCase
Enum of possible cases for the "resource" oneof.
UptimeCheckConfig.Types.CheckerType
What kind of checkers are available to be used by the check.
UptimeCheckConfig.Types.ContentMatcher.AdditionalMatcherInfoOneofCase
Enum of possible cases for the "additional_matcher_info" oneof.
UptimeCheckConfig.Types.ContentMatcher.Types.ContentMatcherOption
Options to perform content matching.
UptimeCheckConfig.Types.ContentMatcher.Types.JsonPathMatcher.Types.JsonPathMatcherOption
Options to perform JSONPath content matching.
UptimeCheckConfig.Types.HttpCheck.AuthMethodOneofCase
Enum of possible cases for the "auth_method" oneof.
UptimeCheckConfig.Types.HttpCheck.Types.ContentType
Header options corresponding to the content type of a HTTP request body.
UptimeCheckConfig.Types.HttpCheck.Types.RequestMethod
The HTTP request method options.
UptimeCheckConfig.Types.HttpCheck.Types.ResponseStatusCode.StatusCodeOneofCase
Enum of possible cases for the "status_code" oneof.
UptimeCheckConfig.Types.HttpCheck.Types.ResponseStatusCode.Types.StatusClass
An HTTP status code class.
UptimeCheckConfig.Types.HttpCheck.Types.ServiceAgentAuthentication.Types.ServiceAgentAuthenticationType
Type of authentication.
UptimeCheckConfigName.ResourceNameType
The possible contents of UptimeCheckConfigName.
UptimeCheckRegion
The regions from which an Uptime check can be run.
WindowsBasedSli.Types.PerformanceThreshold.TypeOneofCase
Enum of possible cases for the "type" oneof.
WindowsBasedSli.WindowCriterionOneofCase
Enum of possible cases for the "window_criterion" oneof.
WorkspaceName.ResourceNameType
The possible contents of WorkspaceName.