activesupport-json_logging 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b542fc320d19a1789f47805250847291ca671676834f66f1b99257d0311706ef
-  data.tar.gz: 8dac946f3ee55c6b22ff4d7996e12c6b6ea220434c7ba4514a7495ce251c7504
+  metadata.gz: 4854135797f8609d12de7e48f10b2ece4151e828ae9d6699fcd8f367f645cf5f
+  data.tar.gz: 7fe2c2710e8adcab432233e3c55f97d337ba89ca1d5bd286c4e8b290662a3ac7
 SHA512:
-  metadata.gz: 82f446cdb9ddc23c91ce99df51f90fd4d6cc2f8eecdaa45276bb8ff8aa074cb1ef07bde42b1ce3e2fc907e34e2e235a544cd54d36a1da5016a0fcf621b8b397b
-  data.tar.gz: 21cc1fe28c94ae215a2293fe5f934bc9f139bba4affd9431b0aa41f0c0620e30ab456c0c43bd4b834e61d4e89a6d2a5876c3fdc47d2ca21b2d4163f4a3327578
+  metadata.gz: bd806fd601a0c4f761bd235f46e848f16701fe09e2995039c22e07c4aaa26545ad15f756ec635da3768a20a678fe7d3f6f35d2535a98f482fe885137758c1a58
+  data.tar.gz: 72c2460e491be67a3ead7de92e549cf11d13c51b3da774251080263311b51c3c8a79a7bc0ad4354b9bb2b0d11d16ae47f74511b800f1230b2fb5aaf3adc68b8c

data/CHANGELOG.md

@@ -1,44 +1,12 @@
-# Changelog
+# CHANGELOG
 
-## 1.0.0 (2024-10-31)
+## 1.1.0 (2025-11-04)
 
-First stable release.
+- Move tags to root level of JSON payload instead of nested in context (breaking change: tags now at `payload["tags"]` instead of `payload["context"]["tags"]`)
+- Filter system-controlled keys (severity, timestamp, message, tags, context) from user context to prevent conflicts
+- Prevent nested context objects when user context includes a `context` key
+- Fix pending spec for TimeWithZone objects by requiring ActiveSupport time extensions
 
-- feat: single-line JSON format compatible with cloud logging services (GCP, AWS, Azure)
-- feat: native tagged logging with `logger.tagged("TAG")` API compatible with Rails
-- feat: thread-safe context via `JsonLogging.with_context` for per-thread fields
-- feat: smart message parsing for hashes, JSON strings, and plain strings
-- feat: inherit all ActiveSupport::Logger features (silence, local_level, etc.)
-- feat: BroadcastLogger compatibility for Rails 7.1+ automatic wrapping
-- feat: timestamp precision in microseconds (iso8601 with 6 decimals)
-- feat: Rails ParameterFilter integration for automatic sensitive data filtering
-- feat: input sanitization removing control characters and truncating long strings
-- feat: sensitive key pattern matching fallback when ParameterFilter unavailable
-- feat: depth and size limits for nested structures to prevent log bloat
-- feat: single-line JSON output to prevent log injection via newlines
-- feat: graceful error handling with fallback entries on serialization errors
-- feat: Rails 6.0, 6.1, 7.0, 7.1, 7.2, 8.0 support
-- feat: IsolatedExecutionState for thread/Fiber isolation (Rails 7.1+)
-- feat: backward compatible fallback to Thread.current for Rails 6-7.0
-- feat: kwargs support in logger initialization for Rails 7+
-- perf: ~0.006ms per log entry overhead (250-400% vs plain text, typical for JSON)
-- perf: memory efficient with ~3KB per entry and zero retained memory
-- feat: performance benchmarks with memory profiling included
-- test: 93.78% code coverage with comprehensive RSpec suite
-- test: BroadcastLogger integration tests
-- test: IsolatedExecutionState thread safety tests
-- test: Appraisals configured for multi-version testing (Rails 6-8)
-- test: GitHub Actions CI workflow
-- docs: complete README with installation, usage, and API docs
-- docs: Rails environment configuration examples (development, production, test)
-- docs: Lograge integration with third-party logger configurations
-- docs: Puma integration example
-- docs: security best practices and ParameterFilter guide
-- docs: inherited Rails logger features documentation
+## 1.0.0 (2025-10-31)
 
----
-
-## 0.1.0
-
-- feat: initial JSON formatter and logger implementation
-- test: basic RSpec test coverage
+- Initial stable release

data/README.md

@@ -1,6 +1,6 @@
 # activesupport-json_logging
 
-[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/ci.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=881AFPL643)](https://codecov.io/gh/amkisko/activesupport-json_logging.rb)
+[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/ci.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=UX80FTO0Y0)](https://codecov.io/gh/amkisko/activesupport-json_logging.rb)
 
 Structured JSON logging for Rails and ActiveSupport with a safe, single-line formatter.
 No dependencies beyond Rails and Activesupport.
@@ -8,6 +8,7 @@ Supports Rails versions from 6 to 8.
 
 Sponsored by [Kisko Labs](https://www.kiskolabs.com).
 
+
 ## Installation
 
 Add to your Gemfile:
@@ -30,22 +31,6 @@ Rails.application.configure do
 end
 ```
 
-### Development: Using from Local Repository
-
-When developing the gem or testing changes in your application, you can point your Gemfile to a local path:
-
-```ruby
-# In your application's Gemfile
-gem "activesupport-json_logging", path: "../activesupport-json_logging.rb"
-```
-
-Then run:
-
-```bash
-bundle install
-```
-
-**Note:** When using `path:` in your Gemfile, Bundler will use the local gem directly. Changes you make to the gem code will be immediately available in your application without needing to rebuild or reinstall the gem. This is ideal for development and testing.
 
 ## What you get
 
@@ -329,10 +314,10 @@ logger.tagged("BCX").tagged("Jason").info("Stuff")
 # Wrap a TaggedLogging logger - works perfectly
 tagged_logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
 json_logger = JsonLogging.new(tagged_logger)
-json_logger.tagged("TEST") { json_logger.info("message") }  # Tags appear in JSON context
+json_logger.tagged("TEST") { json_logger.info("message") }  # Tags appear at root level in JSON
 ```
 
-**Note:** If you wrap a `JsonLogging` logger with `ActiveSupport::TaggedLogging`, the TaggedLogging's text-based tags will appear as part of the message string in the JSON output, not as structured tags in the context. For best results, wrap loggers with `JsonLogging` last.
+**Note:** If you wrap a `JsonLogging` logger with `ActiveSupport::TaggedLogging`, the TaggedLogging's text-based tags will appear as part of the message string in the JSON output, not as structured tags at the root level. For best results, wrap loggers with `JsonLogging` last.
 
 ### JsonLogging::JsonLogger
 
@@ -359,7 +344,7 @@ formatter.call("INFO", Time.now, nil, "message")
 
 # With tags (useful for Puma or other standalone use cases)
 formatter = JsonLogging::Formatter.new(tags: ["Puma"])
-formatter.call("INFO", Time.now, nil, "message")  # Output includes "Puma" tag in context
+formatter.call("INFO", Time.now, nil, "message")  # Output includes "Puma" tag at root level
 
 # Multiple tags
 formatter = JsonLogging::Formatter.new(tags: ["Puma", "Worker"])
@@ -511,6 +496,7 @@ Rails.application.config.filter_parameters += [
 
 The gem will automatically filter these from all log entries, including context data. Encrypted attributes (using Rails 7+ `encrypts`) are automatically filtered as well.
 
+
 ## Development
 
 ```bash
@@ -536,6 +522,47 @@ bundle exec appraisal rails-7.0 rspec
 bundle exec standardrb --fix
 ```
 
+### Development: Using from Local Repository
+
+When developing the gem or testing changes in your application, you can point your Gemfile to a local path:
+
+```ruby
+# In your application's Gemfile
+gem "activesupport-json_logging", path: "../activesupport-json_logging.rb"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+**Note:** When using `path:` in your Gemfile, Bundler will use the local gem directly. Changes you make to the gem code will be immediately available in your application without needing to rebuild or reinstall the gem. This is ideal for development and testing.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/activesupport-json_logging.rb
+
+Contribution policy:
+- New features are not necessarily added to the gem
+- Pull request should have test coverage for affected parts
+- Pull request should have changelog entry
+
+Review policy:
+- It might take up to 2 calendar weeks to review and merge critical fixes
+- It might take up to 6 calendar months to review and merge pull request
+- It might take up to 1 calendar year to review an issue
+
+
+## Publishing
+
+```sh
+rm activesupport-json_logging-*.gem
+gem build activesupport-json_logging.gemspec
+gem push activesupport-json_logging-*.gem
+```
+
 ## License
 
-MIT
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/activesupport/json_logging.rb

@@ -4,4 +4,3 @@ require "json_logging"
 
 # Ensure Railtie is loaded so Rails auto-discovers it
 require "activesupport/json_logging/railtie" if defined?(Rails)
-

data/lib/json_logging/payload_builder.rb

@@ -29,14 +29,22 @@ module JsonLogging
         additional_context || {}
       end
 
-      deduped_additional = sanitized_context.reject { |k, _| payload.key?(k) }
+      # Filter out system-controlled keys from user context
+      # These keys should never be set by user context as they're controlled by the logger
+      system_controlled_keys = [:tags, "tags", :severity, "severity", :timestamp, "timestamp", :message, "message", :context, "context"]
+      user_context_filtered = sanitized_context.except(*system_controlled_keys)
+
+      # Also prevent overriding any existing payload keys (additional safety)
+      deduped_additional = user_context_filtered.reject { |k, _| payload.key?(k) }
       merged_context = existing_context.merge(deduped_additional)
 
+      # Put tags at root level, separate from context
+      # Merge with existing tags from payload (e.g., when logging a hash with tags: [...] at root)
       unless tags.empty?
-        existing_tags = Array(merged_context[:tags])
+        existing_tags = Array(payload[:tags] || payload["tags"])
         # Sanitize tag strings (remove control chars, truncate)
         sanitized_tags = tags.map { |tag| Sanitizer.sanitize_string(tag.to_s) }
-        merged_context[:tags] = (existing_tags + sanitized_tags).uniq
+        payload[:tags] = (existing_tags + sanitized_tags).uniq
       end
 
       payload[:context] = merged_context unless merged_context.empty?

data/lib/json_logging/version.rb

@@ -1,3 +1,3 @@
 module JsonLogging
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-json_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - amkisko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-31 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,6 +92,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement