Module: Google::Cloud::Monitoring::V3

Defined in:
lib/google/cloud/monitoring/v3.rb,
lib/google/cloud/monitoring/v3/credentials.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.

Quick Start

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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Stackdriver Monitoring API.
  4. Setup Authentication.

Installation

$ gem install google-cloud-monitoring

Preview

MetricServiceClient

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)

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

# Or iterate over results one page at a time.
metric_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

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 Classes: AlertPolicyServiceClient, Credentials, GroupServiceClient, MetricServiceClient, NotificationChannelServiceClient, UptimeCheckServiceClient