googleapis.monitoring.v3 library

Classes

Aggregation
Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see 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.
BasicAuthentication
A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.
BucketOptions
BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
CollectdPayload
A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.
CollectdPayloadError
Describes the error status for payloads that were not written.
CollectdValue
A single data point from a collectd-based plugin.
CollectdValueError
Describes the error status for values that were not written.
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.
ContentMatcher
Used to perform string matching. It allows substring and regular expressions, together with their negations.
CreateCollectdTimeSeriesRequest
The CreateCollectdTimeSeries request.
CreateCollectdTimeSeriesResponse
The CreateCollectdTimeSeries response.
CreateTimeSeriesRequest
The CreateTimeSeries request.
Distribution
Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.
Documentation
A content string and a MIME type that describes the content string's format.
DroppedLabels
A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.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.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
Exemplar
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
Explicit
Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
Exponential
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
Field
A single field of a message type.
GetNotificationChannelVerificationCodeRequest
The GetNotificationChannelVerificationCode request.
GetNotificationChannelVerificationCodeResponse
The GetNotificationChannelVerificationCode 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.
HttpCheck
Information involved in an HTTP/HTTPS uptime check request.
InternalChecker
An internal checker allows uptime checks to run on private/internal GCP resources.
LabelDescriptor
A description of a label.
Linear
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets [...]
ListAlertPoliciesResponse
The protocol for the ListAlertPolicies response.
ListGroupMembersResponse
The ListGroupMembers response.
ListGroupsResponse
The ListGroups response.
ListMetricDescriptorsResponse
The ListMetricDescriptors response.
ListMonitoredResourceDescriptorsResponse
The ListMonitoredResourceDescriptors response.
ListNotificationChannelDescriptorsResponse
The ListNotificationChannelDescriptors response.
ListNotificationChannelsResponse
The ListNotificationChannels response.
ListTimeSeriesResponse
The ListTimeSeries response.
ListUptimeCheckConfigsResponse
The protocol for the ListUptimeCheckConfigs response.
ListUptimeCheckIpsResponse
The protocol for the ListUptimeCheckIps response.
Metric
A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.
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.
MetricDescriptor
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
MetricThreshold
A condition type that compares a collection of time series against a threshold.
MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
MonitoredResourceDescriptor
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
MonitoredResourceMetadata
Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
MonitoringApi
Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Monitoring documentation.
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.
Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
Point
A single data point in a time series.
ProjectsAlertPoliciesResourceApi
ProjectsCollectdTimeSeriesResourceApi
ProjectsGroupsMembersResourceApi
ProjectsGroupsResourceApi
ProjectsMetricDescriptorsResourceApi
ProjectsMonitoredResourceDescriptorsResourceApi
ProjectsNotificationChannelDescriptorsResourceApi
ProjectsNotificationChannelsResourceApi
ProjectsResourceApi
ProjectsTimeSeriesResourceApi
ProjectsUptimeCheckConfigsResourceApi
Range
The range of the population values.
ResourceGroup
The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
SendNotificationChannelVerificationCodeRequest
The SendNotificationChannelVerificationCode request.
SourceContext
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
SpanContext
The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
TcpCheck
Information required for a TCP uptime check request.
TimeInterval
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 of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be later than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time.
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.
Trigger
Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used.
Type
A protocol buffer message type.
TypedValue
A single strongly-typed value.
UptimeCheckConfig
This message configures which resources and services to monitor for availability.
UptimeCheckIp
Contains the region, location, and list of IP addresses where checkers in the location run from.
UptimeCheckIpsResourceApi
VerifyNotificationChannelRequest
The VerifyNotificationChannel request.

Constants

USER_AGENT → const String
'dart-api-client monitoring/v3'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.