gcloud 0.11.0 → 0.12.0

data/lib/gcloud/logging/entry/list.rb

@@ -74,8 +74,6 @@ module Gcloud
           grpc = @service.list_entries token: token, projects: @projects,
                                        filter: @filter, order: @order, max: @max
           self.class.from_grpc grpc, @service
-        rescue GRPC::BadStatus => e
-          raise Gcloud::Error.from_error(e)
         end
 
         ##

data/lib/gcloud/logging/logger.rb

@@ -266,7 +266,7 @@ module Gcloud
       protected
 
       ##
-      # @private Write a log entry to Google Cloud Logging service.
+      # @private Write a log entry to the Stackdriver Logging service.
       def write_entry severity, message
         entry = logging.entry.tap do |e|
           e.severity = gcloud_severity(severity)

data/lib/gcloud/logging/metric.rb

@@ -104,9 +104,7 @@ module Gcloud
       def save
         ensure_service!
         @grpc = service.update_metric name, description, filter
-        return true
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
+        true
       end
 
       ##
@@ -126,9 +124,7 @@ module Gcloud
       def reload!
         ensure_service!
         @grpc = service.get_metric name
-        return true
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
+        true
       end
       alias_method :refresh!, :reload!
 
@@ -148,9 +144,7 @@ module Gcloud
       def delete
         ensure_service!
         service.delete_metric name
-        return true
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
+        true
       end
 
       ##

data/lib/gcloud/logging/metric/list.rb

@@ -73,8 +73,6 @@ module Gcloud
           ensure_service!
           grpc = @service.list_metrics token: token, max: @max
           self.class.from_grpc grpc, @service
-        rescue GRPC::BadStatus => e
-          raise Gcloud::Error.from_error(e)
         end
 
         ##

data/lib/gcloud/logging/project.rb

@@ -30,7 +30,7 @@ module Gcloud
     #
     # Projects are top-level containers in Google Cloud Platform. They store
     # information about billing and authorized users, and they control access to
-    # Google Cloud Logging resources. Each project has a friendly name and a
+    # Stackdriver Logging resources. Each project has a friendly name and a
     # unique ID. Projects can be created only in the [Google Developers
     # Console](https://console.developers.google.com). See {Gcloud#logging}.
     #
@@ -49,10 +49,8 @@ module Gcloud
 
       ##
       # @private Creates a new Connection instance.
-      def initialize project, credentials
-        project = project.to_s # Always cast to a string
-        fail ArgumentError, "project is missing" if project.empty?
-        @service = Service.new project, credentials
+      def initialize service
+        @service = service
       end
 
       ##
@@ -149,16 +147,35 @@ module Gcloud
                                          order: order, token: token, max: max
         Entry::List.from_grpc list_grpc, service, projects: projects, max: max,
                                                   filter: filter, order: order
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :find_entries, :entries
 
       ##
       # Creates an new Entry instance that may be populated and written to the
-      # Cloud Logging service. The {Entry#resource} attribute is pre-populated
-      # with a new {Gcloud::Logging::Resource} instance. Equivalent to calling
-      # `Gcloud::Logging::Entry.new`.
+      # Stackdriver Logging service. The {Entry#resource} attribute is
+      # pre-populated with a new {Gcloud::Logging::Resource} instance.
+      # Equivalent to calling `Gcloud::Logging::Entry.new`.
+      #
+      # @param [String] log_name The resource name of the log to which this log
+      #   entry belongs. See also {Entry#log_name=}.
+      # @param [Resource] resource The monitored resource associated with this
+      #   log entry. See also {Entry#resource}.
+      # @param [Time] timestamp The time the event described by the log entry
+      #   occurred. If omitted, Stackdriver Logging will use the time the log
+      #   entry is written. See also {Entry#timestamp}.
+      # @param [Symbol] severity The severity level of the log entry. The
+      #   default value is `DEFAULT`. See also {Entry#severity}.
+      # @param [String] insert_id A unique ID for the log entry. If you provide
+      #   this field, the logging service considers other log entries in the
+      #   same log with the same ID as duplicates which can be removed. If
+      #   omitted, Stackdriver Logging will generate a unique ID for this log
+      #   entry. See also {Entry#insert_id}.
+      # @param [Hash{Symbol,String => String}] labels A hash of user-defined
+      #   `key:value` pairs that provide additional information about the log
+      #   entry. See also {Entry#labels=}.
+      # @param [String, Hash] payload The log entry payload, represented as
+      #   either a string, a hash (JSON), or a hash (protocol buffer). See also
+      #   {Entry#payload}.
       #
       # @return [Gcloud::Logging::Entry] a new Entry instance
       #
@@ -168,19 +185,26 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   logging = gcloud.logging
       #
-      #   entry = logging.entry
-      #   entry.severity = :INFO
-      #   entry.payload = "Job started."
+      #   entry = logging.entry severity: :INFO, payload: "Job started."
       #
       #   logging.write_entries entry
       #
-      def entry
-        Entry.new
+      def entry log_name: nil, resource: nil, timestamp: nil, severity: nil,
+                insert_id: nil, labels: nil, payload: nil
+        e = Entry.new
+        e.log_name = log_name if log_name
+        e.resource = resource if resource
+        e.timestamp = timestamp if timestamp
+        e.severity = severity if severity
+        e.insert_id = insert_id if insert_id
+        e.labels = labels if labels
+        e.payload = payload if payload
+        e
       end
       alias_method :new_entry, :entry
 
       ##
-      # Writes log entries to the Cloud Logging service.
+      # Writes log entries to the Stackdriver Logging service.
       #
       # If you write a collection of log entries, you can provide the log name,
       # resource, and/or labels hash to be used for all of the entries, and omit
@@ -208,9 +232,7 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   logging = gcloud.logging
       #
-      #   entry = logging.entry
-      #   entry.payload = "Job started."
-      #   entry.log_name = "my_app_log"
+      #   entry = logging.entry payload: "Job started.", log_name: "my_app_log"
       #   entry.resource.type = "gae_app"
       #   entry.resource.labels[:module_id] = "1"
       #   entry.resource.labels[:version_id] = "20150925t173233"
@@ -223,12 +245,10 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   logging = gcloud.logging
       #
-      #   entry1 = logging.entry
-      #   entry1.payload = "Job started."
-      #   entry2 = logging.entry
-      #   entry2.payload = "Job completed."
-      #   labels = { job_size: "large", job_code: "red" }
+      #   entry1 = logging.entry payload: "Job started."
+      #   entry2 = logging.entry payload: "Job completed."
       #
+      #   labels = { job_size: "large", job_code: "red" }
       #   resource = logging.resource "gae_app",
       #                               "module_id" => "1",
       #                               "version_id" => "20150925t173233"
@@ -243,9 +263,7 @@ module Gcloud
         service.write_entries Array(entries).map(&:to_grpc),
                               log_name: log_name, resource: resource,
                               labels: labels
-        return true
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
+        true
       end
 
       ##
@@ -302,14 +320,12 @@ module Gcloud
       def delete_log name
         ensure_service!
         service.delete_log name
-        return true
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
+        true
       end
 
       ##
       # Retrieves the list of monitored resource descriptors that are used by
-      # Google Cloud Logging.
+      # Stackdriver Logging.
       #
       # @see https://cloud.google.com/logging/docs/api/introduction_v2#monitored_resources
       #   Monitored Resources
@@ -347,8 +363,6 @@ module Gcloud
         ensure_service!
         list_grpc = service.list_resource_descriptors token: token, max: max
         ResourceDescriptor::List.from_grpc list_grpc, service, max
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :find_resource_descriptors, :resource_descriptors
 
@@ -410,15 +424,13 @@ module Gcloud
         ensure_service!
         list_grpc = service.list_sinks token: token, max: max
         Sink::List.from_grpc list_grpc, service, max
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :find_sinks, :sinks
 
       ##
       # Creates a new project sink. When you create a sink, only new log entries
-      # that match the sink's filter are exported. Cloud Logging does not send
-      # previously-ingested log entries to the sink's destination.
+      # that match the sink's filter are exported. Stackdriver Logging does not
+      # send previously-ingested log entries to the sink's destination.
       #
       # Before creating the sink, ensure that you have granted
       # `cloud-logs@google.com` permission to write logs to the destination. See
@@ -446,12 +458,12 @@ module Gcloud
       #  that defines the log entries to be exported. The filter must be
       #  consistent with the log entry format designed by the `version`
       #  parameter, regardless of the format of the log entry that was
-      #  originally written to Cloud Logging.
+      #  originally written to Stackdriver Logging.
       # @param [Symbol] version The log entry version used when exporting log
       #   entries from this sink. This version does not have to correspond to
-      #   the version of the log entry when it was written to Cloud Logging.
-      #   Accepted values are `:unspecified`, `:v2`, and `:v1`. Version 2 is
-      #   currently the preferred format. An unspecified version format
+      #   the version of the log entry when it was written to Stackdriver
+      #   Logging. Accepted values are `:unspecified`, `:v2`, and `:v1`. Version
+      #   2 is currently the preferred format. An unspecified version format
       #   currently defaults to V2 in the service. The default value is
       #   `:unspecified`.
       #
@@ -466,7 +478,7 @@ module Gcloud
       #
       #   bucket = storage.create_bucket "my-logs-bucket"
       #
-      #   # Grant owner permission to Cloud Logging service
+      #   # Grant owner permission to Stackdriver Logging service
       #   email = "cloud-logs@google.com"
       #   bucket.acl.add_owner "group-#{email}"
       #
@@ -478,8 +490,6 @@ module Gcloud
         ensure_service!
         grpc = service.create_sink name, destination, filter, version
         Sink.from_grpc grpc, service
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :new_sink, :create_sink
 
@@ -509,9 +519,8 @@ module Gcloud
         ensure_service!
         grpc = service.get_sink sink_name
         Sink.from_grpc grpc, service
-      rescue GRPC::BadStatus => e
-        return nil if e.code == 5
-        raise Gcloud::Error.from_error(e)
+      rescue Gcloud::NotFoundError
+        nil
       end
       alias_method :get_sink, :sink
       alias_method :find_sink, :sink
@@ -551,8 +560,6 @@ module Gcloud
         ensure_service!
         grpc = service.list_metrics token: token, max: max
         Metric::List.from_grpc grpc, service, max
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :find_metrics, :metrics
 
@@ -587,8 +594,6 @@ module Gcloud
         ensure_service!
         grpc = service.create_metric name, filter, description
         Metric.from_grpc grpc, service
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
       end
       alias_method :new_metric, :create_metric
 
@@ -618,9 +623,8 @@ module Gcloud
         ensure_service!
         grpc = service.get_metric name
         Metric.from_grpc grpc, service
-      rescue GRPC::BadStatus => e
-        return nil if e.code == 5
-        raise Gcloud::Error.from_error(e)
+      rescue Gcloud::NotFoundError
+        nil
       end
       alias_method :get_metric, :metric
       alias_method :find_metric, :metric

data/lib/gcloud/logging/resource_descriptor.rb

@@ -20,8 +20,8 @@ module Gcloud
     ##
     # # ResourceDescriptor
     #
-    # Describes a type of monitored resource supported by Cloud Logging. Each
-    # ResourceDescriptor has a type name, such as `cloudsql_database`,
+    # Describes a type of monitored resource supported by Stackdriver Logging.
+    # Each ResourceDescriptor has a type name, such as `cloudsql_database`,
     # `gae_app`, or `gce_instance`. It also specifies a set of labels that must
     # all be given values in a {Resource} instance to represent an actual
     # instance of the type.

data/lib/gcloud/logging/resource_descriptor/list.rb

@@ -74,8 +74,6 @@ module Gcloud
           ensure_service!
           list_grpc = @service.list_resource_descriptors token: token, max: @max
           self.class.from_grpc list_grpc, @service
-        rescue GRPC::BadStatus => e
-          raise Gcloud::Error.from_error(e)
         end
 
         ##

data/lib/gcloud/logging/service.rb

@@ -13,10 +13,12 @@
 # limitations under the License.
 
 
+require "gcloud/backoff"
+require "gcloud/errors"
 require "google/logging/v2/logging_services"
 require "google/logging/v2/logging_config_services"
 require "google/logging/v2/logging_metrics_services"
-require "gcloud/backoff"
+
 
 module Gcloud
   module Logging
@@ -24,14 +26,16 @@ module Gcloud
     # @private Represents the gRPC Logging service, including all the API
     # methods.
     class Service
-      attr_accessor :project, :credentials, :host
+      attr_accessor :project, :credentials, :host, :retries, :timeout
 
       ##
       # Creates a new Service instance.
-      def initialize project, credentials
+      def initialize project, credentials, host: nil, retries: nil, timeout: nil
         @project = project
         @credentials = credentials
-        @host = "logging.googleapis.com"
+        @host = host || "logging.googleapis.com"
+        @retries = retries
+        @timeout = timeout
       end
 
       def creds
@@ -41,19 +45,22 @@ module Gcloud
 
       def logging
         return mocked_logging if mocked_logging
-        @logging ||= Google::Logging::V2::LoggingServiceV2::Stub.new host, creds
+        @logging ||= Google::Logging::V2::LoggingServiceV2::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_logging
 
       def sinks
         return mocked_sinks if mocked_sinks
-        @sinks ||= Google::Logging::V2::ConfigServiceV2::Stub.new host, creds
+        @sinks ||= Google::Logging::V2::ConfigServiceV2::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_sinks
 
       def metrics
         return mocked_metrics if mocked_metrics
-        @metrics ||= Google::Logging::V2::MetricsServiceV2::Stub.new host, creds
+        @metrics ||= Google::Logging::V2::MetricsServiceV2::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_metrics
 
@@ -68,7 +75,7 @@ module Gcloud
 
         list_req = Google::Logging::V2::ListLogEntriesRequest.new(list_params)
 
-        backoff { logging.list_log_entries list_req }
+        execute { logging.list_log_entries list_req }
       end
 
       def write_entries entries, log_name: nil, resource: nil, labels: nil
@@ -86,7 +93,7 @@ module Gcloud
 
         write_req = Google::Logging::V2::WriteLogEntriesRequest.new write_params
 
-        backoff { logging.write_log_entries write_req }
+        execute { logging.write_log_entries write_req }
       end
 
       def delete_log name
@@ -94,7 +101,7 @@ module Gcloud
           log_name: log_path(name)
         )
 
-        backoff { logging.delete_log delete_req }
+        execute { logging.delete_log delete_req }
       end
 
       def list_resource_descriptors token: nil, max: nil
@@ -106,7 +113,7 @@ module Gcloud
           Google::Logging::V2::ListMonitoredResourceDescriptorsRequest.new(
             list_params)
 
-        backoff { logging.list_monitored_resource_descriptors list_req }
+        execute { logging.list_monitored_resource_descriptors list_req }
       end
 
       def list_sinks token: nil, max: nil
@@ -117,7 +124,7 @@ module Gcloud
 
         list_req = Google::Logging::V2::ListSinksRequest.new(list_params)
 
-        backoff { sinks.list_sinks list_req }
+        execute { sinks.list_sinks list_req }
       end
 
       def create_sink name, destination, filter, version
@@ -131,7 +138,7 @@ module Gcloud
           sink: Google::Logging::V2::LogSink.new(sink_params)
         )
 
-        backoff { sinks.create_sink create_req }
+        execute { sinks.create_sink create_req }
       end
 
       def get_sink name
@@ -139,7 +146,7 @@ module Gcloud
           sink_name: sink_path(name)
         )
 
-        backoff { sinks.get_sink get_req }
+        execute { sinks.get_sink get_req }
       end
 
       def update_sink name, destination, filter, version
@@ -153,7 +160,7 @@ module Gcloud
           sink: Google::Logging::V2::LogSink.new(sink_params)
         )
 
-        backoff { sinks.update_sink update_req }
+        execute { sinks.update_sink update_req }
       end
 
       def delete_sink name
@@ -161,7 +168,7 @@ module Gcloud
           sink_name: sink_path(name)
         )
 
-        backoff { sinks.delete_sink delete_req }
+        execute { sinks.delete_sink delete_req }
       end
 
       def list_metrics token: nil, max: nil
@@ -172,7 +179,7 @@ module Gcloud
 
         list_req = Google::Logging::V2::ListLogMetricsRequest.new(list_params)
 
-        backoff { metrics.list_log_metrics list_req }
+        execute { metrics.list_log_metrics list_req }
       end
 
       def create_metric name, filter, description
@@ -187,7 +194,7 @@ module Gcloud
           metric: Google::Logging::V2::LogMetric.new(metric_params)
         )
 
-        backoff { metrics.create_log_metric create_req }
+        execute { metrics.create_log_metric create_req }
       end
 
       def get_metric name
@@ -195,7 +202,7 @@ module Gcloud
           metric_name: metric_path(name)
         )
 
-        backoff { metrics.get_log_metric get_req }
+        execute { metrics.get_log_metric get_req }
       end
 
       def update_metric name, description, filter
@@ -210,7 +217,7 @@ module Gcloud
           metric: Google::Logging::V2::LogMetric.new(metric_params)
         )
 
-        backoff { metrics.update_log_metric update_req }
+        execute { metrics.update_log_metric update_req }
       end
 
       def delete_metric name
@@ -218,7 +225,7 @@ module Gcloud
           metric_name: metric_path(name)
         )
 
-        backoff { metrics.delete_log_metric delete_req }
+        execute { metrics.delete_log_metric delete_req }
       end
 
       def inspect
@@ -248,10 +255,12 @@ module Gcloud
         "#{project_path}/metrics/#{metric_name}"
       end
 
-      def backoff options = {}
-        Gcloud::Backoff.new(options).execute_grpc do
+      def execute
+        Gcloud::Backoff.new(retries: retries).execute_grpc do
           yield
         end
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
     end
   end