diff --git a/google-cloud-monitoring/README.md b/google-cloud-monitoring/README.md index 14e233381fa7..d0f1459b352f 100644 --- a/google-cloud-monitoring/README.md +++ b/google-cloud-monitoring/README.md @@ -1,45 +1,50 @@ -Stackdriver Monitoring API for Ruby -================================================= +# Ruby Client for Stackdriver Monitoring API (Alpha) -google-cloud-monitoring uses [Google API extensions][google-gax] to provide an -easy-to-use client library for the [Stackdriver Monitoring API][] (v3) defined in the [googleapis][] git repository +Idiomatic Ruby client for [Stackdriver Monitoring API][Product Documentation] +- [Client Library Documentation][] +- [Product Documentation][] -[googleapis]: https://github.com/googleapis/googleapis/tree/master/google/monitoring/v3 -[google-gax]: https://github.com/googleapis/gax-ruby -[Stackdriver Monitoring API]: https://developers.google.com/apis-explorer/#p/monitoring/v3/ +## Quick Start +In order to use this library, you first need to go through the following steps: -Getting started ---------------- +- [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) +- [Enable the monitoring api.](https://console.cloud.google.com/apis/api/monitoring) +- [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication) -google-cloud-monitoring will allow you to connect to the [Stackdriver Monitoring API][] and access all its methods. +### Installation +``` +$ gem install google-cloud-monitoring +``` -In order to achieve so you need to set up authentication as well as install the library locally. +### Preview +#### MetricServiceClient +```rb + require "google/cloud/monitoring/v3" + MetricServiceClient = Google::Cloud::Monitoring::V3::MetricServiceClient -Setup Authentication --------------------- + metric_service_client = MetricServiceClient.new + formatted_name = MetricServiceClient.project_path(project_id) -To authenticate all your API calls, first install and setup the [Google Cloud SDK][]. -Once done, you can then run the following command in your terminal: + # Iterate over all results. + metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element| + # Process element. + end - $ gcloud beta auth application-default login + # 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 +``` -or +### Next Steps +- Read the [Client Library Documentation][] for Stackdriver Monitoring API to see other available methods on the client. +- Read the [Stackdriver 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/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md) to see the full list of Cloud APIs that we cover. - $ gcloud auth login - -Please see [gcloud beta auth application-default login][] document for the difference between these commands. - -[Google Cloud SDK]: https://cloud.google.com/sdk/ -[gcloud beta auth application-default login]: https://cloud.google.com/sdk/gcloud/reference/beta/auth/application-default/login - - -Installation -------------------- - -Install this library using gem: - - $ [sudo] gem install google-cloud-monitoring - -At this point you are all set to continue. +[Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-monitoring/latest/google/monitoring/v3 +[Product Documentation]: https://cloud.google.com/monitoring \ No newline at end of file