cm-cloudwatchlogger 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fcfddd765a3ef7b8613f58504a1849fba5786a572ee3692432bc5985f56e023
+  data.tar.gz: a1197b067bdf6b6e86f62a8a505ca6a5f2beee8aa4e8f4b391ec1180a2014dd8
+SHA512:
+  metadata.gz: d3d28307ebf7aa1d3c5b51f5a3950ea11a4b85307289a5dcce229385a14fb527516f3ac288c2e745fddfb674e96defd9ad07aee15f40c9558c6d60787dad415d
+  data.tar.gz: 861e199cd13f9bc4b1fac54ca9f7ee33f1f9e09d3f5065673b5ea753769fe5f540061983ebea824becc5748770d82f2fa05d41266ec932a68ae9f2a1d2bd28e2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+platforms :jruby do
+  gem 'jruby-openssl'
+  gem 'multi_json', '~> 1' # https://github.com/bundler/bundler/issues/4157
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zane Shannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+Overview
+--------
+
+Send logged messages to [AWS CloudWatch Logs](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatchLogs.html) using the ruby [AWS SDK](http://docs.aws.amazon.com/sdkforruby/api/index.html).
+
+Can be used in place of Ruby's Logger
+(<http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/>)
+
+In fact, it (currently) returns an instance of Logger.
+
+Forked from (<https://github.com/zshannon/cloudwatchlogger>).
+
+Usage
+-----
+```ruby
+require 'cloudwatchlogger'
+
+log = CloudWatchLogger.new({access_key_id: 'YOUR_ACCESS_KEY_ID', secret_access_key: 'YOUR_SECRET_ACCESS_KEY'}, 'YOUR_CLOUDWATCH_LOG_GROUP')
+
+log.info("Hello World from Ruby")
+```
+
+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({
+  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' )
+```
+
+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
+```ruby
+RailsApplication::Application.configure do
+  config.logger = CloudWatchLogger.new({access_key_id: 'YOUR_ACCESS_KEY_ID', secret_access_key: 'YOUR_SECRET_ACCESS_KEY'}, 'YOUR_CLOUDWATCH_LOG_GROUP', 'YOUR_CLOUDWATCH_LOG_STREAM', 'YOUR_CLOUDWATCH_REGION')
+end
+```
+
+
+Logging
+-------
+
+CloudWatchLogger.new returns a ruby Logger object, so take a look at:
+
+http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/
+
+The Logger's logdev has some special format handling though.
+
+### Logging a string
+
+```ruby
+log.warn "test"
+```
+
+Will produce the following log message in CloudWatch Logs:
+
+```
+"<Date> severity=WARN, test"
+```
+
+### Logging a Hash
+
+```ruby
+log.warn :boom => :box, :bar => :soap
+```
+
+Will produce the following log message in CloudWatch Logs:
+
+```
+"<Date> severity=WARN, boom=box, bar=soap"
+```
+
+Releasing
+-----
+
+`rake release`
+
+Bugs
+-----
+
+https://github.com/commutatus/cloudwatchlogger/issues
+
+Pull requests welcome.

data/cloudwatchlogger.gemspec

@@ -0,0 +1,27 @@
+dir = File.dirname(__FILE__)
+require File.expand_path(File.join(dir, 'lib', 'cloudwatchlogger', 'version'))
+
+Gem::Specification.new do |s|
+  s.name              = 'cm-cloudwatchlogger'
+  s.version           = CloudWatchLogger::VERSION
+  s.date              = Time.now
+  s.summary           = 'Amazon CloudWatch Logs compatiable logger for ruby.'
+  s.description       = 'Logger => CloudWatchLogs'
+
+  s.license           = "MIT"
+
+  s.authors           = ["Zane Shannon", "Manikandan"]
+  s.email             = ['z@zcs.me', 'manikandan0603@gmail.com']
+  s.homepage          = 'http://github.com/commutatus/cloudwatchlogger'
+
+  s.files             = %w{ README.md Gemfile LICENSE cloudwatchlogger.gemspec } + Dir["lib/**/*.rb"]
+  s.require_paths     = ['lib']
+  s.test_files        = Dir["spec/**/*.rb"]
+
+  s.required_ruby_version     = '>= 1.8.6'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.add_runtime_dependency 'securerandom', '~> 0.1'
+  s.add_runtime_dependency 'multi_json', '~> 1'
+  s.add_runtime_dependency 'aws-sdk-cloudwatchlogs', '~> 1'
+end

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

@@ -0,0 +1,118 @@
+require 'aws-sdk-cloudwatchlogs'
+require 'thread'
+
+module CloudWatchLogger
+  module Client
+    class AWS_SDK
+      # Used by the Threaded client to manage the delivery thread
+      # recreating it if is lost due to a fork.
+      #
+      class DeliveryThreadManager
+        def initialize(credentials, log_group_name, log_stream_name, opts = {})
+          @credentials = credentials
+          @log_group_name = log_group_name
+          @log_stream_name = log_stream_name
+          @opts = opts
+          start_thread
+        end
+
+        # Pushes a message to the delivery thread, starting one if necessary
+        def deliver(message)
+          start_thread unless @thread.alive?
+          @thread.deliver(message)
+          # Race condition? Sometimes we need to rescue this and start a new thread
+        rescue NoMethodError
+          @thread.kill # Try not to leak threads, should already be dead anyway
+          start_thread
+          retry
+        end
+
+        private
+
+        def start_thread
+          @thread = DeliveryThread.new(@credentials, @log_group_name, @log_stream_name, @opts)
+        end
+      end
+
+      class DeliveryThread < Thread
+        def initialize(credentials, log_group_name, log_stream_name, opts = {})
+          opts[:open_timeout] = opts[:open_timeout] || 120
+          opts[:read_timeout] = opts[:read_timeout] || 120
+          @credentials = credentials
+          @log_group_name = log_group_name
+          @log_stream_name = log_stream_name
+          @opts = opts
+
+          @queue = Queue.new
+          @exiting = false
+
+          super do
+            loop do
+              connect!(opts) if @client.nil?
+
+              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: message_object[:epoch_time],
+                    message:   message_object[:message]
+                  }]
+                }
+                event[:sequence_token] = @sequence_token if @sequence_token
+                response = @client.put_log_events(event)
+                unless response.rejected_log_events_info.nil?
+                  raise CloudWatchLogger::LogEventRejected
+                end
+                @sequence_token = response.next_sequence_token
+              rescue Aws::CloudWatchLogs::Errors::InvalidSequenceTokenException => err
+                @sequence_token = err.message.split(' ').last
+                retry
+              end
+            end
+          end
+
+          at_exit do
+            exit!
+            join
+          end
+        end
+
+        # Signals the queue that we're exiting
+        def exit!
+          @exiting = true
+          @queue.push :__delivery_thread_exit_signal__
+        end
+
+        # Pushes a message onto the internal queue
+        def deliver(message)
+          @queue.push(message)
+        end
+
+        def connect!(opts = {})
+          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,
+              log_stream_name: @log_stream_name
+            )
+          rescue Aws::CloudWatchLogs::Errors::ResourceNotFoundException
+            @client.create_log_group(
+              log_group_name: @log_group_name
+            )
+            retry
+          rescue Aws::CloudWatchLogs::Errors::ResourceAlreadyExistsException, 
+            Aws::CloudWatchLogs::Errors::AccessDeniedException
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloudwatchlogger/client/aws_sdk.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), 'aws_sdk', 'threaded')
+
+module CloudWatchLogger
+  module Client
+    class AWS_SDK
+      include CloudWatchLogger::Client::InstanceMethods
+
+      attr_reader :input_uri, :deliverer
+
+      def initialize(credentials, log_group_name, log_stream_name, opts = {})
+        setup_credentials(credentials)
+        setup_log_group_name(log_group_name)
+        setup_log_stream_name(log_stream_name)
+        @deliverer = CloudWatchLogger::Client::AWS_SDK::DeliveryThreadManager.new(@credentials, @log_group_name, @log_stream_name, opts)
+      end
+
+      def write(message)
+        @deliverer.deliver(message)
+      end
+
+      def close
+        nil
+      end
+    end
+  end
+end

data/lib/cloudwatchlogger/client.rb

@@ -0,0 +1,95 @@
+require 'multi_json'
+require 'socket'
+require 'thread'
+require 'securerandom'
+
+module CloudWatchLogger
+  module Client
+    def self.new(credentials, log_group_name, log_stream_name = nil, opts = {})
+      unless log_group_name
+        raise LogGroupNameRequired, 'log_group_name is required'
+      end
+
+      CloudWatchLogger::Client::AWS_SDK.new(credentials, log_group_name, log_stream_name, opts)
+    end
+
+    module InstanceMethods
+      def masherize_key(prefix, key)
+        [prefix, key.to_s].compact.join('.')
+      end
+
+      def masher(hash, prefix = nil)
+        hash.map do |v|
+          if v[1].is_a?(Hash)
+            masher(v[1], masherize_key(prefix, v[0]))
+          else
+            "#{masherize_key(prefix, v[0])}=" << case v[1]
+                                                 when Symbol
+                                                   v[1].to_s
+                                                 else
+                                                   v[1].inspect
+                                                 end
+          end
+        end.join(', ')
+      end
+
+      def formatter(format=nil)
+        proc do |severity, datetime, progname, msg|
+          processid = Process.pid
+          if format == :json && msg.is_a?(Hash)
+            message = MultiJson.dump(msg.merge(severity: severity,
+                                     datetime: datetime,
+                                     progname: progname,
+                                     pid: processid))
+          else
+            message = "#{datetime} "
+            message << massage_message(msg, severity, processid)
+          end
+
+          {
+            message:    message,
+            epoch_time: epoch_from(datetime)
+          }
+        end
+      end
+
+      def massage_message(incoming_message, severity, processid)
+        outgoing_message = ''
+
+        outgoing_message << "pid=#{processid}, thread=#{Thread.current.object_id}, severity=#{severity}, "
+
+        outgoing_message << case incoming_message
+                            when Hash
+                              masher(incoming_message)
+                            when String
+                              incoming_message
+                            else
+                              incoming_message.inspect
+                            end
+        outgoing_message
+      end
+
+      def setup_credentials(credentials)
+        @credentials = credentials
+      end
+
+      def setup_log_group_name(name)
+        @log_group_name = name
+      end
+
+      def setup_log_stream_name(name)
+        @log_stream_name = name || default_log_stream_name
+      end
+
+      def default_log_stream_name
+        @log_stream_name ||= "#{Socket.gethostname}-#{SecureRandom.uuid}"
+      end
+
+      def epoch_from(datetime)
+        (datetime.utc.to_f.round(3) * 1000).to_i
+      end
+    end
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'client', 'aws_sdk')

data/lib/cloudwatchlogger/version.rb

@@ -0,0 +1,3 @@
+module CloudWatchLogger
+  VERSION = '0.4.0'.freeze
+end

data/lib/cloudwatchlogger.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'cloudwatchlogger', 'client')
+
+require 'logger'
+
+module CloudWatchLogger
+  class LogGroupNameRequired < ArgumentError; end
+  class LogEventRejected < ArgumentError; end
+
+  def self.new(credentials, log_group_name, log_stream_name = nil, opts = {})
+    client = CloudWatchLogger::Client.new(credentials, log_group_name, log_stream_name, opts)
+    logger = Logger.new(client)
+
+    if client.respond_to?(:formatter)
+      logger.formatter = client.formatter(opts[:format])
+    elsif client.respond_to?(:datetime_format)
+      logger.datetime_format = client.datetime_format
+    end
+
+    logger
+  end
+end

data/lib/cm-cloudwatchlogger.rb

@@ -0,0 +1 @@
+require 'cloudwatchlogger'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: cm-cloudwatchlogger
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Zane Shannon
+- Manikandan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatchlogs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Logger => CloudWatchLogs
+email:
+- z@zcs.me
+- manikandan0603@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- cloudwatchlogger.gemspec
+- lib/cloudwatchlogger.rb
+- lib/cloudwatchlogger/client.rb
+- lib/cloudwatchlogger/client/aws_sdk.rb
+- lib/cloudwatchlogger/client/aws_sdk/threaded.rb
+- lib/cloudwatchlogger/version.rb
+- lib/cm-cloudwatchlogger.rb
+homepage: http://github.com/commutatus/cloudwatchlogger
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.3.4
+signing_key:
+specification_version: 4
+summary: Amazon CloudWatch Logs compatiable logger for ruby.
+test_files: []