cloudwatchlogger 0.3.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c2af49513f0c3aa7ab58d1dd9118018ca1adec7fb1335493e0fad7a0a60b6e2
-  data.tar.gz: 3ef0b93addf793462ceec0052acb7c4e13e9fe5e0c59dc9034bb4f1acd1ea5af
+  metadata.gz: 92d1bca725f78cc799cd9286809047cf057b2d65ba1f4819d8e7704ca042f912
+  data.tar.gz: 49e1294daaa98bac943f4879a783162836eff76bffc90812aad6536aa1fb44ba
 SHA512:
-  metadata.gz: f3d46c5fe91f1eeb9c2f751263f86bd71194c6d0d8154b15fbe777baa79491aabc297289d245a50eac89fef2bbe661c0d4328eebb0c08171602d31e9c617c06f
-  data.tar.gz: 5d71a3e18b6ee0557710e96b19b6b40e2fc7458cbef0f1906c01629bcd207b48e11e8d03e9d597a8c67160d63937111d2c82bfe7355135d54c4c9d1c3accffe0
+  metadata.gz: 6a3b754db960b079cc3e340875ba0902bd6be22d3d3c029177946de85ac9ace921ef7ff47c014d762c3605f97679476eb1ecb99d3d5297d33065c7c8bc351f1f
+  data.tar.gz: e9fc349e6b9935b1db92b21d32d4bdddfebb45d6546493e6a1b6fe9b81bccea1c088301a66222a170dd16575e2fd63d38cb7cc0204e3b71c979e212a038d7ba2

data/README.md

@@ -29,12 +29,36 @@ 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:
+Providing 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)
 
+Besides the AWS region, you can also specify some other configuration options for your logger, such as:
+
+| Property        | Description                                                                          |
+|-----------------|--------------------------------------------------------------------------------------|
+| `region`        | AWS region.                                                                          |
+| `format`        | The output format of your messages. `:json` generates JSON logs for hashed messages. |
+| `open_timeout`  | The open timeout in seconds. Defaults to 120.                                        |
+| `read_timeout`  | The read timeout in seconds. Defaults to 120.                                        |
+
+This way, you could have something like this:
+
+```ruby
+log = CloudWatchLogger.new({
+    access_key_id: 'YOUR_ACCESS_KEY_ID',
+    secret_access_key: 'YOUR_SECRET_ACCESS_KEY'
+  }, 'YOUR_CLOUDWATCH_LOG_GROUP', 'YOUR_CLOUDWATCH_LOG_STREAM',
+  {
+    region: 'YOUR_CLOUDWATCH_REGION',
+    format: :json
+  })
+```
+
+
+
 ### With Rails
 
 config/environments/production.rb
@@ -86,6 +110,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/lib/cloudwatchlogger/client/aws_sdk/threaded.rb

@@ -57,10 +57,7 @@ module CloudWatchLogger
                 event = {
                   log_group_name: @log_group_name,
                   log_stream_name: @log_stream_name,
-                  log_events: [{
-                    timestamp: message_object[:epoch_time],
-                    message:   message_object[:message]
-                  }]
+                  log_events: [log_event(message_object)]
                 }
                 event[:sequence_token] = @sequence_token if @sequence_token
                 response = @client.put_log_events(event)
@@ -94,8 +91,9 @@ module CloudWatchLogger
 
         def connect!(opts = {})
           args = { http_open_timeout: opts[:open_timeout], http_read_timeout: opts[:read_timeout] }
+          args[:logger] = @opts[:logger] if @opts[:logger]
           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] } : {} )
+          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
@@ -108,10 +106,22 @@ 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
   end

data/lib/cloudwatchlogger/version.rb

@@ -1,3 +1,3 @@
 module CloudWatchLogger
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatchlogger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Zane Shannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-23 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Amazon CloudWatch Logs compatiable logger for ruby.