google-cloud-logging 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 055747223efbea95c51a675309d4d35050ab8b18
-  data.tar.gz: 7255d083b277697741232f86fa4b08c89cbe5989
+SHA256:
+  metadata.gz: 64d96c3d7c2e3e65da43168f7769ab9d4cf8a56f789d7cdc6c53e09bc62ae262
+  data.tar.gz: 9d49322540e7bbdcc2cb80f4277c8aa190c6ad4321ddcbf4365b2b9239e5a242
 SHA512:
-  metadata.gz: 32e392f48a2abe8ec52428f56157ce9a2fee76ef0483ea33f2bb17c9cd1c957b1d595af3fb503d6130727b6c135e2debb72472007eb1f82a82ab287041a0a65b
-  data.tar.gz: 55f318c0491a69100b394c1de617b67335f7a5e270edde3e5956d27dbf056f9507cb0642e9735c7659d8e457f8b91c9c7c254acb3a19f266cc9699889a245503
+  metadata.gz: 272469c7d46c8afce6bfb28c84174bea9ab2a0ea8fe8d7200a9ce8dd37c2c3f83825c42897bcae8e967b679f7ff3c9ed88d46bfad1510e725873f4139cf77889
+  data.tar.gz: 2631db81f9ccec5255b67f9d52e69be34493703df39bd7a575c8d6f8e45808d2de7d5fa0d1d3155b2b42ee3a46c8f60f97779e270a0c8e98fbc9682e51bc2ebd

data/lib/google-cloud-logging.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .logging and
-# #logging methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# This file is here to be autorequired by bundler, so that the
+# Google::Cloud.logging and Google::Cloud#logging methods can be available, but
+# the library and all dependencies won't be loaded until required and used.
 
 
 gem "google-cloud-core"
@@ -75,10 +75,12 @@ module Google
     # For more information on connecting to Google Cloud see the [Authentication
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
-    # @param [String] project Project identifier for the Stackdriver Logging
-    #   service you are connecting to.
-    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-    #   file path the file must be readable.
+    # @param [String] project_id Project identifier for the Stackdriver Logging
+    #   service you are connecting to. If not present, the default project for
+    #   the credentials is used.
+    # @param [String, Hash, Google::Auth::Credentials] 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})
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
@@ -103,10 +105,11 @@ module Google
     #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
     #   end
     #
-    def self.logging project = nil, keyfile = nil, scope: nil, timeout: nil,
-                     client_config: nil
+    def self.logging project_id = nil, credentials = nil, scope: nil,
+                     timeout: nil, client_config: nil
       require "google/cloud/logging"
-      Google::Cloud::Logging.new project: project, keyfile: keyfile,
+      Google::Cloud::Logging.new project_id: project_id,
+                                 credentials: credentials,
                                  scope: scope, timeout: timeout,
                                  client_config: client_config
     end

data/lib/google/cloud/logging.rb

@@ -222,6 +222,23 @@ module Google
     # logging.write_entries entry
     # ```
     #
+    # To write a JSON payload to the log, simply pass a hash argument:
+    #
+    # ```ruby
+    # require "google/cloud/logging"
+    #
+    # logging = Google::Cloud::Logging.new
+    #
+    # entry = logging.entry
+    # entry.payload = { "stats" => { "a" => 8, "b" => 12.5} }
+    # entry.log_name = "my_app_log"
+    # entry.resource.type = "gae_app"
+    # entry.resource.labels[:module_id] = "1"
+    # entry.resource.labels[:version_id] = "20150925t173233"
+    #
+    # logging.write_entries entry
+    # ```
+    #
     # If you write a collection of log entries, you can provide the log name,
     # resource, and/or labels hash to be used for all of the entries, and omit
     # these values from the individual entries.
@@ -274,7 +291,8 @@ module Google
     # async.write_entries [entry1, entry2],
     #                     log_name: "my_app_log",
     #                     resource: resource,
-    #                     labels: labels
+    #                     labels: labels,
+    #                     partial_success: true
     # ```
     #
     # ### Creating a Ruby Logger implementation
@@ -343,10 +361,12 @@ module Google
       # [Authentication
       # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
       #
-      # @param [String] project Project identifier for the Stackdriver Logging
-      #   service.
-      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-      #   file path the file must be readable.
+      # @param [String] project_id Project identifier for the Stackdriver
+      #   Logging service you are connecting to. If not present, the default
+      #   project for the credentials is used.
+      # @param [String, Hash, Google::Auth::Credentials] 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})
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google
@@ -358,6 +378,9 @@ module Google
       # @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.
+      # @param [String] project Alias for the `project_id` argument. Deprecated.
+      # @param [String] keyfile Alias for the `credentials` argument.
+      #   Deprecated.
       #
       # @return [Google::Cloud::Logging::Project]
       #
@@ -371,20 +394,21 @@ module Google
       #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
       #   end
       #
-      def self.new project: nil, keyfile: nil, scope: nil, timeout: nil,
-                   client_config: nil
-        project ||= Google::Cloud::Logging::Project.default_project
-        project = project.to_s # Always cast to a string
-        fail ArgumentError, "project is missing" if project.empty?
+      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_id.to_s # Always cast to a string
+        fail ArgumentError, "project_id is missing" if project_id.empty?
 
-        credentials =
-          Google::Cloud::Logging::Credentials.credentials_with_scope keyfile,
-                                                                     scope
+        credentials ||= (keyfile || Logging::Credentials.default(scope: scope))
+        unless credentials.is_a? Google::Auth::Credentials
+          credentials = Logging::Credentials.new credentials, scope: scope
+        end
 
-        Google::Cloud::Logging::Project.new(
-          Google::Cloud::Logging::Service.new(
-            project, credentials, timeout: timeout,
-                                  client_config: client_config))
+        Logging::Project.new(
+          Logging::Service.new(
+            project_id, credentials, timeout: timeout,
+                                     client_config: client_config))
       end
 
       ##

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

@@ -96,11 +96,13 @@ module Google
 
         ##
         # @private Creates a new AsyncWriter instance.
-        def initialize logging, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
+        def initialize logging, max_queue_size = DEFAULT_MAX_QUEUE_SIZE,
+                       partial_success = false
           super()
 
           @logging = logging
           @max_queue_size = max_queue_size
+          @partial_success = partial_success
           @queue_resource = new_cond
           @queue = []
           @queue_size = 0
@@ -335,7 +337,8 @@ module Google
               queue_item.entries,
               log_name: queue_item.log_name,
               resource: queue_item.resource,
-              labels: queue_item.labels
+              labels: queue_item.labels,
+              partial_success: @partial_success
             )
           rescue => e
             # Ignore any exceptions thrown from the background thread, but

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

@@ -13,28 +13,44 @@
 # limitations under the License.
 
 
-require "google/cloud/credentials"
+require "googleauth"
 
 module Google
   module Cloud
     module Logging
       ##
-      # @private Represents the OAuth 2.0 signing logic for Logging.
-      class Credentials < Google::Cloud::Credentials
+      # # Credentials
+      #
+      # Represents the authentication and authorization used to connect to the
+      # Stackdriver Logging API.
+      #
+      # @example
+      #   require "google/cloud/logging"
+      #
+      #   keyfile = "/path/to/keyfile.json"
+      #   creds = Google::Cloud::Logging::Credentials.new keyfile
+      #
+      #   logging = Google::Cloud::Logging.new(
+      #     project_id: "my-project",
+      #     credentials: creds
+      #   )
+      #
+      #   logging.project_id #=> "my-project"
+      #
+      class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/logging.admin"]
-        PATH_ENV_VARS = %w(LOGGING_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(LOGGING_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
+        PATH_ENV_VARS = %w(LOGGING_CREDENTIALS
+                           LOGGING_KEYFILE
+                           GOOGLE_CLOUD_CREDENTIALS
+                           GOOGLE_CLOUD_KEYFILE
+                           GCLOUD_KEYFILE)
+        JSON_ENV_VARS = %w(LOGGING_CREDENTIALS_JSON
+                           LOGGING_KEYFILE_JSON
+                           GOOGLE_CLOUD_CREDENTIALS_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
+        DEFAULT_PATHS = \
+          ["~/.config/gcloud/application_default_credentials.json"]
       end
     end
   end

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

@@ -57,6 +57,19 @@ module Google
       #
       #   logging.write_entries entry
       #
+      # @example Provide a hash to write a JSON payload to the log:
+      #   require "google/cloud/logging"
+      #
+      #   logging = Google::Cloud::Logging.new
+      #
+      #   payload = { "stats" => { "a" => 8, "b" => 12.5} }
+      #   entry = logging.entry payload: payload, log_name: "my_app_log"
+      #   entry.resource.type = "gae_app"
+      #   entry.resource.labels[:module_id] = "1"
+      #   entry.resource.labels[:version_id] = "20150925t173233"
+      #
+      #   logging.write_entries entry
+      #
       class Entry
         ##
         # Create a new Entry instance. The {#resource} attribute is

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

@@ -33,7 +33,30 @@ module Google
           ##
           # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
           # (String)
-          attr_accessor :method
+          attr_accessor :request_method
+
+          ##
+          # @overload method()
+          #   Deprecated. Use {#request_method} instead.
+          #
+          #   The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`,
+          #   `"POST"`. (String)
+          def method *args
+            # Call Object#method when args are present.
+            return super unless args.empty?
+
+            request_method
+          end
+
+          ##
+          # @overload method()
+          #   Deprecated. Use {#request_method=} instead.
+          #
+          #   The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`,
+          #   `"POST"`. (String)
+          def method= new_request_method
+            self.request_method = new_request_method
+          end
 
           ##
           # The URL. The scheme (http, https), the host name, the path and the
@@ -107,7 +130,7 @@ module Google
           def to_grpc
             return nil if empty?
             Google::Logging::Type::HttpRequest.new(
-              request_method:                     method.to_s,
+              request_method:                     request_method.to_s,
               request_url:                        url.to_s,
               request_size:                       size.to_i,
               status:                             status.to_i,
@@ -126,16 +149,16 @@ module Google
           def self.from_grpc grpc
             return new if grpc.nil?
             new.tap do |h|
-              h.method        = grpc.request_method
-              h.url           = grpc.request_url
-              h.size          = grpc.request_size
-              h.status        = grpc.status
-              h.response_size = grpc.response_size
-              h.user_agent    = grpc.user_agent
-              h.remote_ip     = grpc.remote_ip
-              h.referer       = grpc.referer
-              h.cache_hit     = grpc.cache_hit
-              h.validated     = grpc.cache_validated_with_origin_server
+              h.request_method = grpc.request_method
+              h.url            = grpc.request_url
+              h.size           = grpc.request_size
+              h.status         = grpc.status
+              h.response_size  = grpc.response_size
+              h.user_agent     = grpc.user_agent
+              h.remote_ip      = grpc.remote_ip
+              h.referer        = grpc.referer
+              h.cache_hit      = grpc.cache_hit
+              h.validated      = grpc.cache_validated_with_origin_server
             end
           end
         end

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

@@ -36,6 +36,20 @@ module Google
       #   logger = logging.logger "my_app_log", resource, env: :production
       #   logger.info "Job started."
       #
+      # @example Provide a hash to write a JSON payload to the log:
+      #   require "google/cloud/logging"
+      #
+      #   logging = Google::Cloud::Logging.new
+      #
+      #   resource = logging.resource "gae_app",
+      #                               module_id: "1",
+      #                               version_id: "20150925t173233"
+      #
+      #   logger = logging.logger "my_app_log", resource, env: :production
+      #
+      #   payload = { "stats" => { "a" => 8, "b" => 12.5} }
+      #   logger.info payload
+      #
       class Logger
         ##
         # A RequestInfo represents data about the request being handled by the

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

@@ -270,7 +270,7 @@ module Google
         # Fallback to default configuration values if not defined already
         def init_default_config
           configuration.project_id ||= Cloud.configure.project_id ||
-                                       Logging::Project.default_project
+                                       Logging::Project.default_project_id
           configuration.keyfile ||= Cloud.configure.keyfile
           configuration.log_name ||= DEFAULT_LOG_NAME
           configuration.log_name_map ||= DEFAULT_LOG_NAME_MAP

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

@@ -66,19 +66,20 @@ module Google
         #   require "google/cloud/logging"
         #
         #   logging = Google::Cloud::Logging.new(
-        #     project: "my-project",
-        #     keyfile: "/path/to/keyfile.json"
+        #     project_id: "my-project",
+        #     credentials: "/path/to/keyfile.json"
         #   )
         #
-        #   logging.project #=> "my-project"
+        #   logging.project_id #=> "my-project"
         #
-        def project
+        def project_id
           service.project
         end
+        alias_method :project, :project_id
 
         ##
         # @private Default project.
-        def self.default_project
+        def self.default_project_id
           ENV["LOGGING_PROJECT"] ||
             ENV["GOOGLE_CLOUD_PROJECT"] ||
             ENV["GCLOUD_PROJECT"] ||
@@ -203,6 +204,16 @@ module Google
         #
         #   logging.write_entries entry
         #
+        # @example Provide a hash to write a JSON payload to the log:
+        #   require "google/cloud/logging"
+        #
+        #   logging = Google::Cloud::Logging.new
+        #
+        #   payload = { "stats" => { "a" => 8, "b" => 12.5} }
+        #   entry = logging.entry severity: :INFO, payload: payload
+        #
+        #   logging.write_entries entry
+        #
         def entry log_name: nil, resource: nil, timestamp: nil, severity: nil,
                   insert_id: nil, labels: nil, payload: nil
           e = Entry.new
@@ -238,6 +249,10 @@ module Google
         #   items that are added to the `labels` field of each log entry in
         #   `entries`, except when a log entry specifies its own `key:value`
         #   item with the same key. See also {Entry#labels=}.
+        # @param [Boolean] partial_success Whether valid entries should be
+        #   written even if some other entries fail due to INVALID_ARGUMENT or
+        #   PERMISSION_DENIED errors when communicating to the Stackdriver
+        #   Logging API.
         #
         # @return [Boolean] Returns `true` if the entries were written.
         #
@@ -254,6 +269,22 @@ module Google
         #
         #   logging.write_entries entry
         #
+        # @example Provide a hash to write a JSON payload to the log:
+        #   require "google/cloud/logging"
+        #
+        #   logging = Google::Cloud::Logging.new
+        #
+        #   payload = { "stats" => { "a" => 8, "b" => 12.5} }
+        #
+        #   entry = logging.entry payload: payload,
+        #                         log_name: "my_app_log"
+        #   entry.resource.type = "gae_app"
+        #   entry.resource.labels[:module_id] = "1"
+        #   entry.resource.labels[:version_id] = "20150925t173233"
+        #
+        #   logging.write_entries entry
+        #
+        #
         # @example Optionally pass log name, resource, and labels for entries.
         #   require "google/cloud/logging"
         #
@@ -270,13 +301,15 @@ module Google
         #   logging.write_entries [entry1, entry2],
         #                         log_name: "my_app_log",
         #                         resource: resource,
-        #                         labels: labels
+        #                         labels: labels,
+        #                         partial_success: true
         #
-        def write_entries entries, log_name: nil, resource: nil, labels: nil
+        def write_entries entries, log_name: nil, resource: nil, labels: nil,
+                          partial_success: nil
           ensure_service!
           service.write_entries Array(entries).map(&:to_grpc),
                                 log_name: log_name, resource: resource,
-                                labels: labels
+                                labels: labels, partial_success: partial_success
           true
         end
 
@@ -380,6 +413,20 @@ module Google
         #   logger = logging.logger "my_app_log", resource, env: :production
         #   logger.info "Job started."
         #
+        # @example Provide a hash to write a JSON payload to the log:
+        #   require "google/cloud/logging"
+        #
+        #   logging = Google::Cloud::Logging.new
+        #
+        #   resource = logging.resource "gae_app",
+        #                               module_id: "1",
+        #                               version_id: "20150925t173233"
+        #
+        #   logger = logging.logger "my_app_log", resource, env: :production
+        #
+        #   payload = { "stats" => { "a" => 8, "b" => 12.5} }
+        #   logger.info payload
+        #
         def logger log_name, resource, labels = {}
           Logger.new shared_async_writer, log_name, resource, labels
         end