Module: Google::Cloud::Monitoring

Defined in:: lib/google/cloud/monitoring.rb,
lib/google/cloud/monitoring/v3.rb,
lib/google/cloud/monitoring/v3/credentials.rb,
lib/google/cloud/monitoring/v3/doc/overview.rb,
lib/google/cloud/monitoring/v3/group_service_client.rb,
lib/google/cloud/monitoring/v3/metric_service_client.rb,
lib/google/cloud/monitoring/v3/alert_policy_service_client.rb,
lib/google/cloud/monitoring/v3/uptime_check_service_client.rb,
lib/google/cloud/monitoring/v3/notification_channel_service_client.rb

Overview

Ruby Client for Stackdriver Monitoring API (Beta)

Stackdriver Monitoring API: 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.

Product Documentation

Quick Start

In order to use this library, you first need to go through the following steps:

Installation

$ gem install google-cloud-monitoring

Preview

MetricServiceClient

require "google/cloud/monitoring"

metric_service_client = Google::Cloud::Monitoring::Metric.new
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)

# Iterate over all results.
metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Next Steps

Read the Stackdriver Monitoring API Product documentation to learn more about the product and see How-to Guides.
View this repository's main README to see the full list of Cloud APIs that we cover.

Enabling Logging

To enable logging for this library, set the logger for the underlying gRPC library. The logger that you set may be a Ruby stdlib Logger as shown below, or a Google::Cloud::Logging::Logger that will write logs to Stackdriver Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

require "logger"

module MyLogger
  LOGGER = Logger.new $stderr, level: Logger::WARN
  def logger
    LOGGER
  end
end

# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module GRPC
  extend MyLogger
end

Defined Under Namespace

Modules: AlertPolicy, Group, Metric, NotificationChannel, UptimeCheck, V3

Constant Summary collapse

FILE_DIR = rubocop:enable LineLength

File.realdirpath(Pathname.new(__FILE__).join("..").join("monitoring"))

AVAILABLE_VERSIONS =

Dir["#{FILE_DIR}/*"]
.select { |file| File.directory?(file) }
.select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
.select { |dir| File.exist?(dir + ".rb") }
.map { |dir| File.basename(dir) }