testa_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff209242c287b9a4143614c9375371889e72eab6bebb81efb5ab23202f461293
+  data.tar.gz: cde5a35fbaa3c1ba3bb4d5e3b10a29c4185906116bfcc6b1c46202e27a3eb007
+SHA512:
+  metadata.gz: a8272501fb9046b72e231420fba9b345a29e51cbe6a234dfed7de0db812de5698897caa03271ac4bfd58bf5a61e093e5354540dff45db8760ec97ca39e712602
+  data.tar.gz: 1dbc91b8244fd5c9414b203815daf345d9c09378231626be98a0199c6791c9bbbba97605503febbd662a0a4025cb77c3f77bdb6c62b29dc9e5622e1a837fc791

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,4 @@
+# we have to have per project rubcop files (IDE limitation),
+# but we want only one config across all projects
+# you can override any global cops here, in this file
+inherit_from: ../.rubocop.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at karlo.razumovic@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in testa_logger.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"
+gem "rubocop", "~> 1.26.0", require: false
+gem "rubocop-rails", require: false

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    testa_logger (0.1.0)
+      activesupport
+      awesome_print
+      aws-sdk-s3
+      concurrent-ruby
+      json
+      ostruct
+      securerandom
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.614.0)
+    aws-sdk-core (3.131.5)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.525.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-kms (1.58.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.114.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.4)
+    aws-sigv4 (1.5.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.6.1)
+    json (2.6.2)
+    minitest (5.16.2)
+    ostruct (0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rack (2.2.4)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rails (2.15.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    securerandom (0.2.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 1.26.0)
+  rubocop-rails
+  testa_logger!
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 karlo.razumovic
+
+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,44 @@
+# TestaLogger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/testa_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testa_logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install testa_logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/testa_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/testa_logger/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TestaLogger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/testa_logger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "testa_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/testa_logger/io_persistence_error.rb

@@ -0,0 +1,4 @@
+module TestaLogger
+  class IoPersistenceError < StandardError
+  end
+end

data/lib/testa_logger/log_device/period.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module TestaLogger
+  class LogDevice
+    module Period
+      module_function
+
+      SiD = 24 * 60 * 60
+
+      def next_rotate_time(now, shift_age)
+        case shift_age
+        when "daily"
+          t = Time.mktime(now.year, now.month, now.mday) + SiD
+        when "weekly"
+          t = Time.mktime(now.year, now.month, now.mday) + SiD * (7 - now.wday)
+        when "monthly"
+          t = Time.mktime(now.year, now.month, 1) + SiD * 32
+          return Time.mktime(t.year, t.month, 1)
+        when "now", "everytime"
+          return now
+        else
+          raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
+        end
+        if t.hour.nonzero? || t.min.nonzero? || t.sec.nonzero?
+          hour = t.hour
+          t = Time.mktime(t.year, t.month, t.mday)
+          t += SiD if hour > 12
+        end
+        t
+      end
+
+      def previous_period_end(now, shift_age)
+        case shift_age
+        when "daily"
+          t = Time.mktime(now.year, now.month, now.mday) - SiD / 2
+        when "weekly"
+          t = Time.mktime(now.year, now.month, now.mday) - (SiD * now.wday + SiD / 2)
+        when "monthly"
+          t = Time.mktime(now.year, now.month, 1) - SiD / 2
+        when "now", "everytime"
+          return now
+        else
+          raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
+        end
+        Time.mktime(t.year, t.month, t.mday, 23, 59, 59)
+      end
+    end
+  end
+end

data/lib/testa_logger/log_device.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require_relative "log_device/period"
+
+module TestaLogger
+  # Device used for logging messages.
+  class LogDevice
+    include Period
+    include MonitorMixin
+
+    attr_reader :dev, :filename
+
+    def initialize(log, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, before_shift: nil)
+      @dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
+      @before_shift = before_shift
+      @binmode = binmode
+      mon_initialize
+      set_dev(log)
+
+      return unless @filename
+
+      @shift_age = shift_age || 7
+      @shift_size = shift_size || 1_048_576
+      @shift_period_suffix = shift_period_suffix || "%Y%m%d"
+
+      return if @shift_age.is_a?(Integer)
+
+      base_time = @dev.respond_to?(:stat) ? @dev.stat.mtime : Time.now
+      @next_rotate_time = next_rotate_time(base_time, @shift_age)
+    end
+
+    def write(message)
+      synchronize do
+        if @shift_age && @dev.respond_to?(:stat)
+          begin
+            check_shift_log
+          rescue StandardError => e
+            warn("log shifting failed. #{e}")
+          end
+        end
+        begin
+          @dev.write(message)
+        rescue StandardError => e
+          warn("log writing failed. #{e}")
+        end
+      end
+    rescue SystemExit
+      exit 1
+    rescue Exception => e
+      warn("log writing failed. #{e}")
+    end
+
+    def close
+      synchronize do
+        @dev.close rescue nil
+      end
+    rescue SystemExit
+      exit 1
+    rescue Exception
+      @dev.close rescue nil
+    end
+
+    def reopen(log = nil)
+      # reopen the same filename if no argument, do nothing for IO
+      log ||= @filename if @filename
+      if log
+        synchronize do
+          if @filename && @dev
+            @dev.close rescue nil # close only file opened by Logger
+            @filename = nil
+          end
+          set_dev(log)
+        end
+      end
+      self
+    end
+
+    private
+
+    def set_dev(log)
+      if log.respond_to?(:write) && log.respond_to?(:close)
+        @dev = log
+        @filename = log.path if log.respond_to?(:path)
+      else
+        @dev = open_logfile(log)
+        @dev.sync = true
+        @dev.binmode if @binmode
+        @filename = log
+      end
+    end
+
+    def open_logfile(filename)
+      File.open(filename, (File::WRONLY | File::APPEND))
+    rescue Errno::ENOENT
+      create_logfile(filename)
+    end
+
+    def create_logfile(filename)
+      begin
+        logdev = File.open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+        logdev.flock(File::LOCK_EX)
+        logdev.sync = true
+        logdev.binmode if @binmode
+        add_log_header(logdev)
+        logdev.flock(File::LOCK_UN)
+      rescue Errno::EEXIST
+        # file is created by another process
+        logdev = open_logfile(filename)
+        logdev.sync = true
+      end
+      logdev
+    end
+
+    def add_log_header(file)
+      file.write(format("# Logfile created on %s\n", Time.now.to_s)) if file.size.zero?
+    end
+
+    def check_shift_log
+      if @shift_age.is_a?(Integer)
+        # NOTE: always returns false if '0'.
+        lock_shift_log { shift_log_age } if @filename && @shift_age.positive? && (@dev.stat.size > @shift_size)
+      else
+        now = Time.now
+        if now >= @next_rotate_time
+          @next_rotate_time = next_rotate_time(now, @shift_age)
+          lock_shift_log { shift_log_period(previous_period_end(now, @shift_age)) }
+        end
+      end
+    end
+
+    if /mswin|mingw/ =~ RUBY_PLATFORM
+      def lock_shift_log
+        yield
+      end
+    else
+      def lock_shift_log
+        retry_limit = 8
+        retry_sleep = 0.1
+        begin
+          File.open(@filename, File::WRONLY | File::APPEND) do |lock|
+            lock.flock(File::LOCK_EX) # inter-process locking. will be unlocked at closing file
+            if File.identical?(@filename, lock) && File.identical?(lock, @dev)
+              yield # log shifting
+            else
+              # log shifted by another process (i-node before locking and i-node after locking are different)
+              @dev.close rescue nil
+              @dev = open_logfile(@filename)
+              @dev.sync = true
+            end
+          end
+        rescue Errno::ENOENT => e
+          # @filename file would not exist right after #rename and before #create_logfile
+          if retry_limit <= 0
+            warn("log rotation inter-process lock failed. #{e}")
+          else
+            sleep retry_sleep
+            retry_limit -= 1
+            retry_sleep *= 2
+            retry
+          end
+        end
+      rescue StandardError => e
+        warn("log rotation inter-process lock failed. #{e}")
+      end
+    end
+
+    def shift_log_age
+      (@shift_age - 3).downto(0) do |i|
+        File.rename("#{@filename}.#{i}", "#{@filename}.#{i + 1}") if FileTest.exist?("#{@filename}.#{i}")
+      end
+      @dev.close rescue nil
+      @before_shift&.call(@filename.to_s)
+      File.rename(@filename.to_s, "#{@filename}.0")
+      @dev = create_logfile(@filename)
+      true
+    end
+
+    def shift_log_period(period_end)
+      suffix = period_end.strftime(@shift_period_suffix)
+      age_file = "#{@filename}.#{suffix}"
+      if FileTest.exist?(age_file)
+        # try to avoid filename crash caused by Timestamp change.
+        idx = 0
+        # .99 can be overridden; avoid too much file search with 'loop do'
+        while idx < 100
+          idx += 1
+          age_file = "#{@filename}.#{suffix}.#{idx}"
+          break unless FileTest.exist?(age_file)
+        end
+      end
+      @dev.close rescue nil
+      @before_shift&.call(@filename.to_s)
+      File.rename(@filename.to_s, age_file)
+      @dev = create_logfile(@filename)
+      true
+    end
+  end
+end

data/lib/testa_logger/logger/dispatcher.rb

@@ -0,0 +1,52 @@
+module TestaLogger
+  class Logger
+    class Dispatcher
+      def initialize(faye_url, faye_token, app, group, subgroup = nil)
+        @uri = URI.parse(faye_url)
+        @faye_token = faye_token
+        @channel = "/logs/live/#{app}/#{group}"
+        @channel += "/#{subgroup}" unless subgroup.nil?
+        @outbox = Concurrent::Array.new
+        run_dispatch_thread
+        at_exit { dispatch }
+      end
+
+      def push(level, time, tag, formatted_text)
+        data = {
+          level: level,
+          time: time,
+          tag: tag,
+          formatted_text: formatted_text,
+        }
+        @outbox << data
+      end
+
+      def run_dispatch_thread
+        Thread.new do
+          max_delay = 0.5
+          max_buffer = 20
+          last_sent = Time.now.to_f
+          loop do
+            sleep 0.1
+            next unless (last_sent + max_delay < Time.now.to_f) || @outbox.count > max_buffer
+
+            last_sent = Time.now.to_f
+            next if @outbox.count.zero?
+
+            dispatch
+          end
+        end
+      end
+
+      def dispatch
+        message = {
+          channel: @channel,
+          data: { logs: @outbox },
+          ext: { auth_token: @faye_token },
+        }
+        Net::HTTP.post_form(@uri, message: message.to_json)
+        @outbox.clear
+      end
+    end
+  end
+end

data/lib/testa_logger/logger/persistence.rb

@@ -0,0 +1,65 @@
+module TestaLogger
+  class Logger
+    module Persistence
+      def self.extended(base)
+        require "aws-sdk-s3"
+        base.init_s3_client
+      end
+
+      def init_s3_client
+        Aws.config.update(
+          region: options.s3_creds[:region],
+          credentials: Aws::Credentials.new(options.s3_creds[:access_key_id], options.s3_creds[:secret_access_key])
+        )
+        @s3 = Aws::S3::Client.new
+        at_exit { persist rescue false }
+      end
+
+      def persist_with_record(record, attachment_name)
+        raise IoPersistenceError if @log_device.is_a?(IO)
+
+        begin
+          # stop writing into log file with it is being attached, otherwise checksum integrity will fail.
+          write_thread["stop"] = true
+          record.send(attachment_name).attach(io: File.open(options.filepath), filename: "#{attachment_name}.log")
+        rescue StandardError => e
+          error(TAG, e)
+          raise
+        ensure
+          write_thread["stop"] = false
+          write_thread.run
+        end
+      end
+
+      def persist
+        return if @s3.nil?
+
+        begin
+          write_thread["stop"] = true
+
+          key = "logs/#{app}/#{group}"
+          key += "/#{subgroup}" unless subgroup.nil?
+
+          extension = File.extname(options.filepath)
+          filename = File.basename(options.filepath, extension)
+          time_string = Time.now.strftime("%H_%M_%S__%d_%m_%Y")
+          key += "/#{filename}_#{time_string}#{extension}"
+
+          # stop writing into log file with it is being attached, otherwise checksum integrity will fail.
+          response = @s3.put_object(
+            bucket: options.s3_creds[:bucket],
+            key: key,
+            body: IO.read(options.filepath)
+          )
+          error(TAG, "Failed to persist log file #{options.filepath}. Response: #{response.body}") unless response.etag
+        rescue StandardError => e
+          error(TAG, e)
+          raise
+        ensure
+          write_thread["stop"] = false
+          write_thread.run
+        end
+      end
+    end
+  end
+end

data/lib/testa_logger/logger.rb

@@ -0,0 +1,194 @@
+require_relative "logger/persistence"
+require_relative "logger/dispatcher"
+
+module TestaLogger
+  class Logger
+    TAG = "TestaLogger"
+
+    # @return [String]
+    attr_accessor :app, :group, :subgroup
+
+    # @return [OpenStruct]
+    attr_accessor :options
+
+    # @return [Thread]
+    attr_accessor :write_thread
+
+    # Low-level information, mostly for developers.
+    DEBUG = 0
+    # Generic (useful) information about system operation.
+    INFO = 1
+    # A warning.
+    WARN = 2
+    # A handleable error condition.
+    ERROR = 3
+    # An unhandleable error that results in a program crash.
+    FATAL = 4
+    # An unknown message that should always be logged.
+    UNKNOWN = 5
+
+    def initialize(app, group, subgroup = nil, options = {})
+      @app = app
+      @group = group
+      @subgroup = subgroup
+      handle_options(options)
+      create_log_file
+      setup_dispatcher
+      start_write_thread
+      self.extend Persistence if @options.persist
+    end
+
+    def handle_options(options)
+      options.deep_symbolize_keys!
+      @options = Logger.default_options
+      @options.shift_age = options[:shift_age] unless options[:shift_age].nil?
+      @options.level = options[:level] unless options[:level].nil?
+      @options.formatter = options[:formatter] unless options[:formatter].nil?
+      @options.live = options[:live] unless options[:live].nil?
+      @options.filepath = File.expand_path(options[:filepath]) unless options[:filepath].nil?
+      @options.tag_length = options[:tag_length] unless options[:tag_length].nil?
+      @options.persist = options[:persist] unless options[:persist].nil?
+      @options.faye_url = options[:faye_url] unless options[:faye_url].nil?
+      @options.faye_token = options[:faye_token] unless options[:faye_token].nil?
+      @options.s3_creds = options[:s3_creds].deep_symbolize_keys unless options[:s3_creds].empty?
+    end
+
+    def create_log_file
+      options.filepath = "/tmp/#{SecureRandom.uuid}.log" if options.filepath.nil?
+      FileUtils.mkdir_p(File.dirname(options.filepath))
+      before_shift = options.persist ? proc { persist } : nil
+      @log_device = LogDevice.new(options.filepath,
+                                  shift_age: options.shift_age,
+                                  shift_size: 1_048_576,
+                                  shift_period_suffix: "%d%m%Y",
+                                  binmode: false,
+                                  before_shift: before_shift)
+    end
+
+    def setup_dispatcher
+      @dispatcher = Dispatcher.new(
+        options.faye_url,
+        options.faye_token,
+        app,
+        group,
+        subgroup
+      )
+    end
+
+    def start_write_thread
+      # we must use this queue in order to be able to collect logs in trap context
+      @queue = Queue.new
+      @write_thread = Thread.new do
+        loop do
+          text = @queue.pop
+          Thread.stop if Thread.current["stop"]
+          @log_device.write(text)
+        end
+      end
+    end
+
+    def debug(tag, *args, &block)
+      add_log_to_queue(DEBUG, tag, args, &block)
+    end
+
+    def info(tag, *args, &block)
+      add_log_to_queue(INFO, tag, args, &block)
+    end
+
+    def warn(tag, *args, &block)
+      add_log_to_queue(WARN, tag, args, &block)
+    end
+
+    def error(tag, *args, &block)
+      add_log_to_queue(ERROR, tag, args, &block)
+    end
+
+    def fatal(tag, *args, &block)
+      add_log_to_queue(FATAL, tag, args, &block)
+    end
+
+    def unknown(tag, *args, &block)
+      add_log_to_queue(UNKNOWN, tag, args, &block)
+    end
+
+    class << self
+      def default_options
+        OpenStruct.new(
+          shift_age: "daily",
+          level: DEBUG,
+          formatter: default_formatter,
+          live: false,
+          filepath: nil,
+          tag_length: 13,
+          persist: true, # requires aws credentials set in env variables
+          faye_url: ENV["WEB_SOCKET_URL"],
+          faye_token: ENV["FAYE_TOKEN"],
+          s3_creds: {
+            region: ENV["AWS_REGION"],
+            access_key_id: ENV["AWS_ACCESS_KEY_ID"],
+            secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
+            bucket_name: ENV["S3_BUCKET_NAME"],
+          }
+        )
+      end
+
+      def default_formatter
+        proc do |severity, datetime, _, msg|
+          "[#{datetime.strftime('%Y-%m-%d %H:%M:%S.%L')}]  #{format('%-5.5s', severity)} -- : #{msg}\n"
+        end
+      end
+    end
+
+    private
+
+    def add_log_to_queue(level, tag, args, &block)
+      return if level < options.level
+
+      time = Time.now
+      text = create_log_string(tag, args, &block)
+      formatted_severity = format_severity(level)
+      formatted_text = format_message(formatted_severity, time, "", text)
+
+      @queue << formatted_text
+      @dispatcher.push(level, time, tag, formatted_text) if options.live
+    end
+
+    def create_log_string(tag, args, &block)
+      if args.count.zero?
+        if block.nil?
+          "[NO-TAG]: #{tag}"
+        else
+          "[#{padded_tag(tag)}]: #{args_to_string(block.call)}"
+        end
+      else
+        "[#{padded_tag(tag)}]: #{args_to_string(args)}"
+      end
+    end
+
+    def padded_tag(tag)
+      format("%-#{options.tag_length}.#{options.tag_length}s", tag)
+    end
+
+    def args_to_string(args)
+      args = [args] unless args.respond_to?(:map)
+      args.map do |arg|
+        if arg.instance_of?(String)
+          arg
+        else
+          arg.ai(limit: 1000, plain: true)
+        end
+      end.join("\n")
+    end
+
+    # Severity label for logging (max 5 chars).
+    SEV_LABEL = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
+
+    def format_severity(severity)
+      SEV_LABEL[severity] || "UNKNOWN"
+    end
+
+    def format_message(severity, datetime, progname, msg)
+      options.formatter.call(severity, datetime, progname, msg)
+    end
+  end
+end

data/lib/testa_logger/version.rb

@@ -0,0 +1,3 @@
+module TestaLogger
+  VERSION = "0.1.0"
+end

data/lib/testa_logger.rb

@@ -0,0 +1,29 @@
+require_relative "testa_logger/version"
+require_relative "testa_logger/log_device"
+require_relative "testa_logger/logger"
+require_relative "testa_logger/io_persistence_error"
+require "active_support"
+require "active_support/core_ext/hash"
+require "ostruct"
+require "awesome_print"
+require "concurrent-ruby"
+require "json"
+require "uri"
+require "net/http"
+
+module TestaLogger
+  # @param [String] app name of the application, i.e. rails, ws, dj, filewatcher
+  # @param [String] group category under the application, i.e. in rails (branch_version_job, import_job)
+  # @param [String, nil] subgroup optional, sub category under group, i.e. in dj group play (scenario_25, group_2)
+  # @param [Hash] options
+  def self.new(app, group, subgroup = nil, options = {})
+    Logger.new(app, group, subgroup, options)
+  end
+
+  # Patch exception logging
+  class ::Exception
+    def ai(options = {})
+      "Message: #{self.message}\nClass: #{self.class.name}\nBacktrace:\n#{self.backtrace.ai(options)}"
+    end
+  end
+end

data/logger.iml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="RVM: ruby-2.7.6" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.6.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="awesome_print (v1.9.2, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-eventstream (v1.2.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-partitions (v1.614.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-sdk-core (v3.131.5, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-sdk-kms (v1.58.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-sdk-s3 (v1.114.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aws-sigv4 (v1.5.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.14, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.12.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="jmespath (v1.6.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v2.6.2, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.16.2, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ostruct (v0.2.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.4, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.5.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.26.1, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.21.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-rails (v2.15.2, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="securerandom (v0.2.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.5, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.2.0, RVM: ruby-2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.6.0, RVM: ruby-2.7.6) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build testa_logger-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if testa_logger-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install testa_logger-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install testa_logger-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push testa_logger-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/testa_logger.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/testa_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "testa_logger"
+  spec.version       = TestaLogger::VERSION
+  spec.authors       = ["karlo.razumovic"]
+  spec.email         = ["karlo.razumovic@gmail.com"]
+
+  spec.summary       = %q{Customized logger}
+  spec.description   = %q{Customized logger that can log while in trap context and broadcast logs to websocket}
+  # spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "awesome_print"
+  spec.add_runtime_dependency "aws-sdk-s3"
+  spec.add_runtime_dependency "concurrent-ruby"
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "ostruct"
+  spec.add_runtime_dependency "securerandom"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: testa_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- karlo.razumovic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Customized logger that can log while in trap context and broadcast logs
+  to websocket
+email:
+- karlo.razumovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testa_logger.rb
+- lib/testa_logger/io_persistence_error.rb
+- lib/testa_logger/log_device.rb
+- lib/testa_logger/log_device/period.rb
+- lib/testa_logger/logger.rb
+- lib/testa_logger/logger/dispatcher.rb
+- lib/testa_logger/logger/persistence.rb
+- lib/testa_logger/version.rb
+- logger.iml
+- testa_logger.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Customized logger
+test_files: []