monitoring/v3 library
Cloud Monitoring API - v3
Manages your Cloud Monitoring data and configurations.
For more information, see cloud.google.com/monitoring/api/
Create an instance of MonitoringApi to access these resources:
- FoldersResource
- OrganizationsResource
- ProjectsResource
- ProjectsAlertPoliciesResource
- ProjectsCollectdTimeSeriesResource
- ProjectsGroupsResource
- ProjectsMetricDescriptorsResource
- ProjectsMonitoredResourceDescriptorsResource
- ProjectsNotificationChannelDescriptorsResource
- ProjectsNotificationChannelsResource
- ProjectsSnoozesResource
- ProjectsTimeSeriesResource
- ProjectsUptimeCheckConfigsResource
- ServicesResource
- UptimeCheckIpsResource
Classes
- Aggregation
- Describes how to combine multiple time series to provide a different view of the data.
- 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.
- AlertStrategy
- Control over how the notification channels in notification_channels are notified when this alert fires.
- AppEngine
- App Engine service.
- BasicAuthentication
- The authentication parameters to provide to the specified resource or URL that requires a username and password.
- BasicService
- A well-known service type, defined by its service type and service labels.
- BasicSli
- An SLI measuring performance on a well-known service type.
- BucketOptions
- BucketOptions describes the bucket boundaries used to create a histogram for the distribution.
- CloudEndpoints
- Cloud Endpoints service.
- CloudFunctionV2Target
- A Synthetic Monitor deployed to a Cloud Functions V2 instance.
- CloudRun
- Cloud Run service.
- ClusterIstio
- Istio service scoped to a single Kubernetes cluster.
- CollectdPayload
- A collection of data points sent from a collectd-based plugin.
- 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.
- ContentMatcher
- Used to perform content matching.
- CreateCollectdTimeSeriesRequest
- The CreateCollectdTimeSeries request.
- CreateCollectdTimeSeriesResponse
- The CreateCollectdTimeSeries response.
- CreateTimeSeriesRequest
- The CreateTimeSeries request.
- CreateTimeSeriesSummary
- Summary of the result of a failed request to write data to a time series.
- Criteria
- Criteria specific to the AlertPolicys that this Snooze applies to.
- Distribution
- Distribution contains summary statistics for a population of values.
- DistributionCut
- A DistributionCut defines a TimeSeries and thresholds used for measuring good service and total service.
- Documentation
- Documentation that is included in the notifications and incidents pertaining to this policy.
- Error
- Detailed information about an error category.
- Exemplar
- Exemplars are example points that may be used to annotate aggregated distribution values.
- FoldersResource
- FoldersTimeSeriesResource
- ForecastOptions
- Options used when forecasting the time series and testing the predicted value against the threshold.
- GetNotificationChannelVerificationCodeRequest
- The GetNotificationChannelVerificationCode request.
- GetNotificationChannelVerificationCodeResponse
- The GetNotificationChannelVerificationCode request.
- GkeNamespace
- GKE Namespace.
- GkeService
- GKE Service.
- GkeWorkload
- A GKE Workload (Deployment, StatefulSet, etc).
- GoogleMonitoringV3Range
- Range of numerical values within min and max.
- Group
- The description of a dynamic collection of monitored resources.
- HttpCheck
- Information involved in an HTTP/HTTPS Uptime check request.
- InternalChecker
- An internal checker allows Uptime checks to run on private/internal GCP resources.
- IstioCanonicalService
- Canonical service scoped to an Istio mesh.
- JsonPathMatcher
- Information needed to perform a JSONPath content match.
- LabelDescriptor
- A description of a label.
- LabelValue
- A label value.
- LatencyCriteria
- Parameters for a latency threshold SLI.
- 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.
- ListServiceLevelObjectivesResponse
- The ListServiceLevelObjectives response.
- ListServicesResponse
- The ListServices response.
- ListSnoozesResponse
- The results of a successful ListSnoozes call, containing the matching Snoozes.
- ListTimeSeriesResponse
- The ListTimeSeries response.
- ListUptimeCheckConfigsResponse
- The protocol for the ListUptimeCheckConfigs response.
- ListUptimeCheckIpsResponse
- The protocol for the ListUptimeCheckIps response.
- LogMatch
- A condition type that checks whether a log message in the scoping project (https://cloud.google.com/monitoring/api/v3#project_name) satisfies the given filter.
- MeshIstio
- Istio service scoped to an Istio mesh.
- 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.
- MetricDescriptor
- Defines a metric type and its schema.
- MetricRange
- A MetricRange is used when each window is good when the value x of a single TimeSeries satisfies range.min <= x <= range.max.
- 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.
- MonitoredResourceDescriptor
- An object that describes the schema of a MonitoredResource object using a type name and a set of labels.
- MonitoringApi
- Manages your Cloud Monitoring data and configurations.
- MonitoringQueryLanguageCondition
- A condition type that allows alert policies to be defined using Monitoring Query Language (https://cloud.google.com/monitoring/mql).
- 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.
- NotificationChannelDescriptor
- A description of a notification channel.
- NotificationChannelStrategy
- Control over how the notification channels in notification_channels are notified when this alert fires, on a per-channel basis.
- NotificationRateLimit
- Control over the rate of notifications sent to this alert policy's notification channels.
- OrganizationsResource
- OrganizationsTimeSeriesResource
- PerformanceThreshold
- A PerformanceThreshold is used when each window is good when that window has a sufficiently high performance.
- PingConfig
- Information involved in sending ICMP pings alongside public HTTP/TCP checks.
- Point
- A single data point in a time series.
- PointData
- A point's value columns and time interval.
- ProjectsAlertPoliciesResource
- ProjectsCollectdTimeSeriesResource
- ProjectsGroupsMembersResource
- ProjectsGroupsResource
- ProjectsMetricDescriptorsResource
- ProjectsMonitoredResourceDescriptorsResource
- ProjectsNotificationChannelDescriptorsResource
- ProjectsNotificationChannelsResource
- ProjectsResource
- ProjectsSnoozesResource
- ProjectsTimeSeriesResource
- ProjectsUptimeCheckConfigsResource
- PrometheusQueryLanguageCondition
- A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/).
- QueryTimeSeriesRequest
- The QueryTimeSeries request.
- QueryTimeSeriesResponse
- The QueryTimeSeries response.
- Range
- The range of the population values.
- RequestBasedSli
- Service Level Indicators for which atomic units of service are counted directly.
- ResourceGroup
- The resource submessage for group checks.
- ResponseStatusCode
- A status to accept.
- 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)).
- ServiceAgentAuthentication
- Contains information needed for generating either an OpenID Connect token (https://developers.google.com/identity/protocols/OpenIDConnect) or OAuth token (https://developers.google.com/identity/protocols/oauth2).
- ServiceLevelIndicator
- A Service-Level Indicator (SLI) describes the "performance" of a service.
- ServiceLevelObjective
- A Service-Level Objective (SLO) describes a level of desired good service.
- ServicesResource
- ServicesServiceLevelObjectivesResource
- Snooze
- A Snooze will prevent any alerts from being opened, and close any that are already open.
- SyntheticMonitorTarget
- Describes a Synthetic Monitor to be invoked by Uptime.
- TcpCheck
- Information required for a TCP Uptime check request.
- Telemetry
- Configuration for how to query telemetry on a Service.
- TimeInterval
- Describes a time interval: Reads: A half-open time interval.
- TimeSeries
- A collection of data points that describes the time-varying values of a metric.
- 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.
- Trigger
- Specifies how many time series must fail a predicate to trigger a condition.
- 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.
- UptimeCheckIpsResource
- ValueDescriptor
- A descriptor for the value columns in a data point.
- 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.
Typedefs
- AvailabilityCriteria = $Empty
- Future parameters for the availability SLI.
- Custom = $Empty
- 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.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Explicit = $Explicit
- Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets.
- Exponential = $Exponential
- Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound.
- Linear = $Linear
- Specifies a linear sequence of buckets that all have the same width (except overflow and underflow).
- MetricDescriptorMetadata = $MetricDescriptorMetadata
- Additional annotations that can be used to guide the usage of a metric.
- MonitoredResourceMetadata = $MonitoredResourceMetadata
- Auxiliary metadata for a MonitoredResource object.
- SendNotificationChannelVerificationCodeRequest = $Empty
- The SendNotificationChannelVerificationCode request.
- Status = $Status
- The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.