manageiq-loggers 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c55e72746b776be0f82b04de5ccbb9a231dc8b7d1856b553c1999554b7682d80
-  data.tar.gz: 34a98640f11f0a77663e9352aaff1b4883932b02b9d0ea81e607678416b7d55b
+  metadata.gz: 62e1317e69617340944c4b101d38210b7b0c0f5338a27575cb8cc46a74c286ac
+  data.tar.gz: 9075da53591b01d2a5cebc39c2096b7969132d4b6a0462ed2a3fae7f26ed8101
 SHA512:
-  metadata.gz: d5fbc6dde299dc4a10d357f037c0eba5b519c6d0e5b5549867f8eb69f03fc846c9a61af2dbed6c136878f8af585faaeeca298f1d80f46c35361095500c91bca1
-  data.tar.gz: 4b41a58754367d7cf3f9c05278a7d7935c35535d796c7ade14258395e76aa082444be14a2334a29863a133c90e77af6a07475f027f4301792b1b32c3e053fca1
+  metadata.gz: 79bb2f54cc014ef31a121f530b0d0115cb9388288d8a75dd1703d3ae0d9338b69dde905ec6ce6b1a523ad6ffdf9a4e51ad9aa6786fb3217d9b4ee001dba49b52
+  data.tar.gz: 2bdae67116b57656be0d049c546da40391825311b6f42346820a464ab7d9d945b767716ff5e9e8a4c81e403dc8d0fe641011530c7f5c5aed1529bd500106f399

data/.github/workflows/ci.yaml

@@ -1,30 +1,35 @@
----
 name: CI
 on:
-  push:
   pull_request:
+  push:
+    branches-ignore:
+    - dependabot/*
+    - renovate/*
   schedule:
   - cron: 0 0 * * 0
+  workflow_dispatch:
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+permissions:
+  contents: read
 jobs:
   ci:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version:
-        - '2.7'
-        - '3.0'
         - '3.1'
         - '3.2'
         - '3.3'
+        - '3.4'
         rails-version:
-        - '6.1'
-        - '7.0'
         - '7.1'
+        - '7.2'
     env:
-      TEST_RAILS_VERSION: ${{ matrix.rails-version }}
-      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      TEST_RAILS_VERSION: "${{ matrix.rails-version }}"
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -33,7 +38,3 @@ jobs:
       timeout-minutes: 30
     - name: Run tests
       run: bundle exec rake
-    - name: Report code coverage
-      if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.1' }}
-      continue-on-error: true
-      uses: paambaati/codeclimate-action@v5

data/CHANGELOG.md

@@ -5,9 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-## [1.2.1] - 2025-05-21
+## [2.0.0] - 2026-05-19
+### Removed
+- **BREAKING** Remove the deprecated `current_request.request_id` [(#80)](https://github.com/ManageIQ/manageiq-loggers/pull/80)
+- **BREAKING** Remove the Cloudwatch Logger [(#81)](https://github.com/ManageIQ/manageiq-loggers/pull/81)
+
+### Added
+- Add `#contents` method to Journald and File loggers [(#126)](https://github.com/ManageIQ/manageiq-loggers/pull/126)
+
 ### Fixed
 - Handle nil caller_object in Journald logger [(#91)](https://github.com/ManageIQ/manageiq-loggers/pull/91)
+- Determine caller location dynamically [(#92)](https://github.com/ManageIQ/manageiq-loggers/pull/92)
 
 ## [1.2.0] - 2024-09-30
 ### Added
@@ -102,8 +110,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.1.0] - 2019-01-08
 
-[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.2.1...v1.2.z
-[1.2.1]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.2.0...v1.2.1
+[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v2.0.0...master
+[2.0.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.0.1...v1.1.0

data/Gemfile

@@ -5,12 +5,10 @@ gemspec
 
 minimum_version =
   case ENV['TEST_RAILS_VERSION']
-  when "6.1"
-    "~>6.1.7"
-  when "7.0"
-    "~>7.0.8"
+  when "7.2"
+    "~>7.2.2"
   else
-    "~>7.1.4"
+    "~>7.1.5"
   end
 
 gem "activesupport", minimum_version

data/README.md

@@ -1,8 +1,6 @@
 # ManageIQ::Loggers
 
 [![CI](https://github.com/ManageIQ/manageiq-loggers/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/manageiq-loggers/actions/workflows/ci.yaml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/8d3c9bf77c45a024166b/maintainability)](https://codeclimate.com/github/ManageIQ/manageiq-loggers/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8d3c9bf77c45a024166b/test_coverage)](https://codeclimate.com/github/ManageIQ/manageiq-loggers/test_coverage)
 
 Loggers for ManageIQ projects
 
@@ -28,8 +26,6 @@ Some loggers require additional gems to function correctly. These gems are not s
 
 To use the `Journald` logger, users must specify the `systemd-journal` gem as a dependency
 
-To use the `CloudWatch` logger, users must specify the `cloudwatchlogger` gem as a dependency
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/manageiq/loggers/file.rb

@@ -0,0 +1,60 @@
+module ManageIQ
+  module Loggers
+    class File < Base
+      def contents(line_count = 1_000, buffer_size = 8_192)
+        return [] unless logdev&.filename && ::File.exist?(logdev.filename)
+
+        tail(line_count, buffer_size)
+          .select { |line| line&.unpack("U*") rescue nil }
+          .map { |line| line.force_encoding("utf-8") }
+      end
+
+      private
+
+      def tail(line_count, buffer_size)
+        lines = []
+
+        ::File.open(logdev.filename, 'r') do |file|
+          # Start from the end of the file
+          file.seek(0, IO::SEEK_END)
+          file_size = file.pos
+
+          # If file is empty, return empty array
+          return [] if file_size.zero?
+
+          partial_line = ""
+          position     = file_size
+
+          # Read backwards in chunks until we have enough lines
+          while position > 0 && lines.size < line_count
+            # Calculate how much to read
+            chunk_size = [buffer_size, position].min
+            position -= chunk_size
+
+            # Seek to position and read chunk
+            file.seek(position, IO::SEEK_SET)
+            chunk = file.read(chunk_size)
+
+            # Split into lines
+            chunk_lines = chunk.split("\n")
+
+            # Handle the last line in chunk (partial line continuing to next chunk)
+            # by appending the saved partial line to the last line of this chunk
+            chunk_lines[-1] = chunk_lines[-1] + partial_line unless partial_line.empty?
+
+            # If we're not at the start of the file, the first line is partial
+            partial_line = position > 0 ? chunk_lines.shift : ""
+
+            # Prepend complete lines to our result
+            lines.prepend(*chunk_lines)
+          end
+
+          # Add the remaining partial line at the beginning
+          lines.unshift(partial_line) unless partial_line.empty?
+        end
+
+        lines.last(line_count)
+      end
+    end
+  end
+end

data/lib/manageiq/loggers/journald.rb

@@ -45,8 +45,11 @@ module ManageIQ
         # ActiveSupport::BroadcastLogger or the older ActiveSupport::Logger.broadcast
         # so we have to account for that difference when walking up the caller_locations
         # to get the "real" logging location.
-        callstack_start = ActiveSupport.gem_version >= Gem::Version.new("7.1.0") ? 7 : 3
-        caller_object = caller_locations(callstack_start, 1)&.first
+        caller_object = caller_locations.detect do |caller_loc|
+          next if caller_loc.path.end_with?("lib/active_support/broadcast_logger.rb", "lib/active_support/logger.rb", "/logger.rb")
+
+          caller_loc
+        end
 
         Systemd::Journal.message(
           :message           => message,
@@ -58,6 +61,27 @@ module ManageIQ
         )
       end
 
+      def contents(max_count = 1_000)
+        Systemd::Journal.open do |journal|
+          journal.filter(:syslog_identifier => progname)
+          journal.seek(:tail)
+
+          results = []
+          max_count.times do
+            break unless journal.move_previous
+
+            entry = journal.current_entry
+            # This is the time in microseconds since the epoch UTC, formatted as a decimal string.
+            seconds_since_epoch = entry._source_realtime_timestamp.to_f / 1_000_000.0
+            timestamp = Time.at(seconds_since_epoch).strftime("%Y-%m-%dT%H:%M:%S.%6N")
+
+            results << "[#{timestamp} ##{entry._pid}] #{entry.message}"
+          end
+
+          results.reverse
+        end
+      end
+
       private
 
       # Map the Systemd::Journal error levels to the Logger error levels. For

data/lib/manageiq/loggers/json_logger.rb

@@ -63,13 +63,7 @@ module ManageIQ
         end
 
         def request_id
-          Thread.current[:request_id] || Thread.current[:current_request]&.request_id.tap do |request_id|
-            if request_id
-              require "active_support"
-              require "active_support/deprecation"
-              ActiveSupport::Deprecation.warn("Usage of `Thread.current[:current_request]&.request_id` will be deprecated in version 0.5.0. Please switch to `Thread.current[:request_id]` to log request_id automatically.")
-            end
-          end
+          Thread.current[:request_id]
         end
       end
     end

data/lib/manageiq/loggers/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Loggers
-    VERSION = "1.2.1".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/manageiq/loggers.rb

@@ -1,8 +1,8 @@
 require "manageiq/loggers/base"
 require "manageiq/loggers/json_logger"
 
-require "manageiq/loggers/cloud_watch"
 require "manageiq/loggers/container"
+require "manageiq/loggers/file"
 require "manageiq/loggers/journald"
 
 require "manageiq/loggers/version"

data/manageiq-loggers.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "manageiq-password", "< 2"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "cloudwatchlogger"
-  spec.add_development_dependency "manageiq-style", ">= 1.5.2"
+  spec.add_development_dependency "manageiq-style"
+
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", ">= 0.21.2"

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "inheritConfig": true,
+  "inheritConfigRepoName": "manageiq/renovate-config"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-loggers
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - ManageIQ Authors
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cloudwatchlogger
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -65,20 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: manageiq-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -139,12 +125,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".whitesource"
 - CHANGELOG.md
@@ -157,12 +141,13 @@ files:
 - lib/manageiq-loggers.rb
 - lib/manageiq/loggers.rb
 - lib/manageiq/loggers/base.rb
-- lib/manageiq/loggers/cloud_watch.rb
 - lib/manageiq/loggers/container.rb
+- lib/manageiq/loggers/file.rb
 - lib/manageiq/loggers/journald.rb
 - lib/manageiq/loggers/json_logger.rb
 - lib/manageiq/loggers/version.rb
 - manageiq-loggers.gemspec
+- renovate.json
 homepage: https://github.com/ManageIQ/manageiq-loggers
 licenses:
 - Apache-2.0

data/.codeclimate.yml

@@ -1,34 +0,0 @@
-version: '2'
-prepare:
-  fetch:
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
-    path: ".rubocop_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
-    path: ".rubocop_cc_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
-    path: styles/base.yml
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
-    path: styles/cc_base.yml
-checks:
-  argument-count:
-    enabled: false
-  complex-logic:
-    enabled: false
-  file-lines:
-    enabled: false
-  method-complexity:
-    config:
-      threshold: 11
-  method-count:
-    enabled: false
-  method-lines:
-    enabled: false
-  nested-control-flow:
-    enabled: false
-  return-statements:
-    enabled: false
-plugins:
-  rubocop:
-    enabled: true
-    config: ".rubocop_cc.yml"
-    channel: rubocop-1-56-3

data/.rubocop_cc.yml

@@ -1,4 +0,0 @@
-inherit_from:
-- ".rubocop_base.yml"
-- ".rubocop_cc_base.yml"
-- ".rubocop_local.yml"

data/lib/manageiq/loggers/cloud_watch.rb

@@ -1,33 +0,0 @@
-require 'active_support'
-require 'active_support/core_ext/object'
-require 'active_support/logger'
-
-module ManageIQ
-  module Loggers
-    class CloudWatch < Base
-      NAMESPACE_FILE = "/var/run/secrets/kubernetes.io/serviceaccount/namespace".freeze
-
-      def self.new(*args, access_key_id: nil, secret_access_key: nil, log_group: nil, log_stream: nil)
-        access_key_id     ||= ENV["CW_AWS_ACCESS_KEY_ID"].presence
-        secret_access_key ||= ENV["CW_AWS_SECRET_ACCESS_KEY"].presence
-        log_group         ||= ENV["CLOUD_WATCH_LOG_GROUP"].presence
-        log_stream        ||= ENV["HOSTNAME"].presence
-
-        container_logger = ManageIQ::Loggers::Container.new
-        return container_logger unless access_key_id && secret_access_key && log_group && log_stream
-
-        require 'cloudwatchlogger'
-
-        creds = {:access_key_id => access_key_id, :secret_access_key => secret_access_key}
-        cloud_watch_logdev = CloudWatchLogger::Client.new(creds, log_group, log_stream)
-        cloud_watch_logger = super(cloud_watch_logdev)
-        cloud_watch_logger.wrap(container_logger)
-      end
-
-      def initialize(logdev, *args)
-        super
-        self.formatter = ManageIQ::Loggers::Container::Formatter.new
-      end
-    end
-  end
-end