ougai-json-logger 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8e366fc317576fefc223811746c6dbc59e0451d8555c18f1a35948c2faab588
+  data.tar.gz: 2e4a08093ad49c4aad8b191eb6bc964a68ce0291edd07b6766649047c5640232
+SHA512:
+  metadata.gz: 2f2ccc32ea532cfe98a09c36e96246d05cba32eb23ba1c3618cac22b350ee016e15a33fe87e6f90800f59bbaeae1e8dd2a0e9003942c3e7a8956d82a463183ea
+  data.tar.gz: 9b911e113fb1467b85ba934b741b8bcabdd4147b176d67b7125db123eb65a1595319b6131eaa664c57058cf07b17813b44b8413dd0837d6381efefa7719efdb6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 Jack.Wu
+
+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,54 @@
+#Ougai Json Logger
+To ensure consistency in log formatting across your Rails services, using a JSON logger is often necessary, especially when working with log services such as Kibana. This gem provides a pre-defined JSON logging format specifically tailored for Rails applications. By adding this gem to your Gemfile, you can achieve the desired log consistency across your Rails services effortlessly.
+
+
+## Usage
+A JSON logger for Rails, this logger is built upon lograge and ougai. It functions as a Rails engine and works seamlessly without any additional configuration. Simply adding it as a gem is sufficient to enable its functionality.
+
+What it does:
+```ruby
+  initializer(:rails_stdout_logging, before: :initialize_logger) do
+    Rails.application.configure do
+      config.logger = OugaiJson::Logger.custom_logger(name: 'Rails')
+
+      config.lograge.enabled = true
+      config.colorize_logging = false
+
+      config.lograge.formatter = Lograge::Formatters::Raw.new
+      config.lograge.custom_options = OugaiJson::Loggger::CustomOptions
+    end
+  end
+```
+
+Log output
+```
+{"@timestamp":"2024-02-28T09:07:58.098Z","message":"  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT \"schema_migrations\".\"version\" FROM \"schema_migrations\" ORDER BY \"schema_migrations\".\"version\" ASC","log":{"level":"DEBUG","logger":"Rails"},"trace":{"id":null},"error":{},"request":{},"response":{},"process":{"id":45821},"url":{},"event":{}}
+{"@timestamp":"2024-02-28T09:07:58.121Z","message":"  Rendering /Users/jawu/.rbenv/versions/3.3.0/lib/ruby/gems/3.3.0/gems/railties-7.1.3.2/lib/rails/templates/rails/welcome/index.html.erb","log":{"level":"DEBUG","logger":"Rails"},"trace":{"id":null},"error":{},"request":{},"response":{},"process":{"id":45821},"url":{},"event":{}}
+{"@timestamp":"2024-02-28T09:07:58.122Z","message":"Rails Request","log":{"level":"INFO","logger":"Rails"},"trace":{"id":null},"error":{},"request":{"method":"GET","body":{"content":"{\"controller\"=>\"rails/welcome\", \"action\"=>\"index\"}"}},"response":{"status_code":200},"process":{"id":45821},"url":{"path":"/"},"event":{"action":"Rails::WelcomeController#index","duration":6.79}}
+{"@timestamp":"2024-02-28T09:07:59.588Z","message":"  Rendering /Users/jawu/.rbenv/versions/3.3.0/lib/ruby/gems/3.3.0/gems/railties-7.1.3.2/lib/rails/templates/rails/welcome/index.html.erb","log":{"level":"DEBUG","logger":"Rails"},"trace":{"id":null},"error":{},"request":{},"response":{},"process":{"id":45821},"url":{},"event":{}}
+{"@timestamp":"2024-02-28T09:07:59.588Z","message":"Rails Request","log":{"level":"INFO","logger":"Rails"},"trace":{"id":null},"error":{},"request":{"method":"GET","body":{"content":"{\"controller\"=>\"rails/welcome\", \"action\"=>\"index\"}"}},"response":{"status_code":200},"process":{"id":45821},"url":{"path":"/"},"event":{"action":"Rails::WelcomeController#index","duration":1.82}}
+```
+
+
+## Installation
+Adding this gem to your Gemfile is all that is required. It is based on a Rails engine and will automatically initialize itself upon startup.
+
+Presently, there is support for custom hooks. However, if you prefer to make modifications to the formatter in the gem, you can do so by copying it to your lib folder and making the desired changes according to your requirements.
+
+
+```ruby
+gem 'ougai-json-logger'
+
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Contributing
+Contribution directions go here.
+
+## 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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OugaiJson::Logger'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/json_logger_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/json/logger .js
+//= link_directory ../stylesheets/json/logger .css

data/app/assets/javascripts/json/logger/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/json/logger/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/json/logger/application_controller.rb

@@ -0,0 +1,7 @@
+module OugaiJson
+  module Logger
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/helpers/json/logger/application_helper.rb

@@ -0,0 +1,6 @@
+module OugaiJson
+  module Logger
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/json/logger/application_job.rb

@@ -0,0 +1,6 @@
+module OugaiJson
+  module Logger
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/json/logger/application_mailer.rb

@@ -0,0 +1,8 @@
+module OugaiJson
+  module Logger
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/json/logger/application_record.rb

@@ -0,0 +1,7 @@
+module OugaiJson
+  module Logger
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/layouts/json/logger/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>OugaiJson logger</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "json/logger/application", media: "all" %>
+  <%= javascript_include_tag "json/logger/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/tagged_logging.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module TaggedLogging
+    # Patch to apply structured tags to Tagged Logs
+    module Formatter
+      def call(severity, timestamp, progname, data)
+        super(severity, timestamp, progname, merged_tags.merge!(data))
+      end
+
+      private
+
+      def merged_tags
+        tags = {}
+
+        current_tags.each do |tag|
+          tags.merge!(tag) if tag.is_a?(Hash)
+        end
+
+        tags
+      end
+    end
+  end
+end
+
+module Rails
+  module Rack
+    # Patch to compute structured tags for Tagged Logging
+    class Logger
+      private
+
+      def compute_tags(request)
+        {
+          trace_id: request.uuid
+        }
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+OugaiJson::Logger::Engine.routes.draw do
+end

data/lib/ougai_json/logger/custom_options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OugaiJson
+  module Loggger
+    module CustomOptions
+      class << self
+        def call(event)
+          items = {
+            msg: 'Rails Request',
+            params: event.payload[:params].as_json.to_s,
+            trace_id: event.payload[:headers]['HTTP_X_REQUEST_ID'],
+            error: event.payload[:exception_object]
+          }
+          items.merge({ headers: event.payload[:headers] }) if event.payload[:headers].present?
+        end
+      end
+    end
+  end
+end

data/lib/ougai_json/logger/engine.rb

@@ -0,0 +1,23 @@
+require 'lograge'
+require 'ougai_json/logger/custom_options'
+
+module OugaiJson
+  module Logger
+    class Engine < ::Rails::Engine
+      isolate_namespace OugaiJson::Logger
+
+      initializer(:rails_stdout_logging, before: :initialize_logger) do
+        Rails.application.configure do
+          config.logger = OugaiJson::Logger::Logger.custom_logger(name: 'Rails')
+
+
+          config.lograge.enabled = true
+          config.colorize_logging = false
+
+          config.lograge.formatter = Lograge::Formatters::Raw.new
+          config.lograge.custom_options = OugaiJson::Loggger::CustomOptions
+        end
+      end
+    end
+  end
+end

data/lib/ougai_json/logger/formatter.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OugaiJson
+  module Logger
+    class Formatter < Ougai::Formatters::Bunyan
+      def _call(severity, time, progname, data)
+        payload = base_fields(data, severity, time, progname)
+        payload[:error] = error_fields(data)
+        payload[:request] = request_fields(data)
+        payload[:response] = response_fields(data)
+        payload[:process] = process_fields(data)
+        payload[:url] = url_fields(data)
+        payload[:event] = event_fields(data)
+        dump(payload)
+      end
+
+      # Ougai::Formatters::ForJson requires this be present
+      def convert_time(data)
+        data[:@timestamp] = data[:@timestamp].utc.iso8601(3)
+      end
+
+      private
+
+      def base_fields(data, severity, time, progname)
+        {
+          :@timestamp => time,
+          message: data[:msg],
+          log: { level: severity, logger: progname || @app_name },
+          trace: { id: data[:trace_id] }
+        }
+      end
+
+      def error_fields(data)
+        return {} unless data[:error] || data[:err]
+
+        error = data[:err] || serialize_exc(data[:error])
+
+        {
+          message: error[:message],
+          stack_trace: error[:stack],
+          type: error[:name]
+        }.compact
+      end
+
+      def request_fields(data)
+        request = data.slice(:method, :params).merge(data.fetch(:request, {}))
+
+        {
+          method: request[:method],
+          body: ({ content: request[:params] } if request.key? :params)
+        }.compact
+      end
+
+      def response_fields(data)
+        response = data.slice(:status).merge(data.fetch(:response, {}))
+
+        {
+          status_code: response[:status],
+          body: ({ content: response[:params] } if response.key? :params),
+        }.compact
+      end
+
+      def process_fields(_data)
+        { id: Process.pid }
+      end
+
+      # url
+      def url_fields(data)
+        {
+          full: data.dig(:url, :full),
+          path: data[:path]
+        }.compact
+      end
+
+      # controller and action
+      def event_fields(data)
+        full_action = "#{data[:controller]}##{data[:action]}"
+
+        {
+          action: (full_action unless full_action == '#'),
+          duration: data[:duration]
+        }.compact
+      end
+    end
+
+  end
+end

data/lib/ougai_json/logger/logger.rb

@@ -0,0 +1,18 @@
+module OugaiJson
+  module Logger
+    class Logger < Ougai::Logger
+      def initialize(logdev, **)
+        super
+        @logdev = MonoLogger::LocklessLogDevice.new(logdev)
+      end
+
+      def create_formatter
+        return OugaiJson::Logger::Formatter.new
+      end
+
+      def self.custom_logger(name: '', level: Rails.logger.present? ? Rails.logger.level : MonoLogger::INFO, type: :ougai)
+        new($stdout, level: level, progname: name)
+      end
+    end
+  end
+end

data/lib/ougai_json/logger/version.rb

@@ -0,0 +1,5 @@
+module OugaiJson
+  module Logger
+    VERSION = '0.1.3'
+  end
+end

data/lib/ougai_json/logger.rb

@@ -0,0 +1,10 @@
+require 'ougai'
+require 'mono_logger'
+require 'ougai_json/logger/formatter'
+require "ougai_json/logger/engine"
+require "ougai_json/logger/logger"
+
+module OugaiJson
+  module Logger
+  end
+end

data/lib/tasks/json/logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :json_logger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: ougai-json-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jack.Wu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-28 00:00:00.000000000 Z
+dependencies:
+- !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: mono_logger
+  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: ougai
+  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: ougai-formatters-customizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ougai json looger for Rails, it is based on lograge and ougai, and
+  it is a rails engine, it works out of the box, just add it as gem is enough
+email:
+- jwu4000@outlook.com
+- xuwupeng2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/json_logger_manifest.js
+- app/assets/javascripts/json/logger/application.js
+- app/assets/stylesheets/json/logger/application.css
+- app/controllers/json/logger/application_controller.rb
+- app/helpers/json/logger/application_helper.rb
+- app/jobs/json/logger/application_job.rb
+- app/mailers/json/logger/application_mailer.rb
+- app/models/json/logger/application_record.rb
+- app/views/layouts/json/logger/application.html.erb
+- config/initializers/tagged_logging.rb
+- config/routes.rb
+- lib/ougai_json/logger.rb
+- lib/ougai_json/logger/custom_options.rb
+- lib/ougai_json/logger/engine.rb
+- lib/ougai_json/logger/formatter.rb
+- lib/ougai_json/logger/logger.rb
+- lib/ougai_json/logger/version.rb
+- lib/tasks/json/logger_tasks.rake
+homepage: https://github.com/xuwupeng2000/json-logger
+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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A Ougai based json looger for Rails, it is based on lograge and ougai, and
+  it is a rails engine
+test_files: []