ant-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79e7fb8ef1bfebac41fd2efbf61449eddc677710fb7fcd8770d13f0b7bfa675f
+  data.tar.gz: 2c6616ad37a49a6711da08408e4a099a3f4f311b4b3680c5ff4cb0caac43e0c5
+SHA512:
+  metadata.gz: dd89dc3c61ec1b3230f03eaae55ff24cb766b996fa5bcfeea62ccab39cbc9fd75cd515c4313d3caf978485e5ea24c0c403a89e4e2de878e644da80f3075cc900
+  data.tar.gz: 49aa287b29c47a848bc47210538cae54a38ef559c70fbeb420b45c3419b3e84851a3b4b01f8eaf36d775005833ac5e350f0979aee5d77524004578c5d38608a6

data/lib/ant/log_decorator.rb

@@ -0,0 +1,13 @@
+require 'ant/core'
+require 'json'
+
+require_relative 'logger/config'
+require_relative 'logger/format'
+require_relative 'logger/log_methods'
+
+
+module Ant
+  module Logger
+    include LogMethods
+  end
+end

data/lib/ant/logger.rb

@@ -0,0 +1 @@
+require_relative 'log_decorator'

data/lib/ant/logger/config.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require_relative 'format'
+
+module Ant
+  module Logger
+    class Config
+      include Ant::DRY::ResourceInjector
+      include Ant::Logger::Format
+      SEVERITIES = {
+        'debug' => ::Logger::DEBUG,
+        'info' => ::Logger::INFO,
+        'warn' => ::Logger::WARN,
+        'error' => ::Logger::ERROR,
+        'fatal' => ::Logger::FATAL
+      }.freeze
+
+      def self.from_config(config)
+        new(config)
+      end
+
+      def initialize(config)
+        @original_config = config
+        register('file', config['file'] || 'application.log')
+        register('rotate_days', config['rotate_days'] || 7)
+        register('rotate_size', config['rotate_size'] || 100 * 1024**2) # 100Mb
+        register('date_format', config['date_format'] || '%Y-%m-%d %H:%M:%S')
+        register('severity', config['severity'] || 'info')
+        register('log_format', config['log_format'] ||
+                 "%time,%sev,%pid,%tid,%mod,%json\n")
+        register('blacklist', config['blacklist'] || %w[pass password])
+        register('logger', logger)
+      end
+
+      def logger
+        @logger ||= begin
+          logger = ::Logger.new(
+            resource('file'),
+            resource('rotate_days'),
+            resource('rotate_size')
+          )
+          logger.sev_threshold = SEVERITIES[resource('severity')]
+          logger.datetime_format = resource('date_format')
+          logger.formatter = format_builder(resource('log_format'))
+          logger
+        end
+      end
+
+      def merge_params(msg, data, debug, severity)
+        blacklist = resource('blacklist') + ['debug']
+        params = {}
+        data.each { |k, v| params[k] = v unless blacklist.include?(k.to_s) }
+        params[:debug] = debug if resource('severity') == 'debug'
+        [msg, params]
+      end
+    end
+  end
+end

data/lib/ant/logger/format.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Ant
+  module Logger
+    module Format
+      # Format params:
+      # - %time
+      # - %sev
+      # - %pid
+      # - %tid
+      # - %module: won't work well on singleton classes. Prints the name of the
+      #            invoking module
+      # - %json: Data object encoded as json
+      # default format:
+      #   "%time,%sev,%pid,%tid,%module,%json"
+      def format_builder(format_string)
+        proc do |frmt, sev, time, mod, data|
+          meta = {
+            '%sev': sev,
+            '%time': time,
+            '%mod': mod,
+            '%pid': Process.pid.to_s(16),
+            '%tid': Thread.current.object_id.to_s(16)
+          }
+          entry = frmt.dup
+          meta.each { |k, v| entry.gsub!(k.to_s, v.to_s) }
+          # json is slower than the meta records, so it is better to replace
+          # in a lazy way.
+          # TODO: Move lazy tags to a pluggin-based model.
+          entry.gsub('%json', data.to_json) if frmt.include?('%json')
+        end.curry.call(format_string)
+      end
+    end
+  end
+end

data/lib/ant/logger/log_methods.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Ant
+  module Logger
+    module LogMethods
+      extend Ant::DRY::ResourceInjector
+
+      def self.global_config
+        LogMethods.resource(:global_config)
+      end
+
+      def self.global_config=(config)
+        LogMethods.register(:global_config, config)
+      end
+
+      def log_info(msg, data = {})
+        log_raw(:info, msg, data, data[:debug])
+      end
+
+      def log_warn(msg, data = {})
+        log_raw(:warn, msg, data, data[:debug])
+      end
+
+      def log_error(msg, data = {})
+        log_raw(:error, msg, data, data[:debug])
+      end
+
+      def log_fatal(msg, data = {})
+        log_raw(:fatal, msg, data, data[:debug])
+      end
+
+      def log_debug(msg, data = {})
+        log_raw(:debug, msg, data)
+      end
+
+      def log_metric(metric:, amount:, group: nil, time: nil)
+        log_info('Metric', metric: metric, value: amount,
+                           group: group, time: time)
+      end
+
+      def log_alert(description:, tagging_group:, tagging_sev:, tagging_org:)
+        log_fatal('Alert Triggered',
+                  description: description,
+                  group: tagging_group,
+                  severity: tagging_sev,
+                  response_team: tagging_org)
+      end
+
+      def log_raw(severity, msg, data, debug = {})
+        sev = Config::SEVERITIES[severity.to_s]
+        meta = config.merge_params(msg, data, debug, severity)
+        config.logger.add(sev, meta, self.class.name)
+      end
+
+      def config
+        self.class.respond_to?(:resource) ? self.class.resource(:log_config) : LogMethods.global_config
+      rescue StandardError => _e
+        global_config
+      end
+
+      LogMethods.global_config = Config.from_config({})
+    end
+  end
+end

data/lib/ant/logger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ant
+  module Logger
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ant-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gilberto Vargas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ant-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make logs formatter and handling easier
+email:
+- tachoguitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ant/log_decorator.rb
+- lib/ant/logger.rb
+- lib/ant/logger/config.rb
+- lib/ant/logger/format.rb
+- lib/ant/logger/log_methods.rb
+- lib/ant/logger/version.rb
+homepage: https://github.com/tachomex/ant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Implements a ant-logger with a format based on cute_logger
+test_files: []