Module: Google::Cloud::Monitoring

Defined in:
lib/google/cloud/monitoring.rb,
lib/google/cloud/monitoring/version.rb,
lib/google/cloud/monitoring/dashboard.rb,
lib/google/cloud/monitoring/metrics_scope.rb,
lib/google/cloud/monitoring/dashboard/version.rb,
lib/google/cloud/monitoring/metrics_scope/version.rb

Defined Under Namespace

Modules: Dashboard, MetricsScope

Constant Summary collapse

VERSION = 
"1.8.3"

Class Method Summary collapse

Class Method Details

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

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.

Parameters:

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



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/cloud/monitoring.rb', line 75

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:AlertPolicyService)
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.monitoring| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



351
352
353
354
355
 
# File 'lib/google/cloud/monitoring.rb', line 351

def self.configure
  yield ::Google::Cloud.configure.monitoring if block_given?

  ::Google::Cloud.configure.monitoring
end

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

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.

Parameters:

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



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/google/cloud/monitoring.rb', line 116

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:GroupService)
  service_module.const_get(:Client).new(&block)
end

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

About MetricService

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

Parameters:

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



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/monitoring.rb', line 147

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:MetricService)
  service_module.const_get(:Client).new(&block)
end

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

About NotificationChannelService

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

Parameters:

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



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/google/cloud/monitoring.rb', line 178

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:NotificationChannelService)
  service_module.const_get(:Client).new(&block)
end

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

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.

Parameters:

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



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/google/cloud/monitoring.rb', line 210

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:QueryService)
  service_module.const_get(:Client).new(&block)
end

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

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.

Parameters:

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



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/google/cloud/monitoring.rb', line 243

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:ServiceMonitoringService)
  service_module.const_get(:Client).new(&block)
end

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

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.

Parameters:

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



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/google/cloud/monitoring.rb', line 275

def self.snooze_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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:SnoozeService)
  service_module.const_get(:Client).new(&block)
end

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

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

Parameters:

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



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/google/cloud/monitoring.rb', line 312

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
  service_module = Google::Cloud::Monitoring.const_get(package_name).const_get(:UptimeCheckService)
  service_module.const_get(:Client).new(&block)
end