dclog 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 372c2975c0f10052f985877816b66e9f00655e23d22eb0a42711a1c5900acd02
-  data.tar.gz: 621591b55ce509bf61b00e9c590d5633766518ed30e0a703552b0aeb89c07922
+  metadata.gz: 9ec22cd08745dd9e72fcb5d9dcbd5a8778b4891a51051bd0c7c365790b55a8e1
+  data.tar.gz: f7120064c66f80d66ea22d35548561609771eccbbc03b15a46c640e7f6e621f6
 SHA512:
-  metadata.gz: fc462363942b62e6ca648379d9a4bf82f9329c67a14231450e96745d4369b05a7f9794eb0075e390009a85276bb9a6fb246d300817881353daff99d79b618a3e
-  data.tar.gz: 8e97ef06b48a428cc81af5395cbe2e412d3e0aba22621236d4739e3d4b4b1176b3bd9ce7d9f82cf647e81d3c28219fcc836f46470282e3b16ca853add68ab187
+  metadata.gz: b9396325d1ebfe73e11f53ea32344f170c245b97738db9047b590320210fc6cec58608800b427bcf2ac9b23f4594ccb788aaf7af20ecdb44a11a87ca06597ad8
+  data.tar.gz: da63e6c0e9abf1912aaed55906ab159e57c2282673f6dc520a0afcb8fb562ecfddaf794a1f45455bad2cbd6be76041fb1e68e87a3fad285b0c206f682b23b227

data/.rubocop.yml

@@ -23,3 +23,6 @@ Metrics/BlockLength:
 
 Style/StringConcatenation:
   Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## 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 [INSERT EMAIL ADDRESS]. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dclog (0.2.0)
+    dclog (0.3.0)
       rails (>= 5.0.0)
 
 GEM
@@ -73,21 +73,21 @@ GEM
     diff-lcs (1.4.4)
     docile (1.4.0)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.1)
     minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.11.7-x86_64-linux)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.1.1)
@@ -114,7 +114,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     railties (6.1.4.1)
       actionpack (= 6.1.4.1)

data/README.md

@@ -29,17 +29,16 @@ Rails.application.configure do
   ...
 
   logger = ActiveSupport::Logger.new($stdout)
-  logger.formatter = proc do |severity, datetime, progname, message|
-    "#{JSON.dump(
-      severity: severity,
-      date: datetime.strftime('%Y-%m-%d %H:%M:%S'),
-      caller: progname,
-      message: message
-    )}\n"
-  end
+  logger.formatter = Dclog::LogFormatter.new
   config.logger    = ActiveSupport::TaggedLogging.new(logger)
+
   level            = ENV.fetch('LOG_LEVEL', 'info')
   config.log_level = Rails.env.test? ? :warn : level.underscore.to_sym
+
+  # add silencers for useless logs (optional)
+  # config.logger.formatter.add_silencer { |line| line =~ /\/sidekiq/ }
+  # config.logger.formatter.add_silencer { |line| line =~ /\/app_health/ }
+
   config.log_tags  = [:request_id]
 
   ...

data/dclog.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'dclog'
   spec.version       = Dclog::VERSION
   spec.authors       = ['Jairo Junior', 'Matheus Acosta', 'Vinicius Machado']
-  spec.email         = ['jairo.junior@deliverycenter.com', 'matheus.martins@deliverycenter.com',
+  spec.email         = ['jairo.junior@deliverycenter.com', 'matheusthebr@gmail.com',
                         'vinicius.santana@deliverycenter.com']
 
   spec.summary       = 'A logger'

data/lib/dclog/formatter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Dclog::Formatter
+  LOG_REGEX = /^\[([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})\]\s+(.+)$/.freeze
+
+  def initialize
+    @silencers = []
+  end
+
+  def add_silencer(&block)
+    @silencers << block
+  end
+
+  def call(severity, timestamp, progname, message)
+    return if should_filter?(message)
+
+    msg_regex = message.match(LOG_REGEX)
+    request_id = msg_regex.nil? ? nil : msg_regex[1]
+    msg = msg_regex.nil? ? message : msg_regex[2]
+
+    "#{JSON.dump(
+      severity: severity,
+      date: timestamp.strftime("%Y-%m-%d %H:%M:%S"),
+      caller: progname,
+      request_id: request_id,
+      message: msg
+    )}\n"
+  end
+
+  private
+
+  def should_filter?(message)
+    return false if @silencers.empty?
+
+    @silencers.each { |silencer| return true if silencer.call(message) }
+
+    false
+  end
+end

data/lib/dclog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dclog
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/dclog.rb

@@ -2,11 +2,12 @@
 
 require 'rails'
 require_relative 'dclog/version'
+require_relative 'dclog/formatter'
 
 begin
   require 'sidekiq'
 rescue LoadError
-  Rails.logger.info('The Sidekiq gem is not installed')
+  puts 'The Sidekiq gem is not installed'
 end
 
 module Dclog
@@ -29,7 +30,7 @@ module Dclog
     end
 
     def raise_no_method_error!(severity)
-      raise NoMethodError, "undefined method '#{severity}' for Log:Class"
+      raise NoMethodError, "undefined method '#{severity}' for Dclog:Class"
     end
 
     def log_to_stdout(severity, caller, message)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dclog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jairo Junior
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -72,7 +72,7 @@ description: A gem to format logs to json, and run one commando to log into side
   and rails
 email:
 - jairo.junior@deliverycenter.com
-- matheus.martins@deliverycenter.com
+- matheusthebr@gmail.com
 - vinicius.santana@deliverycenter.com
 executables: []
 extensions: []
@@ -82,6 +82,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -91,6 +92,7 @@ files:
 - bin/setup
 - dclog.gemspec
 - lib/dclog.rb
+- lib/dclog/formatter.rb
 - lib/dclog/version.rb
 homepage: https://github.com/deliverycenter/dclog
 licenses: