manageiq-loggers 0.4.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74435aa6cde9e117c8218ff4551d000ae7da79fdd7c986178b7d409618067312
-  data.tar.gz: 50871a5265efcd9a2661a47e3c49ea20639a750a66ef0efe95365fc67fd1be71
+  metadata.gz: 4fde8d7f48465068c802390222f9f37f00b644b8932637ec6818c0ecec91acbe
+  data.tar.gz: 6ad670852b8d6ce6e0803076ce730a288a0c5fd96f1c49c412b8f4dc1c075736
 SHA512:
-  metadata.gz: f1248dc1c32419ec042508e9de699ad868ccfd50f8c3ee190981fb8ad75b65f492b057fdbba904eb4636a4bd743046042b8cae3f489c9c486fbae455db17bf4d
-  data.tar.gz: 3b7ebb8171a01c5ebf04f4291f8be447d599eb8d421d17231e62036c61d01d0ffe1bd374a14a3dc4c135113786983cb9a7438e207123b2e97d50abedd2c00b4c
+  metadata.gz: fa8bf70516aa9db5bc934289dc0512e7aa19203cf9794e7692f5c749e33fd3c2b974c9919f89c318cbb931cb1fd4c37639c19d1df7e119473e2227acf513dc4e
+  data.tar.gz: 03bd1d9088c70a6344f5803abef6f262994518c9d9c3bfaa8e91e87a66f9fc4828b2d9dc925b0c067e7d1462a0e36b7648edec84fd7d0858bdbefda40835dda7

data/.codeclimate.yml

@@ -1,11 +1,14 @@
----
 version: '2'
 prepare:
   fetch:
-  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
     path: ".rubocop_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_cc_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
@@ -28,4 +31,4 @@ plugins:
   rubocop:
     enabled: true
     config: ".rubocop_cc.yml"
-    channel: 'rubocop-0-69'
+    channel: rubocop-0-82

data/.rubocop.yml

@@ -1,3 +1,4 @@
 inherit_from:
-- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
-- .rubocop_local.yml
+- ".rubocop_local.yml"
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"

data/.rubocop_cc.yml

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

data/.travis.yml

@@ -1,10 +1,13 @@
 ---
 language: ruby
-sudo: false
+dist: bionic
 cache: bundler
 rvm:
-- 2.4.5
-- 2.5.3
+- 2.4.10
+- 2.5.9
+- 2.6.8
+- 2.7.4
+- 3.0.2
 before_script:
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
 - chmod +x ./cc-test-reporter

data/CHANGELOG.md

@@ -5,6 +5,37 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.8.0] - 2021-11-15
+
+### Changed
+- Add Ruby 2.6, 2.7, and 3.0 to the test matrix
+- Add ability to set class-level and instance-level filters for log_hashes
+
+## [0.7.0] - 2021-09-21
+### Changed
+- Truncate log lines to 8Kb [(#32)](https://github.com/ManageIQ/manageiq-loggers/pull/32)
+- Honor container log level [(#35)](https://github.com/ManageIQ/manageiq-loggers/pull/35)
+- Use progname rather than syslog_identifier for journald logs [(#36)](https://github.com/ManageIQ/manageiq-loggers/pull/36)
+
+### Fixed
+- Handle Unicode characters in binary messages. [(#34)](https://github.com/ManageIQ/manageiq-loggers/pull/34)
+
+## [0.6.0] - 2020-12-09
+### Changed
+- Update rake dependency to address CVE-2020-8130 [(#19)](https://github.com/ManageIQ/manageiq-loggers/pull/19)
+
+### Fixed
+- Fix escaping of < and > in Container logger [(#29)](https://github.com/ManageIQ/manageiq-loggers/pull/29)
+- Fix ActiveSupport::Deprecation call [(#29)](https://github.com/ManageIQ/manageiq-loggers/pull/29)
+- Fix the handling of journald code_file/code_line [(#21)](https://github.com/ManageIQ/manageiq-loggers/pull/21) [(#22)](https://github.com/ManageIQ/manageiq-loggers/pull/22)
+
+### Added
+- Add code_func to the journald logger [(#23)](https://github.com/ManageIQ/manageiq-loggers/pull/23)
+
+## [0.5.0] - 2020-03-18
+### Changed
+- Deprecate Thread.current[:current_request]&.request_id in favor of Thread.current[:request_id] [(#17)](https://github.com/ManageIQ/manageiq-loggers/pull/17)
+
 ## [0.4.2] - 2020-01-14
 ### Fixed
 - Revert "Change CloudWatch log_group to be the namespace if it exists" [(#16)](https://github.com/ManageIQ/manageiq-loggers/pull/16)
@@ -33,7 +64,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.1.0] - 2019-01-08
 
-[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.4.2...master
+[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.8.0...master
+[0.8.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.3.0...v0.4.0

data/README.md

@@ -39,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/manageiq-loggers.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/manageiq-loggers.
 
 ## License
 

data/lib/manageiq/loggers/base.rb

@@ -7,7 +7,7 @@ require 'English'
 module ManageIQ
   module Loggers
     class Base < Logger
-      MAX_LOG_LINE_LENGTH = 1.megabyte
+      MAX_LOG_LINE_LENGTH = 8.kilobytes
 
       def initialize(*args)
         super
@@ -72,13 +72,24 @@ module ManageIQ
         end
       end
 
+      private_class_method def self.clean_log_hashes_filter(filters)
+        (Array(filters).compact.map(&:to_s) << "password").uniq
+      end
+
+      def self.log_hashes_filter
+        @log_hashes_filter ||= ["password"]
+      end
+
+      def self.log_hashes_filter=(filters)
+        @log_hashes_filter = clean_log_hashes_filter(filters)
+      end
+
       def self.log_hashes(logger, h, options = {})
         require 'yaml'
         require 'manageiq/password'
 
         level  = options[:log_level] || :info
-        filter = Array(options[:filter]).flatten.compact.map(&:to_s) << "password"
-        filter.uniq!
+        filter = options[:filter] ? clean_log_hashes_filter(options[:filter]) : log_hashes_filter
 
         values = YAML.dump(h.to_hash).gsub(ManageIQ::Password::REGEXP, "[FILTERED]")
         values = values.split("\n").map do |l|
@@ -91,7 +102,16 @@ module ManageIQ
         logger.send(level, "\n#{values}")
       end
 
+      def log_hashes_filter
+        @log_hashes_filter || self.class.log_hashes_filter
+      end
+
+      def log_hashes_filter=(filters)
+        @log_hashes_filter = self.class.send(:clean_log_hashes_filter, filters)
+      end
+
       def log_hashes(h, options = {})
+        options[:filter] ||= log_hashes_filter
         self.class.log_hashes(self, h, options)
       end
 

data/lib/manageiq/loggers/container.rb

@@ -5,12 +5,8 @@ module ManageIQ
         logdev.sync = true # Don't buffer container log output
 
         super
-        self.level = DEBUG
-        self.formatter = Formatter.new
-      end
 
-      def level=(_new_level)
-        super(DEBUG) # We want everything written to the ContainerLogger written to STDOUT
+        self.formatter = Formatter.new
       end
 
       def filename
@@ -36,7 +32,7 @@ module ManageIQ
         def call(severity, time, progname, msg)
           # From https://github.com/ViaQ/elasticsearch-templates/releases -> Downloads -> *.asciidoc
           # NOTE: These values are in a specific order for easier human readbility via STDOUT
-          {
+          payload = {
             :@timestamp => format_datetime(time),
             :hostname   => hostname,
             :pid        => $PROCESS_ID,
@@ -46,7 +42,13 @@ module ManageIQ
             :message    => prefix_task_id(msg2str(msg)),
             :request_id => request_id
             # :tags => "tags string",
-          }.compact.to_json << "\n"
+          }.compact
+          JSON.generate(payload) << "\n"
+        rescue Encoding::UndefinedConversionError
+          raise unless msg.encoding == Encoding::ASCII_8BIT
+
+          msg.force_encoding("UTF-8")
+          retry
         end
 
         private
@@ -64,7 +66,12 @@ module ManageIQ
         end
 
         def request_id
-          Thread.current[:current_request]&.request_id
+          Thread.current[:request_id] || Thread.current[:current_request]&.request_id.tap do |request_id|
+            if request_id
+              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
         end
       end
     end

data/lib/manageiq/loggers/journald.rb

@@ -1,8 +1,10 @@
 module ManageIQ
   module Loggers
     class Journald < Base
-      # An syslog identifier used when writing messages. The default is the progname.
-      attr_accessor :syslog_identifier
+      require "active_support/core_ext/module/aliasing"
+
+      # Alias syslog_identifier for backwards compatibility
+      alias_attribute :syslog_identifier, :progname
 
       # Create and return a new ManageIQ::Loggers::Journald instance. The
       # arguments to the initializer can be ignored unless you're multicasting.
@@ -15,7 +17,6 @@ module ManageIQ
         super(logdev, *args)
         @formatter = Formatter.new
         @progname ||= 'manageiq'
-        @syslog_identifier ||= @progname
       end
 
       # Comply with the VMDB::Logger interface. For a filename we simply use
@@ -44,14 +45,15 @@ module ManageIQ
         end
 
         message = formatter.call(format_severity(severity), progname, message)
-        caller_object = caller_locations.last
+        caller_object = caller_locations(3, 1).first
 
         Systemd::Journal.message(
           :message           => message,
           :priority          => log_level_map[severity],
-          :syslog_identifier => syslog_identifier,
+          :syslog_identifier => progname,
           :code_line         => caller_object.lineno,
-          :code_file         => caller_object.absolute_path
+          :code_file         => caller_object.absolute_path,
+          :code_func         => caller_object.label
         )
       end
 

data/lib/manageiq/loggers/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Loggers
-    VERSION = "0.4.2".freeze
+    VERSION = "0.8.0".freeze
   end
 end

data/manageiq-loggers.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "activesupport",     ">= 5.0"
-  spec.add_runtime_dependency "manageiq-password", "~> 0.1"
+  spec.add_runtime_dependency "manageiq-password", "< 2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "cloudwatchlogger"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"
   spec.add_development_dependency "systemd-journal" if RbConfig::CONFIG['host_os'] =~ /linux/i

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-loggers
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.8.0
 platform: ruby
 authors:
 - ManageIQ Authors
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: manageiq-password
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,49 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: systemd-journal
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,8 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,7 +154,7 @@ homepage: https://github.com/ManageIQ/manageiq-loggers
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Loggers for ManageIQ projects
 test_files: []