manageiq-loggers 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f43cbf53e58f32f3e270f87d248dbf379a0d779be61ec33e72d8ee6f028a265d
-  data.tar.gz: a9dee3b993cef7a02617608887092ace4a7dd4aa0b4e79390225ce5311d485c5
+  metadata.gz: 46aa465df04eec849cc5a424cb86b25e856d08d53a8946de00eeed6c6b0bfb84
+  data.tar.gz: de25e24d88f68587f5da9bd4826072ea9d81fbd46f4ba094c0d1ad75ed3c26eb
 SHA512:
-  metadata.gz: 5140757154082052608cb7e0d60fb902d186ff16c917217ac1a574e2ee9c199d4339e06bc8d0664d54b587c84416496d7a98f8439720e38ab2f1d3697a97fc52
-  data.tar.gz: 8a6a0da62b87fe90889835a42c0c7077b50cb5e6714e45e9e9850b39a6343e2264ae423b802b4681dba3c355e1ada1209e80fe8bc201cc10f148bee3f1f5663e
+  metadata.gz: 0152260cca77e6953667c9e57e918404824f91cfb95fa5ec7570ac3cd891f889d3f47865bcb3440681b83dbf80e5392fb46cc96d9db7e761093693bfc59c72ee
+  data.tar.gz: 2d5e985ac09b88eefc58becebf83e8d9805422e79e7eaa575a9a6c8dbb59564e053f8f2b2f7f55690ae6ac29d5b47fccfd78c1ec7b08f127500cd62cbc3a748b

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,6 +1,5 @@
 ---
 language: ruby
-sudo: false
 cache: bundler
 rvm:
 - 2.4.5

data/CHANGELOG.md

@@ -5,6 +5,35 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [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)
+
 ## [0.4.1] - 2020-01-06
 ### Fixed
 - Change CloudWatch logger log_group and log_stream values for easier debugging and unique identifiers [(#15)](https://github.com/ManageIQ/manageiq-loggers/pull/15)
@@ -29,7 +58,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.1...master
+[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.7.0...master
+[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
 [0.3.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.2.0...v0.3.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

data/lib/manageiq/loggers/cloud_watch.rb

@@ -9,8 +9,7 @@ module ManageIQ
       def self.new(*args)
         access_key_id     = ENV["CW_AWS_ACCESS_KEY_ID"].presence
         secret_access_key = ENV["CW_AWS_SECRET_ACCESS_KEY"].presence
-        namespace         = File.exist?(NAMESPACE_FILE) ? File.read(NAMESPACE_FILE) : nil
-        log_group_name    = namespace || ENV["CLOUD_WATCH_LOG_GROUP"].presence
+        log_group_name    = ENV["CLOUD_WATCH_LOG_GROUP"].presence
         log_stream_name   = ENV["HOSTNAME"].presence
 
         container_logger = ManageIQ::Loggers::Container.new

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.1".freeze
+    VERSION = "0.7.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.1
+  version: 0.7.0
 platform: ruby
 authors:
 - ManageIQ Authors
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2021-09-21 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.4
+signing_key:
 specification_version: 4
 summary: Loggers for ManageIQ projects
 test_files: []