README.md in google-cloud-monitoring-0.38.0 vs README.md in google-cloud-monitoring-1.0.0

- old
+ new

@@ -1,69 +1,53 @@ -# Ruby Client for Cloud Monitoring API +# Ruby Client for the Cloud Monitoring API -[Cloud Monitoring API][Product Documentation]: -Manages your Cloud Monitoring data and configurations. Most projects must -be associated with a Workspace, with a few exceptions as noted on the -individual method pages. The table entries below are presented in -alphabetical order, not in order of common use. For explanations of the -concepts found in the table entries, read the [Cloud Monitoring -documentation](https://cloud.google.com/monitoring/docs). -- [Client Library Documentation][] -- [Product Documentation][] +API Client library for the Cloud Monitoring API -## Quick Start -In order to use this library, you first need to go through the following -steps: +Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation. -1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) -2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) -3. [Enable the Cloud Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com) -4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-monitoring/latest/file.AUTHENTICATION.html) +Actual client classes for the various versions of this API are defined in +_versioned_ client gems, with names of the form `google-cloud-monitoring-v*`. +The gem `google-cloud-monitoring` is a convenience wrapper library that brings the +verisoned gems in as dependencies, and provides high-level methods for +constructing clients. -### Installation +View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-monitoring/latest) +for this library, google-cloud-monitoring, to see the convenience methods for +constructing client objects. Reference documentation for the client objects +themselves can be found in the client library documentation for the versioned +client gems: +[google-cloud-monitoring-v3](https://googleapis.dev/ruby/google-cloud-monitoring-v3/latest). + +See also the [Product Documentation](https://cloud.google.com/monitoring) +for more usage information. + +## Quick Start + ``` $ gem install google-cloud-monitoring ``` -### Preview -#### MetricServiceClient -```rb -require "google/cloud/monitoring" +In order to use this library, you first need to go through the following steps: -metric_client = Google::Cloud::Monitoring::Metric.new -formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id) +1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) +1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) +1. [Enable the API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com) +1. {file:AUTHENTICATION.md Set up authentication.} -# Iterate over all results. -metric_client.list_monitored_resource_descriptors(formatted_name).each do |element| - # Process element. -end +## Migrating from 0.x versions -# 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 -``` +The 1.0 release of the google-cloud-monitoring client is a significant upgrade +based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby), +and includes substantial interface changes. Existing code written for earlier +versions of this library will likely require updates to use this version. +See the {file:MIGRATING.md MIGRATING.md} document for more information. -### Next Steps -- Read the [Client Library Documentation][] for Cloud Monitoring API - to see other available methods on the client. -- Read the [Cloud Monitoring API Product documentation][Product Documentation] - to learn more about the product and see How-to Guides. -- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md) - to see the full list of Cloud APIs that we cover. - -[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-monitoring/latest -[Product Documentation]: https://cloud.google.com/monitoring - ## Enabling Logging To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. -The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, +The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest) -that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) +that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information. Configuring a Ruby stdlib logger: ```ruby