google-cloud-logging 0.23.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2658b3d8de071df00d572f934df7ba5ae0be360d
-  data.tar.gz: 18b9dd38df8bc706d2aa821b0f6030fdda4abef3
+  metadata.gz: a74cfb2524ed0697d16624513a1cd6f8731525ba
+  data.tar.gz: f5022540c7a2ec3fecc06b730ee1c787c6920527
 SHA512:
-  metadata.gz: 889cb152ecd3759eb2b586a18dd6043ea47f85d565e80c55b65f70a23fabbcefd140409f6c27a298ccb6992cf196e6178368c6bbea100a33112bd522ae38d58d
-  data.tar.gz: 7ef4b2783d70281cdc5b0a4216098cf9e0a49c359a8af8f52d17e9b947d70ae4628d72ef06b56d77eaaefc1eb2d71b96e3bb329e1b50dfdff0bd9745c6d6d326
+  metadata.gz: 44fda14faba568efd1d87a208e3764c4aeb3101549b72ffaf8d90f37d13601fcb236e21969e0f772d0d82ece0a9e7b025326c19fd76be0395b7c08f8c8663201
+  data.tar.gz: 91842b1780df095396c2a0d11321d3166eb59fdf582bbf26f0aa59ab9ab618d2a8bea8dc283c032b3f786821ccfb3cfad1c61a372f242a53d2e4f3ccf5ba44a6

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

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "set"
+
 
 module Google
   module Cloud
@@ -52,6 +54,11 @@ module Google
       #
       class AsyncWriter
         DEFAULT_MAX_QUEUE_SIZE = 10000
+        CLEANUP_TIMEOUT = 10.0
+        WAIT_INTERVAL = 1.0
+
+        @cleanup_list = nil
+        @exit_lock = Mutex.new
 
         ##
         # @private Item in the log entries queue.
@@ -308,7 +315,8 @@ module Google
         # Blocks until this asynchronous writer has been stopped, or the given
         # timeout (if present) has elapsed.
         #
-        # @param [Number] timeout Timeout in seconds, or nil for no timeout.
+        # @param [Number, nil] timeout Timeout in seconds, or `nil` for no
+        #     timeout.
         #
         # @return [Boolean] Returns true if the writer is stopped, or false
         #   if the timeout expired.
@@ -320,12 +328,37 @@ module Google
             until state == :stopped
               cur_time = ::Time.new.to_f
               return false if deadline && cur_time >= deadline
-              @lock_cond.wait(deadline ? deadline - cur_time : nil)
+              interval = deadline ? deadline - cur_time : WAIT_INTERVAL
+              interval = WAIT_INTERVAL if interval > WAIT_INTERVAL
+              @lock_cond.wait interval
             end
           end
           true
         end
 
+        ##
+        # Stop this asynchronous writer and block until it has been stopped.
+        #
+        # @param [Number] timeout Timeout in seconds.
+        # @param [Boolean] force If set to true, and the writer hasn't stopped
+        #     within the given timeout, kill it forcibly by terminating the
+        #     thread. This should be used with extreme caution, as it can
+        #     leave RPCs unfinished. Default is false.
+        #
+        # @return [Symbol] Returns `:stopped` if the AsyncWriter was already
+        #     stopped at the time of invocation, `:waited` if it stopped
+        #     during the timeout period, `:timeout` if it is still running
+        #     after the timeout, or `:forced` if it was forcibly killed.
+        #
+        def stop! timeout, force: false
+          return :stopped unless stop
+          return :waited if wait_until_stopped timeout
+          return :timeout unless force
+          @thread.kill
+          @thread.join
+          :forced
+        end
+
         protected
 
         ##
@@ -341,14 +374,18 @@ module Google
               @queue = []
               @lock = Monitor.new
               @lock_cond = @lock.new_cond
-              @thread = Thread.new { run_backgrounder }
+              AsyncWriter.register_for_cleanup self
+              @thread = Thread.new do
+                run_backgrounder
+                AsyncWriter.unregister_for_cleanup self
+              end
             end
           end
         end
 
         ##
         # @private The background thread implementation, which continuously
-        # waits for performs work, and returns only when fully stopped.
+        # waits for and performs work, and returns only when fully stopped.
         #
         def run_backgrounder
           loop do
@@ -367,14 +404,18 @@ module Google
               @last_exception = e
             end
           end
+        ensure
+          # If something drastic happened like the thread was killed, make
+          # sure the state is consistent.
+          @state = :stopped
         end
 
         ##
         # @private Wait for and dequeue the next set of log entries to transmit.
         #
-        # @return [QueueItem,NilClass] Returns the next set of entries. If
+        # @return [QueueItem, nil] Returns the next set of entries. If
         #   the writer has been stopped and no more entries are left in the
-        #   queue, returns nil.
+        #   queue, returns `nil`.
         #
         def wait_next_item
           @lock.synchronize do
@@ -382,14 +423,55 @@ module Google
                   (state == :running && @queue.empty?)
               @lock_cond.wait
             end
+            queue_item = nil
             if @queue.empty?
               @state = :stopped
-              nil
             else
               queue_item = @queue.shift
               @queue_size -= queue_item.entries.size
-              @lock_cond.broadcast
-              queue_item
+            end
+            @lock_cond.broadcast
+            queue_item
+          end
+        end
+
+        ##
+        # Register the given AsyncWriter for cleanup on VM exit.
+        #
+        # @private
+        #
+        def self.register_for_cleanup async
+          @exit_lock.synchronize do
+            unless @cleanup_list
+              @cleanup_list = ::Set.new
+              at_exit { AsyncWriter.run_cleanup }
+            end
+            @cleanup_list.add async
+          end
+        end
+
+        ##
+        # Unregister the given AsyncWriter for cleanup on VM exit.
+        #
+        # @private
+        #
+        def self.unregister_for_cleanup async
+          @exit_lock.synchronize do
+            @cleanup_list.delete async if @cleanup_list
+          end
+        end
+
+        ##
+        # Exit hook that cleans up any running AsyncWriters.
+        #
+        # @private
+        #
+        def self.run_cleanup
+          @exit_lock.synchronize do
+            if @cleanup_list
+              @cleanup_list.each do |async|
+                async.stop! CLEANUP_TIMEOUT, force: true
+              end
             end
           end
         end

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

@@ -21,7 +21,8 @@ module Google
       ##
       # # Logger
       #
-      # A (mostly) API-compatible logger for ruby's Logger.
+      # An API-compatible replacement for ruby's Logger that logs to the
+      # Stackdriver Logging Service.
       #
       # @example
       #   require "google/cloud/logging"
@@ -36,6 +37,18 @@ module Google
       #   logger.info "Job started."
       #
       class Logger
+        ##
+        # A RequestInfo represents data about the request being handled by the
+        # current thread. It is used to configure logs coming from that thread.
+        #
+        # The trace_id is a String that controls the trace ID sent with the log
+        # entry. If it is nil, no trace ID is sent.
+        #
+        # The log_name is a String that controls the name of the Stackdriver
+        # log to write to. If it is nil, the default log_name for this Logger
+        # is used.
+        RequestInfo = ::Struct.new :trace_id, :log_name
+
         ##
         # The Google Cloud writer object that calls to {#write_entries} are made
         # on. Either an AsyncWriter or Project object.
@@ -44,6 +57,7 @@ module Google
         ##
         # The Google Cloud log_name to write the log entry with.
         attr_reader :log_name
+        alias_method :progname, :log_name
 
         ##
         # The Google Cloud resource to write the log entry with.
@@ -53,11 +67,37 @@ module Google
         # The Google Cloud labels to write the log entry with.
         attr_reader :labels
 
+        ##
+        # The logging severity threshold (e.g. `Logger::INFO`)
+        attr_reader :level
+        alias_method :sev_threshold, :level
+
+        ##
+        # This logger does not use a formatter, but it provides a default
+        # Logger::Formatter for API compatibility with the standard Logger.
+        attr_accessor :formatter
+
+        ##
+        # This logger does not use a formatter, but it implements this
+        # attribute for API compatibility with the standard Logger.
+        attr_accessor :datetime_format
+
+        ##
+        # This logger treats progname as an alias for log_name.
+        def progname= name
+          @log_name = name
+        end
+
         ##
         # 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
+        #
+        # @deprecated Use request_info
+        #
+        def trace_ids
+          @request_info.inject({}) { |r, (k, v)| r[k] = v.trace_id }
+        end
 
         ##
         # Create a new Logger instance.
@@ -101,7 +141,11 @@ module Google
           @resource = resource
           @labels = labels
           @level = 0 # DEBUG is the default behavior
-          @trace_ids = OrderedHash.new
+          @request_info = OrderedHash.new
+          @closed = false
+          # Unused, but present for API compatibility
+          @formatter = ::Logger::Formatter.new
+          @datetime_format = ""
         end
 
         ##
@@ -240,10 +284,21 @@ module Google
             end
           end
 
-          write_entry severity, message
+          write_entry severity, message unless @closed
+          true
         end
         alias_method :log, :add
 
+        ##
+        # Logs the given message at UNKNOWN severity.
+        #
+        # @param [String] msg The log entry payload as a string.
+        #
+        def << msg
+          unknown msg
+          self
+        end
+
         ##
         # Returns `true` if the current severity level allows for sending
         # `DEBUG` messages.
@@ -306,29 +361,88 @@ module Google
         end
         alias_method :sev_threshold=, :level=
 
+        ##
+        # Close the logging "device". This effectively disables logging from
+        # this logger; any further log messages will be silently ignored. The
+        # logger may be re-enabled by calling #reopen.
+        #
+        def close
+          @closed = true
+          self
+        end
+
+        ##
+        # Re-enable logging if the logger has been closed.
+        #
+        # Note that this method accepts a "logdev" argument for compatibility
+        # with the standard Ruby Logger class; however, this argument is
+        # ignored because this logger does not use a log device.
+        #
+        def reopen _logdev = nil
+          @closed = false
+          self
+        end
+
         ##
         # 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
+        # @deprecated Use add_request_info
+        #
         def add_trace_id trace_id
-          trace_ids[current_thread_id] = trace_id
+          add_request_id trace_id: trace_id
+        end
+
+        ##
+        # Associate request data with the current Thread. You may provide
+        # either the individual pieces of data (trace ID, log name) or a
+        # populated RequestInfo object.
+        #
+        # @param [RequestInfo] info Info about the current request. Optional.
+        #     If not present, a new RequestInfo is created using the remaining
+        #     parameters.
+        # @param [String, nil] trace_id The trace ID, or `nil` if no trace ID
+        #     should be logged.
+        # @param [String, nil] log_name The log name to use, or nil to use
+        #     this logger's default.
+        #
+        def add_request_info info: nil,
+                             trace_id: nil,
+                             log_name: nil
+          info ||= RequestInfo.new trace_id, log_name
+          @request_info[current_thread_id] = info
 
           # 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
+          @request_info.shift while @request_info.size > 10_000
+
+          info
         end
 
         ##
-        # Untrack the trace_id that's associated with current Thread
+        # Get the request data for the current Thread
+        #
+        # @return [RequestInfo, nil] The request data for the current thread,
+        #     or `nil` if there is no data set.
         #
-        # @return [String] The trace_id that's being deleted
-        def delete_trace_id
-          trace_ids.delete current_thread_id
+        def request_info
+          @request_info[current_thread_id]
         end
 
+        ##
+        # Untrack the RequestInfo that's associated with current Thread
+        #
+        # @return [RequestInfo] The info that's being deleted
+        #
+        def delete_request_info
+          @request_info.delete current_thread_id
+        end
+
+        ##
+        # @deprecated Use delete_request_info
+        alias_method :delete_trace_id, :delete_request_info
+
         protected
 
         ##
@@ -340,12 +454,18 @@ module Google
             e.payload = message
           end
 
-          # merge input labels and trace_id
-          trace_id = trace_ids[current_thread_id]
-          merged_labels = trace_id.nil? ? {} : { traceId: trace_id }
+          # merge input labels and request info
+          merged_labels = {}
+          actual_log_name = log_name
+          info = request_info
+          if info
+            actual_log_name = info.log_name || actual_log_name
+            merged_labels["traceId"] = info.trace_id unless info.trace_id.nil?
+          end
           merged_labels = labels.merge(merged_labels) unless labels.nil?
 
-          writer.write_entries entry, log_name: log_name, resource: resource,
+          writer.write_entries entry, log_name: actual_log_name,
+                                      resource: resource,
                                       labels: merged_labels
         end
 

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

@@ -13,10 +13,17 @@
 # limitations under the License.
 
 
+require "stackdriver/core"
+
 module Google
   module Cloud
     module Logging
       class Middleware
+        ##
+        # A default value for the log_name_map argument. Directs health check
+        # logs to a separate log name so they don't spam the main log.
+        DEFAULT_LOG_NAME_MAP = { "/_ah/health" => "ruby_health_check_log" }
+
         ##
         # The Google::Cloud::Logging::Logger instance
         attr_reader :logger
@@ -29,13 +36,18 @@ module Google
         #   this middleware. The middleware will be interacting with the logger
         #   to track Stackdriver request trace ID. It also properly sets
         #   env["rack.logger"] to this assigned logger for accessing.
+        # @param [Hash] log_name_map A map from URI path to log name override.
+        #   The path may be a string or regex. If a request path matches an
+        #   entry in this map, the log name is set accordingly, otherwise the
+        #   logger's default log_name is used.
         #
         # @return [Google::Cloud::Logging::Middleware] A new
         #   Google::Cloud::Logging::Middleware instance
         #
-        def initialize app, logger: nil
+        def initialize app, logger: nil, log_name_map: DEFAULT_LOG_NAME_MAP
           @app = app
           @logger = logger
+          @log_name_map = log_name_map
         end
 
         ##
@@ -51,25 +63,44 @@ module Google
         #
         def call env
           env["rack.logger"] = logger
-          trace_id = extract_trace_id(env)
-          logger.add_trace_id trace_id
-
+          trace_id = get_trace_id env
+          log_name = get_log_name env
+          logger.add_request_info trace_id: trace_id, log_name: log_name
           begin
             @app.call env
           ensure
-            logger.delete_trace_id
+            logger.delete_request_info
           end
         end
 
         ##
-        # Extract the trace_id from HTTP request header
-        # HTTP_X_CLOUD_TRACE_CONTEXT.
-        #
-        # @return [String] The trace_id or nil if trace_id is empty.
-        def extract_trace_id env
-          trace_context = env["HTTP_X_CLOUD_TRACE_CONTEXT"].to_s
-          return nil if trace_context.empty?
-          trace_context.sub(%r{/.*}, "")
+        # Determine the trace ID for this request.
+        #
+        # @private
+        # @param [Hash] env The Rack environment.
+        # @return [String] The trace ID.
+        #
+        def get_trace_id env
+          trace_context = Stackdriver::Core::TraceContext.parse_rack_env env
+          trace_context.trace_id
+        end
+
+        ##
+        # Determine the log name override for this request, if any.
+        #
+        # @private
+        # @param [Hash] env The Rack environment.
+        # @return [String, nil] The log name override, or `nil` if there is
+        #     no override.
+        #
+        def get_log_name env
+          return nil unless @log_name_map
+          path = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+          path = "/#{path}" unless path.start_with? "/"
+          @log_name_map.each do |k, v|
+            return v if k === path
+          end
+          nil
         end
 
         ##
@@ -136,25 +167,29 @@ module Google
         # the correct monitoring resource types and labels.
         #
         # @example If running from GAE, returns default resource:
-        #   rc = Google::Cloud::Logging::Middleware.build_monitored_resource
+        #   rc = Google::Cloud::Logging::Middleware.send \
+        #          :default_monitored_resource
         #   rc.type   #=> "gae_app"
         #   rc.labels # { module_id: [GAE module name],
         #             #   version_id: [GAE module version] }
         #
         # @example If running from GKE, returns default resource:
-        #   rc = Google::Cloud::Logging::Middleware.build_monitored_resource
+        #   rc = Google::Cloud::Logging::Middleware.send \
+        #          :default_monitored_resource
         #   rc.type   #=> "container"
         #   rc.labels # { cluster_name: [GKE cluster name],
         #             #   namespace_id: [GKE namespace_id] }
         #
         # @example If running from GCE, return default resource:
-        #   rc = Google::Cloud::Logging::Middleware.build_monitored_resource
+        #   rc = Google::Cloud::Logging::Middleware.send \
+        #          :default_monitored_resource
         #   rc.type   #=> "gce_instance"
         #   rc.labels # { instance_id: [GCE VM instance id],
         #             #   zone: [GCE vm group zone] }
         #
         # @example Otherwise default to generic "global" type:
-        #   rc = Google::Cloud::Logging::Middleware.build_monitored_resource
+        #   rc = Google::Cloud::Logging::Middleware.send \
+        #          :default_monitored_resource
         #   rc.type   #=> "global"
         #   rc.labels #=> {}
         #

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

@@ -103,23 +103,23 @@ module Google
           begin
             Google::Cloud::Logging::Credentials.credentials_with_scope keyfile
           rescue Exception => e
-            warn "Unable to initialize Google::Cloud::Logging due " \
-              "to authorization error: #{e.message}"
+            warn "Google::Cloud::Logging is not activated due to " \
+              "authorization error: #{e.message}\nFalling back to default " \
+              "logger"
             return false
           end
 
           project_id = gcp_config.logging.project_id || gcp_config.project_id ||
                        Google::Cloud::Logging::Project.default_project
           if project_id.to_s.empty?
-            warn "Unable to initialize Google::Cloud::Logging with empty " \
-              "project_id"
+            warn "Google::Cloud::Logging is not activated due to empty " \
+              "project_id; falling back to default logger"
             return false
           end
 
           # Otherwise default to true if Rails is running in production or
-          # config.stackdriver.use_logging is explicitly true
-          Rails.env.production? ||
-            (gcp_config.key?(:use_logging) && gcp_config.use_logging)
+          # config.stackdriver.use_logging is true
+          Rails.env.production? || gcp_config.use_logging
         end
       end
     end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Logging
-      VERSION = "0.23.0"
+      VERSION = "0.23.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.21.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.21.1
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: stackdriver-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -325,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: API Client library for Stackdriver Logging