Cloud Monitoring API - Module Google::Cloud::Monitoring (v1.9.0)

Reference documentation and code samples for the Cloud Monitoring API module Google::Cloud::Monitoring.

Methods

.alert_policy_service

def self.alert_policy_service(version: :v3, &block) -> ::Object

Create a new client object for AlertPolicyService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::AlertPolicyService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the AlertPolicyService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the AlertPolicyService service. You can determine whether the method will succeed by calling Monitoring.alert_policy_service_available?.

About 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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.alert_policy_service_available?

def self.alert_policy_service_available?(version: :v3) -> boolean

Determines whether the AlertPolicyService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.alert_policy_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AlertPolicyService service, or if the versioned client gem needs an update to support the AlertPolicyService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-monitoring library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.monitoring)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.group_service

def self.group_service(version: :v3, &block) -> ::Object

Create a new client object for GroupService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::GroupService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the GroupService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the GroupService service. You can determine whether the method will succeed by calling Monitoring.group_service_available?.

About 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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.group_service_available?

def self.group_service_available?(version: :v3) -> boolean

Determines whether the GroupService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.group_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the GroupService service, or if the versioned client gem needs an update to support the GroupService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.metric_service

def self.metric_service(version: :v3, &block) -> ::Object

Create a new client object for MetricService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::MetricService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the MetricService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the MetricService service. You can determine whether the method will succeed by calling Monitoring.metric_service_available?.

About MetricService

Manages metric descriptors, monitored resource descriptors, and time series data.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.metric_service_available?

def self.metric_service_available?(version: :v3) -> boolean

Determines whether the MetricService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.metric_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the MetricService service, or if the versioned client gem needs an update to support the MetricService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.notification_channel_service

def self.notification_channel_service(version: :v3, &block) -> ::Object

Create a new client object for NotificationChannelService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::NotificationChannelService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the NotificationChannelService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the NotificationChannelService service. You can determine whether the method will succeed by calling Monitoring.notification_channel_service_available?.

About NotificationChannelService

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.notification_channel_service_available?

def self.notification_channel_service_available?(version: :v3) -> boolean

Determines whether the NotificationChannelService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.notification_channel_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the NotificationChannelService service, or if the versioned client gem needs an update to support the NotificationChannelService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.query_service

def self.query_service(version: :v3, &block) -> ::Object

Create a new client object for QueryService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::QueryService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the QueryService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the QueryService service. You can determine whether the method will succeed by calling Monitoring.query_service_available?.

About 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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.query_service_available?

def self.query_service_available?(version: :v3) -> boolean

Determines whether the QueryService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.query_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the QueryService service, or if the versioned client gem needs an update to support the QueryService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.service_monitoring_service

def self.service_monitoring_service(version: :v3, &block) -> ::Object

Create a new client object for ServiceMonitoringService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::ServiceMonitoringService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the ServiceMonitoringService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the ServiceMonitoringService service. You can determine whether the method will succeed by calling Monitoring.service_monitoring_service_available?.

About 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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.service_monitoring_service_available?

def self.service_monitoring_service_available?(version: :v3) -> boolean

Determines whether the ServiceMonitoringService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.service_monitoring_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ServiceMonitoringService service, or if the versioned client gem needs an update to support the ServiceMonitoringService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.snooze_service

def self.snooze_service(version: :v3, &block) -> ::Object

Create a new client object for SnoozeService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::SnoozeService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the SnoozeService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the SnoozeService service. You can determine whether the method will succeed by calling Monitoring.snooze_service_available?.

About 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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.snooze_service_available?

def self.snooze_service_available?(version: :v3) -> boolean

Determines whether the SnoozeService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.snooze_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SnoozeService service, or if the versioned client gem needs an update to support the SnoozeService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

.uptime_check_service

def self.uptime_check_service(version: :v3, &block) -> ::Object

Create a new client object for UptimeCheckService.

By default, this returns an instance of Google::Cloud::Monitoring::V3::UptimeCheckService::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the UptimeCheckService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the UptimeCheckService service. You can determine whether the method will succeed by calling Monitoring.uptime_check_service_available?.

About 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".

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (::Object) — A client object for the specified version.

.uptime_check_service_available?

def self.uptime_check_service_available?(version: :v3) -> boolean

Determines whether the UptimeCheckService service is supported by the current client. If true, you can retrieve a client object by calling Monitoring.uptime_check_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the UptimeCheckService service, or if the versioned client gem needs an update to support the UptimeCheckService service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.9.0"