google-cloud-logging 1.5.7 → 1.6.0

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

@@ -30,8 +30,12 @@ module Google
       # {Google::Cloud::Logging::Logger} instance to be used by the Rails
       # application.
       #
-      # The Middleware is only added when certain conditions are met. See
-      # {use_logging?} for details.
+      # The middleware is loaded only when certain conditions are met. These
+      # conditions are when the configuration
+      # `Google::Cloud.configure.use_logging` (also available as
+      # `Rails.application.config.google_cloud.use_logging` for a Rails
+      # application) is set to `true`, or, if the configuration is left unset
+      # but `Rails.env.production?` is `true`.
       #
       # When loaded, the {Google::Cloud::Logging::Middleware} will be inserted
       # before the `Rails::Rack::Logger Middleware`, which allows it to set the
@@ -66,16 +70,59 @@ module Google
           log_name = Logging.configure.log_name
           labels = Logging.configure.labels
 
-          logging = Google::Cloud::Logging.new project_id: project_id,
+          logging = Google::Cloud::Logging.new project_id:  project_id,
                                                credentials: credentials
           resource =
             Logging::Middleware.build_monitored_resource resource_type,
                                                          resource_labels
 
-          app.config.logger = logging.logger log_name, resource, labels
+          Middleware.logger = logging.logger log_name, resource, labels
+          # Set the default Rails logger
+          if Logging.configure.set_default_logger_on_rails_init
+            set_default_logger
+          end
+          init_callback = -> { set_default_logger }
           app.middleware.insert_before Rails::Rack::Logger,
                                        Google::Cloud::Logging::Middleware,
-                                       logger: app.config.logger
+                                       logger:  Middleware.logger,
+                                       on_init: init_callback
+        end
+
+        ##
+        # This should be called once the application determines that it is safe
+        # to start background threads and open gRPC connections. It informs the
+        # middleware system that it is safe to use Google Cloud Logging. This is
+        # called during Rails initialization when the
+        # `set_default_logger_on_rails_init` configuration is set.
+        #
+        # Generally, this matters if the application forks worker processes;
+        # this method should be called only after workers are forked, since
+        # threads and network connections interact badly with fork. For example,
+        # when running Puma in [clustered
+        # mode](https://github.com/puma/puma#clustered-mode), this method should
+        # be called in an `on_worker_boot` block.
+        #
+        # If the application does no forking, this method can be called any time
+        # early in the application initialization process. Or by setting the
+        # `set_default_logger_on_rails_init` configuration.
+        #
+        # If the `set_default_logger_on_rails_init` configuration is not set,
+        # and {Railtie.set_default_logger} is not called in a post-fork hook,
+        # the default Rails logger object will not be set to use the Google
+        # Cloud Logging Logger object. For best results, an application should
+        # call this method at the appropriate time, such as a post-fork hook.
+        #
+        def self.set_default_logger
+          return if Middleware.logger.nil?
+          return if Rails.logger.is_a? Google::Cloud::Logging::Logger
+
+          # configure the Middleware logger to use the same settings as Rails
+          Middleware.logger.level = Rails.logger.level
+          # TODO: are there more settings to be set here?
+
+          # Replace the Rails default logger
+          Rails.application.config.logger = Middleware.logger
+          Rails.logger = Middleware.logger
         end
 
         ##
@@ -132,6 +179,10 @@ module Google
               log_config.monitored_resource.type
             config.monitored_resource.labels ||=
               log_config.monitored_resource.labels.to_h
+            if config.set_default_logger_on_rails_init.nil?
+              config.set_default_logger_on_rails_init = \
+                log_config.set_default_logger_on_rails_init
+            end
           end
         end
 

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

@@ -65,7 +65,7 @@ module Google
         def to_grpc
           return nil if empty?
           Google::Api::MonitoredResource.new(
-            type: type,
+            type:   type,
             labels: Hash[labels.map { |k, v| [String(k), String(v)] }]
           )
         end

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

@@ -40,11 +40,11 @@ module Google
           return mocked_logging if mocked_logging
           @logging ||= \
             V2::LoggingServiceV2Client.new(
-              credentials: credentials,
-              timeout: timeout,
+              credentials:   credentials,
+              timeout:       timeout,
               client_config: client_config,
-              lib_name: "gccl",
-              lib_version: Google::Cloud::Logging::VERSION
+              lib_name:      "gccl",
+              lib_version:   Google::Cloud::Logging::VERSION
             )
         end
         attr_accessor :mocked_logging
@@ -53,11 +53,11 @@ module Google
           return mocked_sinks if mocked_sinks
           @sinks ||= \
             V2::ConfigServiceV2Client.new(
-              credentials: credentials,
-              timeout: timeout,
+              credentials:   credentials,
+              timeout:       timeout,
               client_config: client_config,
-              lib_name: "gccl",
-              lib_version: Google::Cloud::Logging::VERSION
+              lib_name:      "gccl",
+              lib_version:   Google::Cloud::Logging::VERSION
             )
         end
         attr_accessor :mocked_sinks
@@ -66,11 +66,11 @@ module Google
           return mocked_metrics if mocked_metrics
           @metrics ||= \
             V2::MetricsServiceV2Client.new(
-              credentials: credentials,
-              timeout: timeout,
+              credentials:   credentials,
+              timeout:       timeout,
               client_config: client_config,
-              lib_name: "gccl",
-              lib_version: Google::Cloud::Logging::VERSION
+              lib_name:      "gccl",
+              lib_version:   Google::Cloud::Logging::VERSION
             )
         end
         attr_accessor :mocked_metrics
@@ -83,8 +83,10 @@ module Google
           resource_names = ["projects/#{@project}"] if resource_names.empty?
           call_opts = default_options
           if token
-            call_opts = Google::Gax::CallOptions.new(kwargs: default_headers,
-                                                     page_token: token)
+            call_opts = Google::Gax::CallOptions.new(
+              kwargs:     default_headers,
+              page_token: token
+            )
           end
 
           execute do
@@ -117,13 +119,15 @@ module Google
           parent = resource || "projects/#{@project}"
           call_opts = default_options
           if token
-            call_opts = Google::Gax::CallOptions.new(kwargs: default_headers,
-                                                     page_token: token)
+            call_opts = Google::Gax::CallOptions.new(
+              kwargs:     default_headers,
+              page_token: token
+            )
           end
 
           execute do
             paged_enum = logging.list_logs parent, page_size: max,
-                                                   options: call_opts
+                                                   options:   call_opts
             paged_enum.page.response
           end
         end
@@ -137,8 +141,10 @@ module Google
         def list_resource_descriptors token: nil, max: nil
           call_opts = default_options
           if token
-            call_opts = Google::Gax::CallOptions.new(kwargs: default_headers,
-                                                     page_token: token)
+            call_opts = Google::Gax::CallOptions.new(
+              kwargs:     default_headers,
+              page_token: token
+            )
           end
 
           execute do
@@ -150,8 +156,10 @@ module Google
         def list_sinks token: nil, max: nil
           call_opts = default_options
           if token
-            call_opts = Google::Gax::CallOptions.new(kwargs: default_headers,
-                                                     page_token: token)
+            call_opts = Google::Gax::CallOptions.new(
+              kwargs:     default_headers,
+              page_token: token
+            )
           end
 
           execute do
@@ -169,7 +177,7 @@ module Google
           execute do
             sinks.create_sink project_path, sink,
                               unique_writer_identity: unique_writer_identity,
-                              options: default_options
+                              options:                default_options
           end
         end
 
@@ -187,7 +195,7 @@ module Google
           execute do
             sinks.update_sink sink_path(name), sink,
                               unique_writer_identity: unique_writer_identity,
-                              options: default_options
+                              options:                default_options
           end
         end
 
@@ -200,8 +208,10 @@ module Google
         def list_metrics token: nil, max: nil
           call_opts = default_options
           if token
-            call_opts = Google::Gax::CallOptions.new(kwargs: default_headers,
-                                                     page_token: token)
+            call_opts = Google::Gax::CallOptions.new(
+              kwargs:     default_headers,
+              page_token: token
+            )
           end
 
           execute do
@@ -248,6 +258,13 @@ module Google
           end
         end
 
+        def log_path log_name
+          return nil if log_name.nil?
+          return log_name if log_name.empty?
+          return log_name if log_name.to_s.include? "/"
+          "#{project_path}/logs/#{log_name}"
+        end
+
         def inspect
           "#{self.class}(#{@project})"
         end
@@ -258,13 +275,6 @@ module Google
           "projects/#{@project}"
         end
 
-        def log_path log_name
-          return nil if log_name.nil?
-          return log_name if log_name.empty?
-          return log_name if log_name.to_s.include? "/"
-          "#{project_path}/logs/#{log_name}"
-        end
-
         def sink_path sink_name
           return sink_name if sink_name.to_s.include? "/"
           "#{project_path}/sinks/#{sink_name}"

data/lib/google/cloud/logging/v2/config_service_v2_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/api/distribution.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -78,15 +78,6 @@ module Google
     #   @return [Array<Google::Api::Distribution::Exemplar>]
     #     Must be in increasing order of `value` field.
     class Distribution
-      # The range of the population values.
-      # @!attribute [rw] min
-      #   @return [Float]
-      #     The minimum of the population values.
-      # @!attribute [rw] max
-      #   @return [Float]
-      #     The maximum of the population values.
-      class Range; end
-
       # `BucketOptions` describes the bucket boundaries used to create a histogram
       # for the distribution. The buckets can be in a linear sequence, an
       # exponential sequence, or each bucket can be specified explicitly.
@@ -168,33 +159,6 @@ module Google
         #     The values must be monotonically increasing.
         class Explicit; end
       end
-
-      # Exemplars are example points that may be used to annotate aggregated
-      # distribution values. They are metadata that gives information about a
-      # particular value added to a Distribution bucket, such as a trace ID that
-      # was active when a value was added. They may contain further information,
-      # such as a example values and timestamps, origin, etc.
-      # @!attribute [rw] value
-      #   @return [Float]
-      #     Value of the exemplar point. This value determines to which bucket the
-      #     exemplar belongs.
-      # @!attribute [rw] timestamp
-      #   @return [Google::Protobuf::Timestamp]
-      #     The observation (sampling) time of the above value.
-      # @!attribute [rw] attachments
-      #   @return [Array<Google::Protobuf::Any>]
-      #     Contextual information about the example value. Examples are:
-      #
-      #       Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
-      #
-      #       Literal string: type.googleapis.com/google.protobuf.StringValue
-      #
-      #       Labels dropped during aggregation:
-      #         type.googleapis.com/google.monitoring.v3.DroppedLabels
-      #
-      #     There may be only a single attachment of any given message type in a
-      #     single exemplar, and this is enforced by the system.
-      class Exemplar; end
     end
   end
 end

data/lib/google/cloud/logging/v2/doc/google/api/label.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/api/metric.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -189,17 +189,5 @@ module Google
         MONEY = 6
       end
     end
-
-    # A specific metric, identified by specifying values for all of the
-    # labels of a {Google::Api::MetricDescriptor `MetricDescriptor`}.
-    # @!attribute [rw] type
-    #   @return [String]
-    #     An existing metric type, see {Google::Api::MetricDescriptor}.
-    #     For example, `custom.googleapis.com/invoice/paid/amount`.
-    # @!attribute [rw] labels
-    #   @return [Hash{String => String}]
-    #     The set of label values that uniquely identify this metric. All
-    #     labels listed in the `MetricDescriptor` must be assigned values.
-    class Metric; end
   end
 end

data/lib/google/cloud/logging/v2/doc/google/api/monitored_resource.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/logging/type/http_request.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -112,17 +112,6 @@ module Google
       # empty
       class WriteLogEntriesResponse; end
 
-      # Error details for WriteLogEntries with partial success.
-      # @!attribute [rw] log_entry_errors
-      #   @return [Hash{Integer => Google::Rpc::Status}]
-      #     When `WriteLogEntriesRequest.partial_success` is true, records the error
-      #     status for entries that were not written due to a permanent error, keyed
-      #     by the entry's zero-based index in `WriteLogEntriesRequest.entries`.
-      #
-      #     Failed requests for which no entries are written will not include
-      #     per-entry errors.
-      class WriteLogEntriesPartialErrors; end
-
       # The parameters to `ListLogEntries`.
       # @!attribute [rw] project_ids
       #   @return [Array<String>]

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/protobuf/any.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/protobuf/duration.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/protobuf/empty.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/protobuf/field_mask.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/logging/v2/doc/google/protobuf/struct.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.