inst-wide-logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8396c15e0ed6c58c85344244cd56f9495d7ed8ed509d287f72af53e64793112
+  data.tar.gz: 3acb7318de4dfd72a9b01aee71b01074158805fe7a792866448e56ee935105d6
+SHA512:
+  metadata.gz: eea5cd1bd0a1ecb737a05489f226d9ea13008b0573b27301bfec3e99172ccb650fd26ad5f89f137246f1123730bd41e834c0c84169d6e848b63a1616bf00bab4
+  data.tar.gz: 70e8bc59cb5d2b2645b47150c43c1ff11e9c44c36cfbc2e468dc335a6313741ee8438e194d90a7e7a801b27c2f426b6241366420150680dbe08576c8468fb99e

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [1.0.0] - 2026-04-01
+
+### Added
+
+- `WideLogger.wrap` for wrapping code blocks with structured wide logging
+- `WideLogger.add_context` for adding metadata to the current logging context
+- `WideLogger::DevJsonFormatter` for human-readable JSON log output in development

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wide_logger.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,50 @@
+# WideLogger
+
+Instructure's implementation of
+[Wide Logging](https://loggingsucks.com/) in New Quizzes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add inst-wide-logger
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install inst-wide-logger
+
+## Usage
+
+Add variables to the logging context:
+
+```ruby
+WideLogger.add_context({
+    user_id: current_user.id,
+    quiz_id: @quiz.id
+})
+```
+
+### Wrapping a code block
+This will create a log entry at the end of the block with the context variables. If error is raised, the log entry will be created with the error information.
+
+```ruby
+WideLogger.wrap(type: :web_request, metadata: { additional_context: @context }) do
+    # code to execute
+end
+```
+
+Optionally, you can use WideLogger:DevJsonFormatter to have log entries in the following format:
+
+```text
+<timestamp> <message> <context in JSON format>
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+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 the created tag, 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/instructure-internal/wide-logger

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/wide_logger/dev_json_formatter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WideLogger
+  class DevJsonFormatter < PaulBunyan::JSONFormatter
+    def call(severity, time, progname, msg)
+      time.utc.strftime(DATETIME_FORMAT) + ' ' + msg.to_s + ' ' + super
+    end
+
+    private
+
+    def merge_metadata_and_message(metadata, message)
+      super.except('message', 'ts').sort_by { |key, _| key.to_s }.to_h
+    end
+  end
+end

data/lib/wide_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WideLogger
+  VERSION = "1.0.0"
+end

data/lib/wide_logger/wide_logger.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module WideLogger
+  EVENT_TYPES = {
+    web_request: 'canonical_request_summary',
+    job: 'canonical_job_summary',
+    sqs: 'canonical_sqs_summary'
+  }.freeze
+
+  class << self
+    def wrap(type:, metadata: {})
+      event_type = EVENT_TYPES.fetch(type)
+
+      Rails.logger.add_metadata(
+        log_event_type: event_type,
+        **metadata
+      )
+
+      result = yield
+
+      emit_event(event_type)
+      result
+    rescue StandardError => e
+      emit_event(event_type, e)
+      raise
+    ensure
+      Rails.logger.clear_metadata!
+    end
+
+    def add_context(context = {}, **kw_context)
+      Rails.logger.add_metadata(context, **kw_context)
+    end
+
+    private
+
+    def emit_event(event_type, e = nil)
+      if e
+        Rails.logger.error("#{event_type} failed with error: #{e.message}")
+      else
+        Rails.logger.info(event_type)
+      end
+    end
+  end
+end

data/lib/wide_logger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'paul_bunyan'
+require_relative 'wide_logger/version'
+require_relative 'wide_logger/wide_logger'
+require_relative 'wide_logger/dev_json_formatter'

data/wide_logger.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wide_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'inst-wide-logger'
+  spec.version = WideLogger::VERSION
+  spec.authors = ['Zoltan Hegedus']
+  spec.email = ['zoltan.hegedus@instructure.com']
+
+  spec.summary = 'Wide logging with structured metadata for Rails applications'
+  spec.homepage = 'https://github.com/instructure-internal/wide-logger'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git))})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'paul_bunyan', '~> 2.1'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: inst-wide-logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zoltan Hegedus
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paul_bunyan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description:
+email:
+- zoltan.hegedus@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/wide_logger.rb
+- lib/wide_logger/dev_json_formatter.rb
+- lib/wide_logger/version.rb
+- lib/wide_logger/wide_logger.rb
+- wide_logger.gemspec
+homepage: https://github.com/instructure-internal/wide-logger
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/instructure-internal/wide-logger
+  source_code_uri: https://github.com/instructure-internal/wide-logger
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Wide logging with structured metadata for Rails applications
+test_files: []