researchable_loggable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b483e9b1dcee65ba39a14ee62c76b0f81a92751ca755072bcae1c45c84954bb
+  data.tar.gz: c2de92b359b3d87bda96673eee61d141641a52e5e264f691f453f7800f01bd12
+SHA512:
+  metadata.gz: 45d49f54d2b674d2f5e0e23fd659f7b2ae988732e5261a5070c529b4ed959aadc7c47b36a91078bc10d8edaef272a7a73d0abaa610c3b4c41dd01518e4715cc8
+  data.tar.gz: 7468411333b7e4d7014c29dc825e23a54902af8a895629b99ab09817cdedab2fddb668ca54108597bea3e494049356dce38df0d66e4dbdc41ee302d07e81dedc

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  ruboguide:
+    - styles/rubocop-rails.yml

data/.ruby-gemset

@@ -0,0 +1 @@
+loggable

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [1.0.1](https://gitlab.com/researchable/general/gems/loggable/compare/v1.0.0...v1.0.1) (2023-03-08)
+
+
+### Bug Fixes
+
+* **formatter:** undefined method merge for nil:NilClass ([1e110a0](https://gitlab.com/researchable/general/gems/loggable/commit/1e110a090d0c22ab8738a177d775c1f8146f6f2a))
+
+# 1.0.0 (2023-03-08)
+
+
+### Features
+
+* loggable gem ([fbda454](https://gitlab.com/researchable/general/gems/loggable/commit/fbda4541ab6a67c9ef397845282614655d4ae092))

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loggable.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+# TODO: remove ref once first implementation has been merged to master
+gem 'ruboguide', git: 'https://gitlab.com/researchable/general/gems/ruboguide'
+
+gem 'ecs-logging', '~> 1.0'
+gem 'lograge'
+gem 'logstash-event'

data/Gemfile.lock

@@ -0,0 +1,143 @@
+GIT
+  remote: https://gitlab.com/researchable/general/gems/ruboguide
+  revision: fd7b55c93c3ebfe63aed5cb7e5c9c38bd4a45020
+  specs:
+    ruboguide (0.1.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+      rubocop-rails (= 2.12.4)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.6.0)
+
+PATH
+  remote: .
+  specs:
+    researchable_loggable (1.0.0)
+      ecs-logging (~> 1.0)
+      lograge
+      logstash-event
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.2)
+      actionview (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.0)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    ecs-logging (1.0.0)
+    erubi (1.12.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    lograge (0.12.0)
+      actionpack (>= 4)
+      activesupport (>= 4)
+      railties (>= 4)
+      request_store (~> 1.0)
+    logstash-event (1.2.02)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    nokogiri (1.14.1-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ecs-logging (~> 1.0)
+  lograge
+  logstash-event
+  rake (~> 13.0)
+  researchable_loggable!
+  rspec (~> 3.0)
+  ruboguide!
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mario Rios
+
+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,99 @@
+# Loggable
+
+Loggable is Researchable's gem to standardize how we do logging on Ruby on Rails applications.
+
+## What it does
+
+Loggable configures how your Rails applications outputs and formats logs, in a way that is easy to export and understand
+by the elastic stack. Specifically it does the following:
+
+1. Configures logs to be printed to stdout, so the elastic agent can read them.
+2. Formats logs using the [ecs standard](https://www.elastic.co/guide/en/ecs/current/index.html).
+3. Uses [lograge](https://github.com/roidrage/lograge) to improve how request logging is done.
+4. Enables log-correlation for the elastic apm.
+
+After adding this gem, your (production) logs will go from looking like this:
+```
+Started GET "/api/v1/profiles/my?hola=adiosa" for 172.19.0.1 at 2023-02-21 12:48:48 +0000
+Processing by Api::V1::ProfilesController#my as */*
+  Parameters: {"hola"=>"adiosa"}
+Completed 401 Unauthorized in 11ms (ActiveRecord: 0.0ms | MongoDB: 0.0ms | Allocations: 3355)
+```
+
+to looking like this:
+```
+{"@timestamp":"2023-02-21T13:11:56.457Z","log.level":"INFO","message":"method=GET path=/api/v1/profiles/my format=*/* controller=Api::V1::ProfilesController action=my status=200 duration=11.54 view=0.00 db=0.00 unpermitted_params=[\"hola\"] params={\"hola\"=>\"adiosa\"}","ecs.version":"1.4.0","source.ip":"172.19.0.1","user.id":null,"http.code":"200"}
+```
+
+While slightly less human readable, this is meant to be used along with a log aggregator that will display it in a
+readable form. Development logs remain unaffected (see [Usage](#usage) for more on this).
+
+## How it works
+Loggable is a Railtie that overrides the default rails logger configuration. Right from the initialization process, the
+logger is set to `::EcsLogging::Logger` and the default log level is set to `INFO` (this can be overridden in 
+application.rb or your environment configuration). It also configures lograge automatically. Note that the 
+base_controller_class is set to `'ApplicationController'`. All your controllers should extend from this class.
+
+By default lograge and ::EcsLogging::Logger are not mutually compatible. The ECS formatter will try to render the output
+of lograge as the message, however some of the fields in the lograge output are metadata. To fix this, this gem uses a 
+monkey patch on the ECS gem that flattens the lograge output onto the Ecs object.
+
+## Installation
+Add this to your Gemfile (replace the tag with your intended one):
+```ruby
+gem 'loggable', git: 'https://gitlab.com/researchable/general/gems/loggable'
+```
+
+Additionally, if you want to be able to correlate logs with Elastic's APM traces, you may also add the elastic apm gem:
+```ruby
+gem 'elastic-apm'
+```
+
+Then execute:
+```bash
+$ bundle install
+```
+
+If loggable detects the presence of this gem, it will inject `transaction.id`, `span.id` and `trace.id` to the log line.
+
+## Usage
+
+For a brand new Rails application, adding this gem to the Gemfile should be all the configuration that is needed. This
+gem will automatically configure the Rails logger and lograge to follow the Researchable standard.
+
+There is only one parameter that is configurable, and that is `production_like`. By default loggable will only 
+modify how the logs look on production. This is because the format that this gem enforces is slightly less 
+human readable (in favour of machine readability and compatibility with the Elastic Common Schema) than the default 
+Rails one. For development, the more human readable format is preferred. However, if you want to override this and
+log in the production format while on development (e.g. because you are troubleshooting a problem with the logs or you 
+are developing against this gem) then you may add the following to your `config/environment/development.rb` file:
+```ruby
+config.loggable.production_like = true
+```
+
+No other configuration options are provided because this gem seeks to enforce consistency across all applications.
+
+For applications that already had some level of log customization, some cleanup might be needed:
+
+1. If lograge was added to the Gemfile already, it may be removed. Loggable relies on lograge internally, and will 
+   make it available to the Rails application.
+2. Consequently, remove `config/lograge.rb` and all lograge related configuration.
+3. Remove all existing log configuration, specially for production environments. Places to look for this 
+   configuration are `config/application.rb` and `config/environment/production.rb`. If you chose to enable 
+   `production_like` mode on your development environment, you might also want to cleanup 
+   `config/environment/development.rb`. Things to look for when cleaning up are statements like `config.logger` and 
+   `config.log_formatter` and anything with the word `log` or `logger` in it.
+
+## Development
+
+This gem is a Railtie, and it's meant to be run under a Rails project. The easiest way to develop and test this gem is
+to add it to your Rails project locally by adding this to your Rails Gemfile:
+```ruby
+gem 'loggable', path: "<your local path to the loggable gem you're developing against>"
+```
+If your Rails application is being executed by a docker container, then map the local gem repository to a directory in
+the container through a volume, and add the path of the volume to the Gemfile statement instead.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/loggable/ecs_logging/formatter_monkey_patch.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'ecs_logging/formatter'
+
+module Loggable
+  module EcsLogging
+    # A monkey patch to the ::EcsLogging::Formatter to customize how messages from lograge are rendered
+    module FormatterMonkeyPatch
+      def call(severity, time, progname, msg, **extras)
+        base = {
+          '@timestamp': time.utc.iso8601(3),
+          'log.level': severity,
+          message: msg,
+          'ecs.version': '1.4.0'
+        }
+
+        base['log.logger'] = progname if progname
+
+        base.merge!(msg.except(:lograge)) if msg.is_a?(Hash) && msg.key?(:lograge)
+        base.merge!(extras) if extras
+
+        "#{JSON.fast_generate(base)}\n"
+      end
+
+      class << self
+        def apply_patch
+          const = find_const
+          mtd = find_method(const)
+
+          # byebug
+          const.prepend(self) if const && mtd && mtd.arity == -5
+        end
+
+        private
+
+        def find_const
+          Kernel.const_get('::EcsLogging::Formatter')
+        rescue NameError
+          puts '[WARN] ::EcsLogging::Formatter not found. Patch could not be applied.' # rubocop:disable Rails/Output
+        end
+
+        def find_method(const)
+          return unless const
+
+          method_name = :call
+          const.instance_method(method_name)
+        rescue NameError
+          puts "[WARN] '#{method_name}' method not found in '#{const}'. Patch could not be applied." # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end
+
+Loggable::EcsLogging::FormatterMonkeyPatch.apply_patch

data/lib/loggable/lograge/formatter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'lograge'
+require 'active_support/core_ext/array'
+
+module Loggable
+  module Lograge
+    # Custom formatter class that renders logs as ruby objects with just the ecs fields generated by the logger, the
+    # message, and a lograge flag so the ECS logger knows to process this further before rendering
+    class Formatter < ::Lograge::Formatters::KeyValue
+      def call(data)
+        (data[:ecs] || {}).merge(message: super(data), lograge: true)
+      end
+
+      protected
+
+      def fields_to_display(data)
+        data.keys.excluding(%i[ecs])
+      end
+    end
+  end
+end

data/lib/loggable/railtie.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'ecs_logging/logger'
+require 'rails'
+
+module Loggable
+  # Railtie to configure logging before rails starts
+  class Railtie < Rails::Railtie
+    # We add a new loggable namespace to the config object, to keep all the configuration related to this gem organized
+    config.loggable = ActiveSupport::OrderedOptions.new
+    config.loggable.production_like = false
+
+    # Initializer runs before initialize_logger (found in Bootstrap) so from the very beginning we are logging using
+    # the ecs format, even during the initialization process
+    initializer :loggable_web, before: :initialize_logger do
+      Rails.application.configure do
+        production_like = Rails.env.production? || config.loggable.production_like
+        if production_like
+          Rails.logger = ::EcsLogging::Logger.new($stdout)
+          Rails.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
+        end
+
+        # lograge configuration
+        config.lograge.enabled = true
+        config.lograge.base_controller_class = 'ApplicationController'
+        config.lograge.custom_payload do |controller|
+          response_code = controller.response.code
+          {
+            ecs: {
+              'source.ip': controller.request.ip,
+              'user.id': controller.current_user.try(:id),
+              'http.code': response_code
+            },
+            status: response_code
+          }
+        end
+        config.lograge.custom_options = lambda do |event|
+          exceptions = %w[controller action format id]
+          { params: event.payload[:params].except(*exceptions) }
+        end
+        config.lograge.formatter = Loggable::Lograge::Formatter.new if production_like
+      end
+    end
+
+    initializer :loggable_worker, before: :initializer_logger do
+      Rails.application.configure do
+        if defined?(Delayed::Worker)
+          if Rails.env.production? || config.loggable.production_like
+            Delayed::Worker.logger = ::EcsLogging::Logger.new($stdout)
+            Delayed::Worker.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
+          else
+            Delayed::Worker.logger = Logger.new($stdout)
+            Delayed::Worker.logger.level = Logger::DEBUG
+            Delayed::Worker.logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/loggable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Loggable
+  VERSION = '1.0.1'
+end

data/lib/loggable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'loggable/version'
+require_relative 'loggable/railtie' if defined?(Rails::Railtie)
+require_relative 'loggable/ecs_logging/formatter_monkey_patch'
+require_relative 'loggable/lograge/formatter'
+
+module Loggable
+  class Error < StandardError
+  end
+end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/invalid-version-file/lib/test-gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestGem
+  SOME_CONST = '1.1.2'
+end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestGem
+  VERSION = '0.1.0.alpha.1'
+end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestGem
+  VERSION = '1.0.1'
+end

data/sig/loggable.rbs

@@ -0,0 +1,4 @@
+module Loggable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: researchable_loggable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Researchable
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ecs-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  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: logstash-event
+  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: |2
+      Researchable's Loggable relies on lograge and elastic's ecs format to log events in a way that is easy to ingest by
+      logstash. This enables log correlation with traces across multiple services.
+email:
+- info@researchable.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/loggable.rb
+- lib/loggable/ecs_logging/formatter_monkey_patch.rb
+- lib/loggable/lograge/formatter.rb
+- lib/loggable/railtie.rb
+- lib/loggable/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/invalid-version-file/lib/test-gem/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
+- sig/loggable.rbs
+homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/README.md
+  source_code_uri: https://gitlab.com/researchable/general/gems/loggable
+  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Researchable's gem to standardize logging on all Rails applications.
+test_files: []