google-cloud-logging 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d899de8995824e5d52fb7ffba65090f37d604a54a3d136626477d46d768692c
-  data.tar.gz: 709f297752a5d4c0fca09f13c4c6164eb7b621b59813603d901cd1616d93bbbb
+  metadata.gz: f630302c8714555f32d66a9a19a5da340c6bbd840b1a1ed9c7da1798b42254df
+  data.tar.gz: d0fb2056868a23c282082339be24ddd1aeca4c4ff9cc4659b1fd3091b5364596
 SHA512:
-  metadata.gz: c4306cec1afeb1628d201bc1a109f9bd6f00296dceac7402e4c157347ae0b48ff5d0bd9beacc6961a2b3a7060d20025036ddeb1926b834780330d30e32788d51
-  data.tar.gz: e1117dfeede218f6954a0ab15e0d0e50a08cab0cfee4b7c90c41060fcfe531957255649527335dd813220fe16a0c881cdb5239ea798b5dcf39a6b6df00de9390
+  metadata.gz: 484774d516102279b6197436dc1daee472eabd055d24f0d9e4a7460144aec2255cce2ad33bfa176b76713f5e252e72aa05014da53952587c15de9fc7e01688c0
+  data.tar.gz: 051e5a2e070aa2a2fbef148971fbf1d5e02d05c211720442682775591254803548a31745b359aee8a48be2eb4bd5a2d86671b6dc9ed150070fa550958e7181f3

data/README.md

@@ -28,7 +28,7 @@ gem "google-cloud-logging"
 $ bundle install
 ```
 
-Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes 
+Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes
 the `google-cloud-logging` gem.
 
 ## Logging using client library
@@ -61,13 +61,13 @@ logging.write_entries entry
 
 ## Using Stackdriver Logging in frameworks
 
-The `google-cloud-logging` library provides framework integration for popular 
-Rack-based frameworks, such as Ruby on Rails and Sinatra, which sets the default 
+The `google-cloud-logging` library provides framework integration for popular
+Rack-based frameworks, such as Ruby on Rails and Sinatra, which sets the default
 Rack logger to an instance of the Stackdriver Logging logger.
 
 ### With Ruby on Rails
 
-You can load the Railtie that comes with the library into your Ruby 
+You can load the Railtie that comes with the library into your Ruby
 on Rails application by explicitly requiring it during the application startup:
 
 ```ruby
@@ -75,7 +75,7 @@ on Rails application by explicitly requiring it during the application startup:
 require "google/cloud/logging/rails"
 ```
 
-If you're using the `stackdriver` gem, it automatically loads the Railtie into 
+If you're using the `stackdriver` gem, it automatically loads the Railtie into
 your application when it starts.
 
 You'll be able to use Stackdriver logger through the standard Rails logger:
@@ -88,7 +88,7 @@ logger.warn "Hola Mundo"
 
 ### With other Rack-based frameworks
 
-Other Rack-based applications can use the Rack Middleware to replace the Rack 
+Other Rack-based applications can use the Rack Middleware to replace the Rack
 logger with the Stackdriver Logging logger:
 
 ```ruby
@@ -96,8 +96,8 @@ require "google/cloud/logging"
 use Google::Cloud::Logging::Middleware
 ```
 
-Once the Rack logger is set, some Rack-based frameworks, such as Ruby on Rails 
-and Sinatra, automatically initialize the default application logger to use the 
+Once the Rack logger is set, some Rack-based frameworks, such as Ruby on Rails
+and Sinatra, automatically initialize the default application logger to use the
 Rack logger:
 
 ```ruby
@@ -106,26 +106,26 @@ logger.warn "Hola Mundo"
 logger.error "Bonjour Monde"
 ```
 
-For other frameworks, consult the documentations on how to utilize the Rack 
+For other frameworks, consult the documentations on how to utilize the Rack
 logger.
 
 ### Configuring the framework integration
 
-You can customize the behavior of the Stackdriver Logging framework integration 
-for Ruby. See the [configuration guide](../stackdriver/configuration.md) for a 
+You can customize the behavior of the Stackdriver Logging framework integration
+for Ruby. See the [configuration guide](../stackdriver/configuration.md) for a
 list of possible configuration options.
 
 ## Authentication
 
-This library uses Service Account credentials to connect to Google Cloud 
-services. When running on Compute Engine the credentials will be discovered 
-automatically. When running on other environments the Service Account 
+This library uses Service Account credentials to connect to Google Cloud
+services. When running on Compute Engine the credentials will be discovered
+automatically. When running on other environments the Service Account
 credentials can be specified by providing in several ways.
 
-If you're using Ruby on Rails and the library's Rails integration feature, you 
-can provide the authentication parameters through the Rails configuration 
+If you're using Ruby on Rails and the library's Rails integration feature, you
+can provide the authentication parameters through the Rails configuration
 interface:
- 
+
 ```ruby
 # Add this to config/environments/*.rb
 Rails.application.configure do |config|
@@ -137,7 +137,7 @@ Rails.application.configure do |config|
   config.google_cloud.logging.keyfile    = "/path/to/key.json"
 end
 ```
-Other Rack-based applications that are loading the Rack Middleware directly can 
+Other Rack-based applications that are loading the Rack Middleware directly can
 use the configration interface:
 
 ```ruby
@@ -152,7 +152,7 @@ Google::Cloud.configure do |config|
 end
 ```
 
-See the [Authentication 
+See the [Authentication
 Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
 for more ways to authenticate the client library.
 

data/lib/google-cloud-logging.rb

@@ -20,6 +20,8 @@
 
 gem "google-cloud-core"
 require "google/cloud"
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -38,6 +40,7 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/logging.admin`
+    #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
     # @param [Hash] client_config A hash of values to override the default
     #   behavior of the API client. Optional.
@@ -89,6 +92,7 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/logging.admin`
+    #
     # @param [Integer] timeout Default timeout to use in requests. Optional.
     # @param [Hash] client_config A hash of values to override the default
     #   behavior of the API client. Optional.
@@ -115,3 +119,40 @@ module Google
     end
   end
 end
+
+# Add logging to top-level configuration
+Google::Cloud.configure do |config|
+  unless config.field? :use_logging
+    config.add_field! :use_logging, nil, enum: [true, false]
+  end
+end
+
+# Set the default logging configuration
+Google::Cloud.configure.add_config! :logging do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["LOGGING_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "LOGGING_CREDENTIALS", "LOGGING_CREDENTIALS_JSON",
+      "LOGGING_KEYFILE", "LOGGING_KEYFILE_JSON"
+    )
+  end
+
+  config.add_field! :project_id, default_project, match: String, allow_nil: true
+  config.add_alias! :project, :project_id
+  config.add_field! :credentials, default_creds,
+                    match: [String, Hash, Google::Auth::Credentials],
+                    allow_nil: true
+  config.add_alias! :keyfile, :credentials
+  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :timeout, nil, match: Integer
+  config.add_field! :client_config, nil, match: Hash
+  config.add_field! :log_name, nil, match: String
+  config.add_field! :log_name_map, nil, match: Hash
+  config.add_field! :labels, nil, match: Hash
+  config.add_config! :monitored_resource do |mrconfig|
+    mrconfig.add_field! :type, nil, match: String
+    mrconfig.add_field! :labels, nil, match: Hash
+  end
+end

data/lib/google/cloud/logging.rb

@@ -15,6 +15,8 @@
 
 require "google-cloud-logging"
 require "google/cloud/logging/project"
+require "google/cloud/config"
+require "google/cloud/env"
 require "stackdriver/core"
 
 module Google
@@ -38,11 +40,12 @@ module Google
     # Logging Documentation](https://cloud.google.com/logging/docs/).
     #
     # The goal of google-cloud is to provide an API that is comfortable to
-    # Rubyists. Authentication is handled by {Google::Cloud#logging}. You can
-    # provide the project and credential information to connect to the
-    # Stackdriver Logging service, or if you are running on Google Compute
-    # Engine this configuration is taken care of for you. You can read more
-    # about the options for connecting in the [Authentication
+    # Rubyists. Your authentication credentials are detected automatically in
+    # Google Cloud Platform environments such as Google Compute Engine, Google
+    # App Engine and Google Kubernetes Engine. In other environments you can
+    # configure authentication easily, either directly in your code or via
+    # environment variables. Read more about the options for connecting in the
+    # [Authentication
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
     # If you just want to write your application's logs to the Stackdriver
@@ -347,12 +350,6 @@ module Google
     # ```
     #
     module Logging
-      # Initialize :error_reporting as a nested Configuration under
-      # Google::Cloud if haven't already
-      unless Google::Cloud.configure.option? :logging
-        Google::Cloud.configure.add_options logging: :monitored_resource
-      end
-
       ##
       # Creates a new object for connecting to the Stackdriver Logging service.
       # Each call creates a new connection.
@@ -375,6 +372,7 @@ module Google
       #   The default scope is:
       #
       #   * `https://www.googleapis.com/auth/logging.admin`
+      #
       # @param [Integer] timeout Default timeout to use in requests. Optional.
       # @param [Hash] client_config A hash of values to override the default
       #   behavior of the API client. Optional.
@@ -396,11 +394,15 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || Logging::Project.default_project_id)
+        project_id ||= (project || default_project_id)
         project_id = project_id.to_s # Always cast to a string
-        fail ArgumentError, "project_id is missing" if project_id.empty?
+        raise ArgumentError, "project_id is missing" if project_id.empty?
+
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        client_config ||= configure.client_config
 
-        credentials ||= (keyfile || Logging::Credentials.default(scope: scope))
+        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Logging::Credentials.new credentials, scope: scope
         end
@@ -408,18 +410,49 @@ module Google
         Logging::Project.new(
           Logging::Service.new(
             project_id, credentials, timeout: timeout,
-                                     client_config: client_config))
+                                     client_config: client_config
+          )
+        )
       end
 
       ##
       # Configure the Google::Cloud::Logging::Middleware when used in a
       # Rack-based application.
       #
+      # The following Stackdriver Logging configuration parameters are
+      # supported:
+      #
+      # * `project_id` - (String) Project identifier for the Stackdriver
+      #   Logging service you are connecting to. (The parameter `project` is
+      #   considered deprecated, but may also be used.)
+      # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Logging::Credentials}) (The
+      #   parameter `keyfile` is considered deprecated, but may also be used.)
+      # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
+      #   the set of resources and operations that the connection can access.
+      # * `timeout` - (Integer) Default timeout to use in requests.
+      # * `client_config` - (Hash) A hash of values to override the default
+      #   behavior of the API client.
+      # * `log_name` - (String) Name of the application log file. Default:
+      #   `"ruby_app_log"`
+      # * `log_name_map` - (Hash) Map specific request routes to other log.
+      #   Default: `{ "/_ah/health" => "ruby_health_check_log" }`
+      # * `monitored_resource.type` (String) Resource type name. See [full
+      #   list](https://cloud.google.com/logging/docs/api/v2/resource-list).
+      #   Self discovered on GCP.
+      # * `monitored_resource.labels` -(Hash) Resource labels. See [full
+      #   list](https://cloud.google.com/logging/docs/api/v2/resource-list).
+      #   Self discovered on GCP.
+      # * `labels` - (Hash) User defined labels. A `Hash` of label names to
+      #   string label values or callables/`Proc` which are functions of the
+      #   Rack environment.
+      #
       # See the [Configuration
       # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
       # for full configuration parameters.
       #
-      # @return [Stackdriver::Core::Configuration] The configuration object
+      # @return [Google::Cloud::Config] The configuration object
       #   the Google::Cloud::Logging module uses.
       #
       def self.configure
@@ -427,6 +460,22 @@ module Google
 
         Google::Cloud.configure.logging
       end
+
+      ##
+      # @private Default project.
+      def self.default_project_id
+        Google::Cloud.configure.logging.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
+      ##
+      # @private Default credentials.
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.logging.credentials ||
+          Google::Cloud.configure.credentials ||
+          Logging::Credentials.default(scope: scope)
+      end
     end
   end
 end

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

@@ -87,7 +87,7 @@ module Google
         # The current state. Either :running, :suspended, :stopping, or :stopped
         #
         # DEPRECATED. Use #async_state instead.
-        alias_method :state, :async_state
+        alias state async_state
 
         ##
         # The last exception thrown by the background thread, or nil if nothing
@@ -152,7 +152,7 @@ module Google
           ensure_thread
           entries = Array(entries)
           synchronize do
-            fail "AsyncWriter has been stopped" unless writable?
+            raise "AsyncWriter has been stopped" unless writable?
             queue_item = QueueItem.new entries, log_name, resource, labels
             if @queue.empty? || !@queue.last.try_combine(queue_item)
               @queue.push queue_item
@@ -213,7 +213,7 @@ module Google
         # @return [Boolean] Returns true if the writer was running, or false
         #   if the writer had already been stopped.
         #
-        alias_method :stop, :async_stop
+        alias stop async_stop
 
         ##
         # Suspends this asynchronous writer.
@@ -226,7 +226,7 @@ module Google
         # @return [Boolean] Returns true if the writer had been running and was
         #   suspended, otherwise false.
         #
-        alias_method :suspend, :async_suspend
+        alias suspend async_suspend
 
         ##
         # Resumes this suspended asynchronous writer.
@@ -239,7 +239,7 @@ module Google
         # @return [Boolean] Returns true if the writer had been suspended and
         #   is now running, otherwise false.
         #
-        alias_method :resume, :async_resume
+        alias resume async_resume
 
         ##
         # Returns true if this writer is running.
@@ -248,7 +248,7 @@ module Google
         #
         # @return [Boolean] Returns true if the writer is currently running.
         #
-        alias_method :running?, :async_running?
+        alias running? async_running?
 
         ##
         # Returns true if this writer is suspended.
@@ -257,7 +257,7 @@ module Google
         #
         # @return [Boolean] Returns true if the writer is currently suspended.
         #
-        alias_method :suspended?, :async_suspended?
+        alias suspended? async_suspended?
 
         ##
         # Returns true if this writer is still accepting writes. This means
@@ -267,7 +267,7 @@ module Google
         #
         # @return [Boolean] Returns true if the writer is accepting writes.
         #
-        alias_method :writable?, :async_working?
+        alias writable? async_working?
 
         ##
         # Returns true if this writer is fully stopped.
@@ -276,7 +276,7 @@ module Google
         #
         # @return [Boolean] Returns true if the writer is fully stopped.
         #
-        alias_method :stopped?, :async_stopped?
+        alias stopped? async_stopped?
 
         ##
         # Blocks until this asynchronous writer has been stopped, or the given
@@ -290,7 +290,7 @@ module Google
         # @return [Boolean] Returns true if the writer is stopped, or false
         #   if the timeout expired.
         #
-        alias_method :wait_until_stopped, :wait_until_async_stopped
+        alias wait_until_stopped wait_until_async_stopped
 
         ##
         # Stop this asynchronous writer and block until it has been stopped.
@@ -340,7 +340,7 @@ module Google
               labels: queue_item.labels,
               partial_success: @partial_success
             )
-          rescue => e
+          rescue StandardError => e
             # Ignore any exceptions thrown from the background thread, but
             # keep running to ensure its state behavior remains consistent.
             @last_exception = e

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

@@ -38,19 +38,19 @@ module Google
       #   logging.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/logging.admin"]
-        PATH_ENV_VARS = %w(LOGGING_CREDENTIALS
+        SCOPE = ["https://www.googleapis.com/auth/logging.admin"].freeze
+        PATH_ENV_VARS = %w[LOGGING_CREDENTIALS
                            LOGGING_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS
                            GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(LOGGING_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[LOGGING_CREDENTIALS_JSON
                            LOGGING_KEYFILE_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -27,8 +27,7 @@ module Google
         class HttpRequest
           ##
           # @private Create an empty HttpRequest object.
-          def initialize
-          end
+          def initialize; end
 
           ##
           # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.