google-cloud-logging 1.4.0 → 1.5.0

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

@@ -167,7 +167,7 @@ module Google
           # @private Raise an error unless an active connection to the service
           # is available.
           def ensure_service!
-            fail "Must have active connection to service" unless @service
+            raise "Must have active connection to service" unless @service
           end
         end
       end

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

@@ -28,8 +28,7 @@ module Google
         class Operation
           ##
           # @private Create an empty Operation object.
-          def initialize
-          end
+          def initialize; end
 
           ##
           # An arbitrary operation identifier. Log entries with the same

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

@@ -28,8 +28,7 @@ module Google
         class SourceLocation
           ##
           # @private Create an empty SourceLocation object.
-          def initialize
-          end
+          def initialize; end
 
           ##
           # Source file name. Depending on the runtime environment, this might

data/lib/google/cloud/logging/log/list.rb

@@ -146,7 +146,7 @@ module Google
           # @private Raise an error unless an active connection to the service
           # is available.
           def ensure_service!
-            fail "Must have active connection to service" unless @service
+            raise "Must have active connection to service" unless @service
           end
         end
       end

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

@@ -71,7 +71,7 @@ module Google
         ##
         # The Google Cloud log_name to write the log entry with.
         attr_reader :log_name
-        alias_method :progname, :log_name
+        alias progname log_name
 
         ##
         # The Google Cloud resource to write the log entry with.
@@ -84,8 +84,8 @@ module Google
         ##
         # The logging severity threshold (e.g. `Logger::INFO`)
         attr_reader :level
-        alias_method :sev_threshold, :level
-        alias_method :local_level, :level
+        alias sev_threshold level
+        alias local_level level
 
         ##
         # Boolean flag that indicates whether this logger can be silenced or
@@ -317,7 +317,7 @@ module Google
           write_entry severity, message unless @closed
           true
         end
-        alias_method :log, :add
+        alias log add
 
         ##
         # Logs the given message at UNKNOWN severity.
@@ -393,11 +393,13 @@ module Google
         #
         def level= severity
           new_level = derive_severity severity
-          fail ArgumentError, "invalid log level: #{severity}" if new_level.nil?
+          if new_level.nil?
+            raise ArgumentError, "invalid log level: #{severity}"
+          end
           @level = new_level
         end
-        alias_method :sev_threshold=, :level=
-        alias_method :local_level=, :level=
+        alias sev_threshold= level=
+        alias local_level= level=
 
         ##
         # Close the logging "device". This effectively disables logging from
@@ -482,7 +484,7 @@ module Google
 
         ##
         # @deprecated Use delete_request_info
-        alias_method :delete_trace_id, :delete_request_info
+        alias delete_trace_id delete_request_info
 
         ##
         # No-op method. Created to match the spec of ActiveSupport::Logger#flush
@@ -584,15 +586,14 @@ module Google
           when "error".freeze then ::Logger::ERROR
           when "fatal".freeze then ::Logger::FATAL
           when "unknown".freeze then ::Logger::UNKNOWN
-          else nil
           end
         end
 
         ##
         # @private Get Google Cloud deverity from logger level number.
         def gcloud_severity severity_int
-          %i(DEBUG INFO WARNING ERROR CRITICAL DEFAULT)[severity_int]
-        rescue
+          %i[DEBUG INFO WARNING ERROR CRITICAL DEFAULT][severity_int]
+        rescue StandardError
           :DEFAULT
         end
 

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

@@ -125,7 +125,7 @@ module Google
           @grpc = service.get_metric name
           true
         end
-        alias_method :refresh!, :reload!
+        alias refresh! reload!
 
         ##
         # Permanently deletes the logs-based metric.
@@ -160,7 +160,7 @@ module Google
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless service
+          raise "Must have active connection to service" unless service
         end
       end
     end

data/lib/google/cloud/logging/metric/list.rb

@@ -161,7 +161,7 @@ module Google
           # @private Raise an error unless an active connection to the service
           # is available.
           def ensure_service!
-            fail "Must have active connection to service" unless @service
+            raise "Must have active connection to service" unless @service
           end
         end
       end

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

@@ -22,12 +22,13 @@ module Google
         ##
         # The default log name used to instantiate the default logger if one
         # isn't provided.
-        DEFAULT_LOG_NAME = "ruby_app_log"
+        DEFAULT_LOG_NAME = "ruby_app_log".freeze
 
         ##
         # 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" }
+        DEFAULT_LOG_NAME_MAP =
+          { "/_ah/health" => "ruby_health_check_log" }.freeze
 
         ##
         # The Google::Cloud::Logging::Logger instance
@@ -59,11 +60,12 @@ module Google
             @logger = logger
           else
             log_name = configuration.log_name
-            logging = Logging.new project: configuration.project_id,
-                                  keyfile: configuration.keyfile
+            logging = Logging.new project_id: configuration.project_id,
+                                  credentials: configuration.credentials
             resource = Middleware.build_monitored_resource(
               configuration.monitored_resource.type,
-              configuration.monitored_resource.labels)
+              configuration.monitored_resource.labels
+            )
             @logger = logging.logger log_name, resource
           end
         end
@@ -225,7 +227,8 @@ module Google
             if Google::Cloud.env.app_engine?
               ["gae_app", {
                 module_id: Google::Cloud.env.app_engine_service_id,
-                version_id: Google::Cloud.env.app_engine_service_version }]
+                version_id: Google::Cloud.env.app_engine_service_version
+              }]
             elsif Google::Cloud.env.container_engine?
               ["container", {
                 cluster_name: Google::Cloud.env.container_engine_cluster_name,
@@ -235,7 +238,8 @@ module Google
             elsif Google::Cloud.env.compute_engine?
               ["gce_instance", {
                 instance_id: Google::Cloud.env.instance_name,
-                zone: Google::Cloud.env.instance_zone }]
+                zone: Google::Cloud.env.instance_zone
+              }]
             else
               ["global", {}]
             end
@@ -256,12 +260,14 @@ module Google
         # already.
         #
         def load_config **kwargs
-          configuration.project_id = kwargs[:project_id] ||
-                                     configuration.project_id
-          configuration.keyfile = kwargs[:keyfile] ||
-                                  configuration.keyfile
-          configuration.log_name_map ||= kwargs[:log_name_map] ||
-                                         configuration.log_name_map
+          project_id = kwargs[:project] || kwargs[:project_id]
+          configuration.project_id = project_id unless project_id.nil?
+
+          creds = kwargs[:credentials] || kwargs[:keyfile]
+          configuration.credentials = creds unless creds.nil?
+
+          log_name_map = kwargs[:log_name_map]
+          configuration.log_name_map = log_name_map unless log_name_map.nil?
 
           init_default_config
         end
@@ -269,9 +275,10 @@ 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_id
-          configuration.keyfile ||= Cloud.configure.keyfile
+          configuration.project_id ||= begin
+            (Cloud.configure.project_id || Logging.default_project_id)
+          end
+          configuration.credentials ||= Cloud.configure.credentials
           configuration.log_name ||= DEFAULT_LOG_NAME
           configuration.log_name_map ||= DEFAULT_LOG_NAME_MAP
         end

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

@@ -14,7 +14,6 @@
 
 
 require "google/cloud/errors"
-require "google/cloud/env"
 require "google/cloud/logging/service"
 require "google/cloud/logging/credentials"
 require "google/cloud/logging/log/list"
@@ -75,16 +74,7 @@ module Google
         def project_id
           service.project
         end
-        alias_method :project, :project_id
-
-        ##
-        # @private Default project.
-        def self.default_project_id
-          ENV["LOGGING_PROJECT"] ||
-            ENV["GOOGLE_CLOUD_PROJECT"] ||
-            ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud.env.project_id
-        end
+        alias project project_id
 
         ##
         # Lists log entries. Use this method to retrieve log entries from Cloud
@@ -164,7 +154,7 @@ module Google
                                 filter: filter, order: order,
                                 projects: projects
         end
-        alias_method :find_entries, :entries
+        alias find_entries entries
 
         ##
         # Creates an new Entry instance that may be populated and written to the
@@ -226,7 +216,7 @@ module Google
           e.payload = payload if payload
           e
         end
-        alias_method :new_entry, :entry
+        alias new_entry entry
 
         ##
         # Writes log entries to the Stackdriver Logging service.
@@ -469,9 +459,9 @@ module Google
                                         max: max
           Log::List.from_grpc list_grpc, service, resource: resource, max: max
         end
-        alias_method :find_logs, :logs
-        alias_method :log_names, :logs
-        alias_method :find_log_names, :logs
+        alias find_logs logs
+        alias log_names logs
+        alias find_log_names logs
 
         ##
         # Deletes a log and all its log entries. The log will reappear if it
@@ -537,7 +527,7 @@ module Google
           list_grpc = service.list_resource_descriptors token: token, max: max
           ResourceDescriptor::List.from_grpc list_grpc, service, max
         end
-        alias_method :find_resource_descriptors, :resource_descriptors
+        alias find_resource_descriptors resource_descriptors
 
         ##
         # Creates a new monitored resource instance.
@@ -564,7 +554,7 @@ module Google
             r.labels = labels
           end
         end
-        alias_method :new_resource, :resource
+        alias new_resource resource
 
         ##
         # Retrieves the list of sinks belonging to the project.
@@ -600,7 +590,10 @@ module Google
           list_grpc = service.list_sinks token: token, max: max
           Sink::List.from_grpc list_grpc, service, max
         end
-        alias_method :find_sinks, :sinks
+        alias find_sinks sinks
+
+        # rubocop:disable Metrics/LineLength
+        # overload is too long...
 
         ##
         # Creates a new project sink. When you create a sink, only new log
@@ -621,40 +614,27 @@ module Google
         # @see https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs
         #   Permissions for writing exported logs
         #
-        # @param [String] name The client-assigned sink identifier. Sink
-        #   identifiers are limited to 1000 characters and can include only the
-        #   following characters: `A-Z`, `a-z`, `0-9`, and the special
-        #   characters `_-.`.
-        # @param [String] destination The resource name of the export
-        #   destination. See [About
-        #   sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs#about_sinks)
-        #   for examples.
-        # @param [String, nil] filter An [advanced logs
-        #  filter](https://cloud.google.com/logging/docs/view/advanced_filters)
-        #  that defines the log entries to be exported. The filter must be
-        #  consistent with the log entry format designed by the `version`
-        #  parameter, regardless of the format of the log entry that was
-        #  originally written to Stackdriver Logging.
-        # @param [Time, nil] start_at The time at which this sink will begin
-        #   exporting log entries. If this value is present, then log entries
-        #   are exported only if `start_at` is less than the log entry's
-        #   timestamp. Optional.
-        # @param [Time, nil] end_at Time at which this sink will stop exporting
-        #   log entries. If this value is present, then log entries are exported
-        #   only if the log entry's timestamp is less than `end_at`. Optional.
-        # @param [Symbol] version The log entry version used when exporting log
-        #   entries from this sink. This version does not have to correspond to
-        #   the version of the log entry when it was written to Stackdriver
-        #   Logging. Accepted values are `:unspecified`, `:v2`, and `:v1`.
-        #   Version 2 is currently the preferred format. An unspecified version
-        #   format currently defaults to V2 in the service. The default value is
-        #   `:unspecified`.
-        # @param [Boolean] unique_writer_identity Whether the sink will have a
-        #    dedicated service account returned in the sink's `writer_identity`.
-        #    Set this field to be true to export logs from one project to a
-        #    different project. This field is ignored for non-project sinks
-        #    (e.g. organization sinks) because those sinks are required to have
-        #    dedicated service accounts. Optional.
+        # @overload create_sink(name, destination, filter: nil, unique_writer_identity: nil)
+        #   @param [String] name The client-assigned sink identifier. Sink
+        #     identifiers are limited to 1000 characters and can include only
+        #     the following characters: `A-Z`, `a-z`, `0-9`, and the special
+        #     characters `_-.`.
+        #   @param [String] destination The resource name of the export
+        #     destination. See [About
+        #     sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs#about_sinks)
+        #     for examples.
+        #   @param [String, nil] filter An [advanced logs
+        #    filter](https://cloud.google.com/logging/docs/view/advanced_filters)
+        #    that defines the log entries to be exported. The filter must be
+        #    consistent with the log entry format designed by the `version`
+        #    parameter, regardless of the format of the log entry that was
+        #    originally written to Stackdriver Logging.
+        #   @param [Boolean] unique_writer_identity Whether the sink will have a
+        #      dedicated service account returned in the sink's
+        #      `writer_identity`. Set this field to be true to export logs from
+        #      one project to a different project. This field is ignored for
+        #      non-project sinks (e.g. organization sinks) because those sinks
+        #      are required to have dedicated service accounts. Optional.
         #
         # @return [Google::Cloud::Logging::Sink] a project sink
         #
@@ -676,18 +656,29 @@ module Google
         #   sink = logging.create_sink "my-sink",
         #                              "storage.googleapis.com/#{bucket.id}"
         #
-        def create_sink name, destination, filter: nil, start_at: nil,
-                        end_at: nil, version: :unspecified,
-                        unique_writer_identity: nil
-          version = Sink.resolve_version version
+        def create_sink name, destination, filter: nil,
+                        unique_writer_identity: nil,
+                        start_at: nil, end_at: nil, version: nil
           ensure_service!
+
+          if start_at
+            warn "[DEPRECATION] start_at is deprecated and will be ignored."
+          end
+          if end_at
+            warn "[DEPRECATION] end_at is deprecated and will be ignored."
+          end
+          if version
+            warn "[DEPRECATION] version is deprecated and will be ignored."
+          end
+
           grpc = service.create_sink \
-            name, destination, filter, version,
-            start_time: start_at, end_time: end_at,
+            name, destination, filter,
             unique_writer_identity: unique_writer_identity
           Sink.from_grpc grpc, service
         end
-        alias_method :new_sink, :create_sink
+        alias new_sink create_sink
+
+        # rubocop:enable Metrics/LineLength
 
         ##
         # Retrieves a sink by name.
@@ -716,8 +707,8 @@ module Google
         rescue Google::Cloud::NotFoundError
           nil
         end
-        alias_method :get_sink, :sink
-        alias_method :find_sink, :sink
+        alias get_sink sink
+        alias find_sink sink
 
         ##
         # Retrieves the list of metrics belonging to the project.
@@ -753,7 +744,7 @@ module Google
           grpc = service.list_metrics token: token, max: max
           Metric::List.from_grpc grpc, service, max
         end
-        alias_method :find_metrics, :metrics
+        alias find_metrics metrics
 
         ##
         # Creates a new logs-based metric for Google Cloud Monitoring.
@@ -786,7 +777,7 @@ module Google
           grpc = service.create_metric name, filter, description
           Metric.from_grpc grpc, service
         end
-        alias_method :new_metric, :create_metric
+        alias new_metric create_metric
 
         ##
         # Retrieves metric by name.
@@ -815,8 +806,8 @@ module Google
         rescue Google::Cloud::NotFoundError
           nil
         end
-        alias_method :get_metric, :metric
-        alias_method :find_metric, :metric
+        alias get_metric metric
+        alias find_metric metric
 
         protected
 
@@ -824,7 +815,7 @@ module Google
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless service
+          raise "Must have active connection to service" unless service
         end
       end
     end