module Google::Cloud::Monitoring

Constants

VERSION

Public Class Methods

alert_policy_service(version: :v3, &block) click to toggle source

Create a new client object for AlertPolicyService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::AlertPolicyService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/AlertPolicyService/Client.html) for version V3 of the API. However, you can specify 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.

## About AlertPolicyService

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver 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 [Stackdriver Monitoring](cloud.google.com/monitoring/docs/), which can be reached by clicking the “Monitoring” tab in [Cloud Console](console.cloud.google.com/).

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [AlertPolicyService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 74
def self.alert_policy_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:AlertPolicyService).const_get(:Client).new(&block)
end
configure() { |configure.monitoring| ... } click to toggle source

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

@return [::Google::Cloud::Config] The default configuration used by this library

# File lib/google/cloud/monitoring.rb, line 318
def self.configure
  yield ::Google::Cloud.configure.monitoring if block_given?

  ::Google::Cloud.configure.monitoring
end
group_service(version: :v3, &block) click to toggle source

Create a new client object for GroupService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::GroupService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/GroupService/Client.html) for version V3 of the API. However, you can specify 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.

## About GroupService

The Group API lets you inspect and manage your [groups](google.monitoring.v3.Group).

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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [GroupService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 115
def self.group_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:GroupService).const_get(:Client).new(&block)
end
metric_service(version: :v3, &block) click to toggle source

Create a new client object for MetricService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::MetricService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/MetricService/Client.html) for version V3 of the API. However, you can specify 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.

## About MetricService

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

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [MetricService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 146
def self.metric_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:MetricService).const_get(:Client).new(&block)
end
notification_channel_service(version: :v3, &block) click to toggle source

Create a new client object for NotificationChannelService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::NotificationChannelService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/NotificationChannelService/Client.html) for version V3 of the API. However, you can specify 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.

## About NotificationChannelService

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

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [NotificationChannelService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 177
def self.notification_channel_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:NotificationChannelService).const_get(:Client).new(&block)
end
query_service(version: :v3, &block) click to toggle source

Create a new client object for QueryService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::QueryService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/QueryService/Client.html) for version V3 of the API. However, you can specify 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.

## About QueryService

The QueryService API is used to manage time series data in Stackdriver Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [QueryService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 209
def self.query_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:QueryService).const_get(:Client).new(&block)
end
service_monitoring_service(version: :v3, &block) click to toggle source

Create a new client object for ServiceMonitoringService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::ServiceMonitoringService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/ServiceMonitoringService/Client.html) for version V3 of the API. However, you can specify 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.

## About ServiceMonitoringService

The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the `Service`'s monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [ServiceMonitoringService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 242
def self.service_monitoring_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:ServiceMonitoringService).const_get(:Client).new(&block)
end
uptime_check_service(version: :v3, &block) click to toggle source

Create a new client object for UptimeCheckService.

By default, this returns an instance of [Google::Cloud::Monitoring::V3::UptimeCheckService::Client](googleapis.dev/ruby/google-cloud-monitoring-v3/latest/Google/Cloud/Monitoring/V3/UptimeCheckService/Client.html) for version V3 of the API. However, you can specify 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.

## About UptimeCheckService

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver 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] (console.cloud.google.com), selecting the appropriate project, clicking on “Monitoring” on the left-hand side to navigate to Stackdriver, and then clicking on “Uptime”.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v3`.

@return [UptimeCheckService::Client] A client object for the specified version.

# File lib/google/cloud/monitoring.rb, line 279
def self.uptime_check_service version: :v3, &block
  require "google/cloud/monitoring/#{version.to_s.downcase}"

  package_name = Google::Cloud::Monitoring
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Monitoring.const_get package_name
  package_module.const_get(:UptimeCheckService).const_get(:Client).new(&block)
end