cloudwatchlogger 0.2.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb1e357bd158f76606d1e13a03ed520f6dead066
-  data.tar.gz: 4dd0d17ac08f99ff207519b1b9e5ad7c0120cc8d
+SHA256:
+  metadata.gz: 132c7aab13981c643838904bd543fd3dadf18e35a46df7aa3cfba528e5732a7a
+  data.tar.gz: 7f64be893d988a05eb5bf4b607261a95f4ff623fe73d13f09e573950b1cf9e9c
 SHA512:
-  metadata.gz: 9ae37a40c94f7f2b7b82702ff319d3511dc0baf64e70e095b2bfd2cfaf37bb06955dd083426cb068412f1dcdfc560b65ef586c4d50243ea902792162eb11ec59
-  data.tar.gz: e0c060b9ec7d9001a450b0da9d611e7d1bd1c77cf70278e32f38c646c64effe4dd7bdb997dfec03dfbc1603d878f20b642b243fefe177d9e37e5a85081f1dc67
+  metadata.gz: 1a81c48830dec6cfdb4ab851121f3cce19e2859d9549ac853338575f6e15cdadc1c03d5fa3beda5e04e68f76afdcb5ff3f00efb9ef1a0f65e3a454ec9992b841
+  data.tar.gz: cb7283ed4226ad1deda01e16a4c1578297f6f416f8dc827a76cf8edbaf8e79e389e3af9d32067cd5ed1593f0f0374b70f9e7826fd25863ed12a017bc402f0dff

data/README.md

@@ -20,7 +20,7 @@ log = CloudWatchLogger.new({access_key_id: 'YOUR_ACCESS_KEY_ID', secret_access_k
 log.info("Hello World from Ruby")
 ```
 
-In case you need to pass different region or group's different Log Stream name:
+The region will default to the value of the environment variable `AWS_REGION`. In case you need to pass different region or group's different Log Stream name:
 
 ```ruby
 log = CloudWatchLogger.new({
@@ -29,6 +29,12 @@ log = CloudWatchLogger.new({
 }, 'YOUR_CLOUDWATCH_LOG_GROUP', 'YOUR_CLOUDWATCH_LOG_STREAM', region: 'YOUR_CLOUDWATCH_REGION' )
 ```
 
+Provding an empty hash instead of credentials will cause the AWS SDK to search the default credential provider chain for credentials, namely:
+
+1. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+1. Amazon ECS container credentials (task role)
+1. Instance profile credentials (IAM role)
+
 ### With Rails
 
 config/environments/production.rb
@@ -80,6 +86,18 @@ Will produce the following log message in CloudWatch Logs:
 "<Date> severity=WARN, boom=box, bar=soap"
 ```
 
+### Custom Log Formatters
+The default formatter in this gem ensures that the timestamp sent to cloudwatch will reflect the time the message was pushed onto the queue. If you want to use a custom log formatter, in order for you to not have a disparity between your actual log time and the time reflected in CloudWatch, you will need to ensure your formatter is a `Hash` with a key for `message` which will contain your log message, and `epoch_time` which should be an epoch time formatted timestamp for your log entry, like so:
+
+```ruby
+logger.formatter = proc do |severity, datetime, progname, msg|
+  {
+    message:    "CUSTOM FORMATTER PREFIX: #{msg}\n",
+    epoch_time: (datetime.utc.to_f.round(3) * 1000).to_i
+  }
+end
+```
+
 Releasing
 -----
 

data/cloudwatchlogger.gemspec

@@ -5,10 +5,10 @@ Gem::Specification.new do |s|
   s.name              = 'cloudwatchlogger'
   s.version           = CloudWatchLogger::VERSION
   s.date              = Time.now
-  s.summary           = 'AWS CloudWatchLogs compatiable logger for ruby.'
+  s.summary           = 'Amazon CloudWatch Logs compatiable logger for ruby.'
   s.description       = 'Logger => CloudWatchLogs'
 
-  s.license           = "http://opensource.org/licenses/MIT"
+  s.license           = "MIT"
 
   s.authors           = ["Zane Shannon"]
   s.email             = 'z@zcs.me'

data/lib/cloudwatchlogger/client/aws_sdk/threaded.rb

@@ -50,17 +50,14 @@ module CloudWatchLogger
             loop do
               connect!(opts) if @client.nil?
 
-              msg = @queue.pop
-              break if msg == :__delivery_thread_exit_signal__
+              message_object = @queue.pop
+              break if message_object == :__delivery_thread_exit_signal__
 
               begin
                 event = {
                   log_group_name: @log_group_name,
                   log_stream_name: @log_stream_name,
-                  log_events: [{
-                    timestamp: (Time.now.utc.to_f.round(3) * 1000).to_i,
-                    message: msg
-                  }]
+                  log_events: [log_event(message_object)]
                 }
                 event[:sequence_token] = @sequence_token if @sequence_token
                 response = @client.put_log_events(event)
@@ -93,13 +90,11 @@ module CloudWatchLogger
         end
 
         def connect!(opts = {})
-          @client = Aws::CloudWatchLogs::Client.new(
-            region: @opts[:region] || 'us-east-1',
-            access_key_id: @credentials[:access_key_id],
-            secret_access_key: @credentials[:secret_access_key],
-            http_open_timeout: opts[:open_timeout],
-            http_read_timeout: opts[:read_timeout]
-          )
+          args = { http_open_timeout: opts[:open_timeout], http_read_timeout: opts[:read_timeout] }
+          args[:region] = @opts[:region] if @opts[:region]
+          args.merge!( @credentials.key?(:access_key_id) ? { access_key_id: @credentials[:access_key_id], secret_access_key: @credentials[:secret_access_key] } : {} )
+
+          @client = Aws::CloudWatchLogs::Client.new(args)
           begin
             @client.create_log_stream(
               log_group_name: @log_group_name,
@@ -110,8 +105,21 @@ module CloudWatchLogger
               log_group_name: @log_group_name
             )
             retry
-          rescue Aws::CloudWatchLogs::Errors::ResourceAlreadyExistsException
+          rescue Aws::CloudWatchLogs::Errors::ResourceAlreadyExistsException,
+            Aws::CloudWatchLogs::Errors::AccessDeniedException
+          end
+        end
+
+        def log_event(message_object)
+          timestamp = (Time.now.utc.to_f.round(3) * 1000).to_i
+          message = message_object
+
+          if message_object.is_a?(Hash) && %i[epoch_time message].all?{ |s| message_object.key?(s) }
+            timestamp = message_object[:epoch_time]
+            message = message_object[:message]
           end
+
+          { timestamp: timestamp, message: message }
         end
       end
     end

data/lib/cloudwatchlogger/client.rb

@@ -33,11 +33,11 @@ module CloudWatchLogger
         end.join(', ')
       end
 
-      def formatter
+      def formatter(format=nil)
         proc do |severity, datetime, progname, msg|
           processid = Process.pid
-          if @format == :json && msg.is_a?(Hash)
-            MultiJson.dump(msg.merge(severity: severity,
+          if format == :json && msg.is_a?(Hash)
+            message = MultiJson.dump(msg.merge(severity: severity,
                                      datetime: datetime,
                                      progname: progname,
                                      pid: processid))
@@ -45,6 +45,11 @@ module CloudWatchLogger
             message = "#{datetime} "
             message << massage_message(msg, severity, processid)
           end
+
+          {
+            message:    message,
+            epoch_time: epoch_from(datetime)
+          }
         end
       end
 
@@ -80,6 +85,10 @@ module CloudWatchLogger
         uuid = UUID.new
         @log_stream_name ||= "#{Socket.gethostname}-#{uuid.generate}"
       end
+
+      def epoch_from(datetime)
+        (datetime.utc.to_f.round(3) * 1000).to_i
+      end
     end
   end
 end

data/lib/cloudwatchlogger/version.rb

@@ -1,3 +1,3 @@
 module CloudWatchLogger
-  VERSION = '0.2.1'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/cloudwatchlogger.rb

@@ -11,7 +11,7 @@ module CloudWatchLogger
     logger = Logger.new(client)
 
     if client.respond_to?(:formatter)
-      logger.formatter = client.formatter
+      logger.formatter = client.formatter(opts[:format])
     elsif client.respond_to?(:datetime_format)
       logger.datetime_format = client.datetime_format
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatchlogger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Zane Shannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -69,7 +69,7 @@ files:
 - lib/cloudwatchlogger/version.rb
 homepage: http://github.com/zshannon/cloudwatchlogger
 licenses:
-- http://opensource.org/licenses/MIT
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -86,9 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: AWS CloudWatchLogs compatiable logger for ruby.
+summary: Amazon CloudWatch Logs compatiable logger for ruby.
 test_files: []