API documentation for monitoring_v3.types
package.
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 <https://cloud.google.com/monitoring/api/v3/aggregation>
__.
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 <https://cloud.google.com/monitoring/alerts/>
__.
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ComparisonType
Specifies an ordering relationship on two arguments, called left
and right
.
Values: COMPARISON_UNSPECIFIED (0): No ordering relationship is specified. COMPARISON_GT (1): True if the left argument is greater than the right argument. COMPARISON_GE (2): True if the left argument is greater than or equal to the right argument. COMPARISON_LT (3): True if the left argument is less than the right argument. COMPARISON_LE (4): True if the left argument is less than or equal to the right argument. COMPARISON_EQ (5): True if the left argument is equal to the right argument. COMPARISON_NE (6): True if the left argument is not equal to the right argument.
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.
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.
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.
Values: RESOURCE_TYPE_UNSPECIFIED (0): Default value (not valid). INSTANCE (1): A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS). AWS_ELB_LOAD_BALANCER (2): A group of Amazon ELB load balancers.
InternalChecker
An internal checker allows Uptime checks to run on private/internal GCP resources.
LabelValue
A label value.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
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.
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.
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.
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.
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SendNotificationChannelVerificationCodeRequest
The SendNotificationChannelVerificationCode
request.
Service
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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."
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ServiceTier
The tier of service for a Metrics Scope. Please see the service
tiers
documentation <https://cloud.google.com/monitoring/workspaces/tiers>
__
for more details.
Values:
SERVICE_TIER_UNSPECIFIED (0):
An invalid sentinel value, used to indicate
that a tier has not been provided explicitly.
SERVICE_TIER_BASIC (1):
The Cloud Monitoring Basic tier, a free tier of service that
provides basic features, a moderate allotment of logs, and
access to built-in metrics. A number of features are not
available in this tier. For more details, see the service
tiers
documentation <https://cloud.google.com/monitoring/workspaces/tiers>
.
SERVICE_TIER_PREMIUM (2):
The Cloud Monitoring Premium tier, a higher, more expensive
tier of service that provides access to all Cloud Monitoring
features, lets you use Cloud Monitoring with AWS accounts,
and has a larger allotments for logs and metrics. For more
details, see the service tiers
documentation <https://cloud.google.com/monitoring/workspaces/tiers>
.
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
.
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]
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".
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 the`MetricKind
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind`__ 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.
TimeSeriesDescriptor
A descriptor for the labels and points in a time series.
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UptimeCheckIp
Contains the region, location, and list of IP addresses where checkers in the location run from.
UptimeCheckRegion
The regions from which an Uptime check can be run.
Values: REGION_UNSPECIFIED (0): Default value if no region is specified. Will result in Uptime checks running from all regions. USA (1): Allows checks to run from locations within the United States of America. EUROPE (2): Allows checks to run from locations within the continent of Europe. SOUTH_AMERICA (3): Allows checks to run from locations within the continent of South America. ASIA_PACIFIC (4): Allows checks to run from locations within the Asia Pacific area (ex: Singapore). USA_OREGON (5): Allows checks to run from locations within the western United States of America USA_IOWA (6): Allows checks to run from locations within the central United States of America USA_VIRGINIA (7): Allows checks to run from locations within the eastern United States of America
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
.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields