google-cloud-logging 0.20.1 → 0.21.0

data/lib/google/cloud/logging/credentials.rb

@@ -25,6 +25,16 @@ module Google
         PATH_ENV_VARS = %w(LOGGING_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
         JSON_ENV_VARS = %w(LOGGING_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
                            GCLOUD_KEYFILE_JSON)
+
+        ##
+        # @private Create credentials with given scope and/or keyfile
+        def self.credentials_with_scope keyfile, scope = nil
+          if keyfile.nil?
+            default(scope: scope)
+          else
+            new(keyfile, scope: scope)
+          end
+        end
       end
     end
   end

data/lib/google/cloud/logging/entry.rb

@@ -39,16 +39,15 @@ module Google
       # applications. For example, the log `compute.googleapis.com/activity_log`
       # is produced by Google Compute Engine. Logs are simply referenced by name
       # in google-cloud. There is no `Log` type in google-cloud or `Log`
-      # resource in the Cloud Logging API.
+      # resource in the Stackdriver Logging API.
       #
       # @see https://cloud.google.com/logging/docs/view/logs_index List of Log
       #   Types
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/logging"
       #
-      #   gcloud = Google::Cloud.new
-      #   logging = gcloud.logging
+      #   logging = Google::Cloud::Logging.new
       #
       #   entry = logging.entry payload: "Job started.", log_name: "my_app_log"
       #   entry.resource.type = "gae_app"
@@ -112,10 +111,9 @@ module Google
         # Sets the severity level to `:DEFAULT`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity = :DEBUG
@@ -137,10 +135,9 @@ module Google
         # Sets the severity level to `:DEBUG`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -162,10 +159,9 @@ module Google
         # Sets the severity level to `:INFO`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -187,10 +183,9 @@ module Google
         # Sets the severity level to `:NOTICE`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -212,10 +207,9 @@ module Google
         # Sets the severity level to `:WARNING`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -237,10 +231,9 @@ module Google
         # Sets the severity level to `:ERROR`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -262,10 +255,9 @@ module Google
         # Sets the severity level to `:CRITICAL`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -287,10 +279,9 @@ module Google
         # Sets the severity level to `:ALERT`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -312,10 +303,9 @@ module Google
         # Sets the severity level to `:EMERGENCY`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   entry = logging.entry
         #   entry.severity #=> :DEFAULT
@@ -461,7 +451,7 @@ module Google
         # @private Get a Time object from a Google::Protobuf::Timestamp object.
         def self.extract_timestamp grpc
           return nil if grpc.timestamp.nil?
-          Time.at grpc.timestamp.seconds, grpc.timestamp.nanos/1000.0
+          Time.at grpc.timestamp.seconds, Rational(grpc.timestamp.nanos, 1000)
         end
       end
     end

data/lib/google/cloud/logging/entry/list.rb

@@ -39,10 +39,9 @@ module Google
           # @return [Boolean]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #
           #   entries = logging.entries
           #   if entries.next?
@@ -59,10 +58,9 @@ module Google
           # @return [Sink::List]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #
           #   entries = dataset.entries
           #   if entries.next?
@@ -97,10 +95,9 @@ module Google
           # @return [Enumerator]
           #
           # @example Iterating each log entry by passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   entries = logging.entries order: "timestamp desc"
           #
           #   entries.all do |entry|
@@ -108,10 +105,9 @@ module Google
           #   end
           #
           # @example Using the enumerator by not passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   entries = logging.entries order: "timestamp desc"
           #
           #   all_payloads = entries.all.map do |entry|
@@ -119,10 +115,9 @@ module Google
           #   end
           #
           # @example Limit the number of API calls made:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   entries = logging.entries order: "timestamp desc"
           #
           #   entries.all(request_limit: 10) do |entry|

data/lib/google/cloud/logging/logger.rb

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+require "orderedhash"
+
 module Google
   module Cloud
     module Logging
@@ -22,10 +24,9 @@ module Google
       # A (mostly) API-compatible logger for ruby's Logger.
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/logging"
       #
-      #   gcloud = Google::Cloud.new
-      #   logging = gcloud.logging
+      #   logging = Google::Cloud::Logging.new
       #
       #   resource = logging.resource "gae_app",
       #                               module_id: "1",
@@ -36,29 +37,71 @@ module Google
       #
       class Logger
         ##
-        # @private The logging object.
-        attr_accessor :logging
+        # The Google Cloud writer object that calls to {#write_entries} are made
+        # on. Either an AsyncWriter or Project object.
+        attr_reader :writer
 
         ##
-        # @private The Google Cloud log_name to write the log entry with.
+        # The Google Cloud log_name to write the log entry with.
         attr_reader :log_name
 
         ##
-        # @private The Google Cloud resource to write the log entry with.
+        # The Google Cloud resource to write the log entry with.
         attr_reader :resource
 
         ##
-        # @private The Google Cloud labels to write the log entry with.
+        # The Google Cloud labels to write the log entry with.
         attr_reader :labels
 
         ##
-        # @private Creates a new Logger instance.
-        def initialize logging, log_name, resource, labels = nil
-          @logging = logging
+        # A OrderedHash of Thread IDs to Stackdriver request trace ID. The
+        # Stackdriver trace ID is a shared request identifier across all
+        # Stackdriver services.
+        attr_reader :trace_ids
+
+        ##
+        # Create a new Logger instance.
+        #
+        # @param [#write_entries] writer The object that will transmit log
+        #   entries. Generally, to create a logger that blocks on transmitting
+        #   log entries, pass the Project; otherwise, to create a logger that
+        #   transmits log entries in the background, pass an AsyncWriter. You
+        #   may also pass any other object that responds to #write_entries.
+        # @param [String] log_name A log resource name to be associated with the
+        #   written log entries.
+        # @param [Google::Cloud::Logging::Resource] resource The monitored
+        #   resource to be associated with written log entries.
+        # @param [Hash] labels A set of user-defined data to be associated with
+        #   written log entries.
+        #
+        # @return [Google::Cloud::Logging::Logger] a Logger object that can be
+        #   used in place of a ruby standard library logger object.
+        #
+        # @example
+        #   require "google/cloud/logging"
+        #
+        #   logging = Google::Cloud::Logging.new
+        #
+        #   writer = logging.async_writer max_queue_size: 1000
+        #
+        #   resource = logging.resource "gae_app", labels: {
+        #                                 "module_id" => "1",
+        #                                 "version_id" => "20150925t173233" }
+        #                               }
+        #
+        #   logger = Google::Cloud::Logging::Logger.new writer,
+        #                                               "my_app_log",
+        #                                               resource,
+        #                                               env: :production
+        #   logger.info "Job started."
+        #
+        def initialize writer, log_name, resource, labels = nil
+          @writer = writer
           @log_name = log_name
           @resource = resource
           @labels = labels
           @level = 0 # DEBUG is the default behavior
+          @trace_ids = OrderedHash.new
         end
 
         ##
@@ -243,10 +286,9 @@ module Google
         #   name of the severity level
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #
         #   resource = logging.resource "gae_app",
         #                               module_id: "1",
@@ -264,19 +306,46 @@ module Google
         end
         alias_method :sev_threshold=, :level=
 
+        ##
+        # Track a given trace_id by associating it with the current
+        # Thread
+        #
+        # @param [String] trace_id The HTTP_X_CLOUD_TRACE_CONTEXT HTTP request
+        #   header that's shared and tracked by all Stackdriver services
+        def add_trace_id trace_id
+          trace_ids[current_thread_id] = trace_id
+
+          # Start removing old entries if hash gets too large.
+          # This should never happen, because middleware should automatically
+          # remove entries when a request is finished
+          trace_ids.shift if trace_ids.size > 10_000
+        end
+
+        ##
+        # Untrack the trace_id that's associated with current Thread
+        #
+        # @return The trace_id that's being deleted
+        def delete_trace_id
+          trace_ids.delete current_thread_id
+        end
+
         protected
 
         ##
         # @private Write a log entry to the Stackdriver Logging service.
         def write_entry severity, message
-          entry = logging.entry.tap do |e|
+          entry = Entry.new.tap do |e|
             e.severity = gcloud_severity(severity)
             e.payload = message
           end
 
-          logging.write_entries entry, log_name: log_name,
-                                       resource: resource,
-                                       labels: labels
+          # merge input labels and trace_id
+          trace_id = trace_ids[current_thread_id]
+          merged_labels = trace_id.nil? ? {} : { traceId: trace_id }
+          merged_labels = labels.merge(merged_labels) unless labels.nil?
+
+          writer.write_entries entry, log_name: log_name, resource: resource,
+                                      labels: merged_labels
         end
 
         ##
@@ -303,6 +372,12 @@ module Google
         rescue
           :DEFAULT
         end
+
+        ##
+        # @private Get current thread id
+        def current_thread_id
+          Thread.current.object_id
+        end
       end
     end
   end

data/lib/google/cloud/logging/metric.rb

@@ -32,10 +32,9 @@ module Google
       # @see https://cloud.google.com/monitoring/docs Google Cloud Monitoring
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/logging"
       #
-      #   gcloud = Google::Cloud.new
-      #   logging = gcloud.logging
+      #   logging = Google::Cloud::Logging.new
       #   metric = logging.create_metric "errors", "severity>=ERROR"
       #
       class Metric
@@ -95,10 +94,9 @@ module Google
         # Updates the logs-based metric.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #   metric = logging.metric "severe_errors"
         #   metric.filter = "logName:syslog AND severity>=ERROR"
         #   metric.save
@@ -114,10 +112,9 @@ module Google
         # service.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #   metric = logging.metric "severe_errors"
         #   metric.filter = "Unwanted value"
         #   metric.reload!
@@ -136,10 +133,9 @@ module Google
         # @return [Boolean] Returns `true` if the metric was deleted.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/logging"
         #
-        #   gcloud = Google::Cloud.new
-        #   logging = gcloud.logging
+        #   logging = Google::Cloud::Logging.new
         #   metric = logging.metric "severe_errors"
         #   metric.delete
         #

data/lib/google/cloud/logging/metric/list.rb

@@ -40,10 +40,9 @@ module Google
           # @return [Boolean]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #
           #   metrics = logging.metrics
           #   if metrics.next?
@@ -60,10 +59,9 @@ module Google
           # @return [Sink::List]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #
           #   metrics = dataset.metrics
           #   if metrics.next?
@@ -96,10 +94,9 @@ module Google
           # @return [Enumerator]
           #
           # @example Iterating each metric by passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   metrics = logging.metrics
           #
           #   metrics.all do |metric|
@@ -107,10 +104,9 @@ module Google
           #   end
           #
           # @example Using the enumerator by not passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   metrics = logging.metrics
           #
           #   all_names = metrics.all.map do |metric|
@@ -118,10 +114,9 @@ module Google
           #   end
           #
           # @example Limit the number of API calls made:
-          #   require "google/cloud"
+          #   require "google/cloud/logging"
           #
-          #   gcloud = Google::Cloud.new
-          #   logging = gcloud.logging
+          #   logging = Google::Cloud::Logging.new
           #   metrics = logging.metrics
           #
           #   metrics.all(request_limit: 10) do |metric|