google-cloud-logging 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ed947d4ac0a7d053284364df99d1d27eb2dd013
-  data.tar.gz: 66c8792bbad62413185d1abfedb3e3e9692def55
+  metadata.gz: 4c12b20d76a762cc4d57a454cc8464d4e301f31a
+  data.tar.gz: 36cda33c662c40a95bafff6068adaad0b7c1df71
 SHA512:
-  metadata.gz: e49e794f719c33b0c7d5473610152544e0b17519da2bc04bf7543a6c973c931d56c336a5b9fee74bec6781f123ba5b72ee6be23ac2f78abbdea5e5fdefe1dfd7
-  data.tar.gz: a63f6b59880746e4898a9e5dd32b72dbbd866be2dcf0801fff66e9a151d7fe3b3c7d4edbc37b01ea634939bd34b07c6cadd7abb2648a11cf2f4eaf4a255829b1
+  metadata.gz: 1bb3bbec95098e11bb58fe87c41edbb93f8b8fb36dadfbe627434fdf7540e4f1dab64d79215d6da4e97b280fc15ac923cc686e53b3a3c6f7aba0f5a657095148
+  data.tar.gz: '059dfed7ab14d14903c65824489e968b001947e7b13be4671aa69b9719ab3c7e701c10d7cce1bed08c20c8b787d93af102c1eb583174c92ea8654b47b828155f'

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

@@ -19,6 +19,11 @@ module Google
   module Cloud
     module Logging
       class Middleware
+        ##
+        # The default log name used to instantiate the default logger if one
+        # isn't provided.
+        DEFAULT_LOG_NAME = "ruby_app_log"
+
         ##
         # 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.
@@ -35,7 +40,16 @@ module Google
         # @param [Google::Cloud::Logging::Logger] logger A logger to be used by
         #   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.
+        #   env["rack.logger"] to this assigned logger for accessing. If not
+        #   specified, a default logger with be used.
+        # @param [String] project_id Project identifier for the Stackdriver
+        #   Logging service. Used to create a default logger if one isn't
+        #   specified and a service account is used for authentication.
+        #   Optional.
+        # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
+        #   file path the file must be readable. Used to create a default logger
+        #   if one isn't specified and a service account is used for
+        #   authentication. Optional.
         # @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
@@ -44,9 +58,17 @@ module Google
         # @return [Google::Cloud::Logging::Middleware] A new
         #   Google::Cloud::Logging::Middleware instance
         #
-        def initialize app, logger: nil, log_name_map: DEFAULT_LOG_NAME_MAP
+        def initialize app, logger: nil, project_id: nil, keyfile: nil,
+                       log_name_map: DEFAULT_LOG_NAME_MAP
           @app = app
-          @logger = logger
+          if logger
+            @logger = logger
+          else
+            logging = Google::Cloud::Logging.new project: project_id,
+                                                 keyfile: keyfile
+            resource = Middleware.build_monitored_resource
+            @logger = logging.logger DEFAULT_LOG_NAME, resource
+          end
           @log_name_map = log_name_map
         end
 

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

@@ -19,7 +19,7 @@ module Google
     module Logging
       ##
       # Default log name to be used for Stackdriver Logging
-      DEFAULT_LOG_NAME = "ruby_app_log"
+      DEFAULT_LOG_NAME = Middleware::DEFAULT_LOG_NAME
 
       ##
       # Railtie
@@ -65,20 +65,19 @@ module Google
 
         initializer "Stackdriver.Logging", before: :initialize_logger do |app|
           if self.class.use_logging? app.config
-            gcp_config = app.config.google_cloud
-            log_config = gcp_config.logging
+            logging_config = Railtie.parse_rails_config config
 
-            project_id = log_config.project_id || gcp_config.project_id
-            keyfile = log_config.keyfile || gcp_config.keyfile
-            resource_type = log_config.monitored_resource.type
-            resource_labels = log_config.monitored_resource.labels
+            project_id = logging_config[:project_id]
+            keyfile = logging_config[:keyfile]
+            resource_type = logging_config[:resource_type]
+            resource_labels = logging_config[:resource_labels]
+            log_name = logging_config[:log_name]
 
             logging = Google::Cloud::Logging.new project: project_id,
                                                  keyfile: keyfile
             resource =
               Logging::Middleware.build_monitored_resource resource_type,
                                                            resource_labels
-            log_name = log_config.log_name || DEFAULT_LOG_NAME
 
             app.config.logger = logging.logger log_name, resource
             app.middleware.insert_before Rails::Rack::Logger,
@@ -109,34 +108,54 @@ module Google
         # @return [Boolean] Whether to use Stackdriver Logging
         #
         def self.use_logging? config
-          gcp_config = config.google_cloud
+          logging_config = Railtie.parse_rails_config config
+
           # Return false if config.google_cloud.use_logging is explicitly false
-          return false if gcp_config.key?(:use_logging) &&
-                          !gcp_config.use_logging
+          use_logging = logging_config[:use_logging]
+          return false if use_logging == false
+
+          project_id = logging_config[:project_id] ||
+                       Google::Cloud::Logging::Project.default_project
+          keyfile = logging_config[:keyfile]
 
           # Try authenticate authorize client API. Return false if unable to
           # authorize.
-          keyfile = gcp_config.logging.keyfile || gcp_config.keyfile
           begin
             Google::Cloud::Logging::Credentials.credentials_with_scope keyfile
           rescue Exception => e
-            warn "Google::Cloud::Logging is not activated due to " \
-              "authorization error: #{e.message}\nFalling back to default " \
-              "logger"
+            STDOUT.puts "Note: Google::Cloud::Logging is disabled because " \
+              "it failed to authorize with the service. (#{e.message}) " \
+              "Falling back to the default Rails 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 "Google::Cloud::Logging is not activated due to empty " \
-              "project_id; falling back to default logger"
+            STDOUT.puts "Note: Google::Cloud::Logging is disabled because " \
+              "the project ID could not be determined. " \
+              "Falling back to the default Rails logger."
             return false
           end
 
           # Otherwise default to true if Rails is running in production or
           # config.google_cloud.use_logging is true
-          Rails.env.production? || gcp_config.use_logging
+          Rails.env.production? || use_logging
+        end
+
+        ##
+        # @private Helper method to parse rails config into a flattened hash
+        def self.parse_rails_config config
+          gcp_config = config.google_cloud
+          logging_config = gcp_config.logging
+          use_logging =
+            gcp_config.key?(:use_logging) ? gcp_config.use_logging : nil
+          {
+            project_id: logging_config.project_id || gcp_config.project_id,
+            keyfile: logging_config.keyfile || gcp_config.keyfile,
+            resource_type: logging_config.monitored_resource.type,
+            resource_labels: logging_config.monitored_resource.labels,
+            log_name: logging_config.log_name || Middleware::DEFAULT_LOG_NAME,
+            use_logging: use_logging
+          }
         end
       end
     end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Logging
-      VERSION = "1.0.0"
+      VERSION = "1.0.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core