manageiq-loggers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d411d75a73f5d47de3de8080101e168c99265168eb34beef036a173955aa9823
-  data.tar.gz: '06163649ad33e5964c5d06f3ab369a1fa0e2fd9cf08d71ca70d0a14da6978420'
+  metadata.gz: b3074101daa2ad9391018a2bd3d9eb9c14588ec5872ffdf8fb6a3a88b119baaa
+  data.tar.gz: 045bc78b9f4c4b97d2c3d7e2e45351025607100dff861397b42dba135a495334
 SHA512:
-  metadata.gz: 84de0b21346b0bc7d805ee5987e6575eee4e7f2b405dea90454d5f41443b0b9ec80282fad209c26b3dbd63f9d69c18159eae5e65b1aac7f3722adf1685da6358
-  data.tar.gz: 52d917bf352a7df54e4993d043a7b9dd1f53e79f4c55456759dc3e850f9d66e30c49fb40cfa90e5b293099a00e03600cbb6ff11e0cc9ed82370a7ee94f4d592e
+  metadata.gz: 2b3675dd8cb799c3b830bb2683303b153e0d01b1a4ebd6b32e6d8b056d8df5bc76e9fd643fac317fcf0090f22ea7ea19935acd5ec90246e7e03b8e69597d063b
+  data.tar.gz: defb9aa94eb27dfd54bb3dab055a7801daf3e282ca2a62f5706008788d3d54c6fc290ac382c2bcd54ac80667b05d6e44d2e1f5b4401523ff5e6e5b9af06e956b

data/.github/workflows/ci.yaml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 0 * * 0'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.6'
+        - '2.7'
+        - '3.0'
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+      timeout-minutes: 30
+    - name: Run tests
+      run: bundle exec rake
+    - name: Report code coverage
+      if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.0' }}
+      continue-on-error: true
+      uses: paambaati/codeclimate-action@v3.0.0

data/.rspec

@@ -1,4 +1,3 @@
---format progress
+--require spec_helper
 --color
 --order random
---require spec_helper

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.1.0] - 2022-11-14
+### Changed
+- Split out JSON logger from Container logger [(#49)](https://github.com/ManageIQ/manageiq-loggers/pull/49)
+- Allow passing the CloudWatch logger's configuration as kwargs [(#50)](https://github.com/ManageIQ/manageiq-loggers/pull/50)
+
+### Fixed
+- Remove timestamp whitespace in container logger formatter [(#47)](https://github.com/ManageIQ/manageiq-loggers/pull/47)
+
 ## [1.0.1] - 2021-01-05
 ### Fixed
 - Fix require issue when used with Rails 7 [(#42)](https://github.com/ManageIQ/manageiq-loggers/pull/42)
@@ -75,7 +83,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.0.1...master
+[Unreleased]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.1.0...master
+[1.1.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/ManageIQ/manageiq-loggers/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.8.0...v1.0.0
 [0.8.0]: https://github.com/ManageIQ/manageiq-loggers/compare/v0.7.0...v0.8.0

data/Gemfile

@@ -1,6 +1,4 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in manageiq-loggers.gemspec
 gemspec

data/README.md

@@ -1,9 +1,8 @@
 # ManageIQ::Loggers
 
-[![Build Status](https://app.travis-ci.com/ManageIQ/manageiq-loggers.svg?branch=master)](https://app.travis-ci.com/ManageIQ/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)
-[![Security](https://hakiri.io/github/ManageIQ/manageiq-loggers/master.svg)](https://hakiri.io/github/ManageIQ/manageiq-loggers/master)
 
 Loggers for ManageIQ projects
 

data/lib/manageiq/loggers/cloud_watch.rb

@@ -7,19 +7,19 @@ module ManageIQ
     class CloudWatch < Base
       NAMESPACE_FILE = "/var/run/secrets/kubernetes.io/serviceaccount/namespace".freeze
 
-      def self.new(*args)
-        access_key_id     = ENV["CW_AWS_ACCESS_KEY_ID"].presence
-        secret_access_key = ENV["CW_AWS_SECRET_ACCESS_KEY"].presence
-        log_group_name    = ENV["CLOUD_WATCH_LOG_GROUP"].presence
-        log_stream_name   = ENV["HOSTNAME"].presence
+      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_name && log_stream_name
+        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_name, log_stream_name)
+        cloud_watch_logdev = CloudWatchLogger::Client.new(creds, log_group, log_stream)
         super(cloud_watch_logdev).tap { |logger| logger.extend(ActiveSupport::Logger.broadcast(container_logger)) }
       end
 

data/lib/manageiq/loggers/container.rb

@@ -1,79 +1,14 @@
 module ManageIQ
   module Loggers
-    class Container < Base
-      def initialize(logdev = STDOUT, *args)
+    class Container < JSONLogger
+      def initialize(logdev = $stdout, *_, **_)
         logdev.sync = true # Don't buffer container log output
-
         super
-
-        self.formatter = Formatter.new
       end
 
       def filename
         "STDOUT"
       end
-
-      class Formatter < Base::Formatter
-        SEVERITY_MAP = {
-          "DEBUG"   => "debug",
-          "INFO"    => "info",
-          "WARN"    => "warning",
-          "ERROR"   => "err",
-          "FATAL"   => "crit",
-          "UNKNOWN" => "unknown"
-          # Others that don't match up: alert emerg notice trace
-        }.freeze
-
-        def initialize
-          super
-          require 'json'
-        end
-
-        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,
-            :tid        => thread_id,
-            :service    => progname,
-            :level      => translate_error(severity),
-            :message    => prefix_task_id(msg2str(msg)),
-            :request_id => request_id
-            # :tags => "tags string",
-          }.compact
-          JSON.generate(payload) << "\n"
-        rescue Encoding::UndefinedConversionError
-          raise unless msg.encoding == Encoding::ASCII_8BIT
-
-          msg.force_encoding("UTF-8")
-          retry
-        end
-
-        private
-
-        def hostname
-          @hostname ||= ENV["HOSTNAME"]
-        end
-
-        def thread_id
-          Thread.current.object_id.to_s(16)
-        end
-
-        def translate_error(level)
-          SEVERITY_MAP[level] || "unknown"
-        end
-
-        def 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
   end
 end

data/lib/manageiq/loggers/json_logger.rb

@@ -0,0 +1,77 @@
+module ManageIQ
+  module Loggers
+    class JSONLogger < Base
+     def initialize(*_, **_)
+        super
+        self.formatter = Formatter.new
+      end
+
+      class Formatter < Base::Formatter
+        SEVERITY_MAP = {
+          "DEBUG"   => "debug",
+          "INFO"    => "info",
+          "WARN"    => "warning",
+          "ERROR"   => "err",
+          "FATAL"   => "crit",
+          "UNKNOWN" => "unknown"
+          # Others that don't match up: alert emerg notice trace
+        }.freeze
+
+        def initialize
+          super
+          require 'json'
+        end
+
+        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,
+            :tid        => thread_id,
+            :service    => progname,
+            :level      => translate_error(severity),
+            :message    => prefix_task_id(msg2str(msg)),
+            :request_id => request_id
+            # :tags => "tags string",
+          }.compact
+          JSON.generate(payload) << "\n"
+        rescue Encoding::UndefinedConversionError
+          raise unless msg.encoding == Encoding::ASCII_8BIT
+
+          msg.force_encoding("UTF-8")
+          retry
+        end
+
+        private
+
+        def format_datetime(*)
+          super.rstrip
+        end
+
+        def hostname
+          @hostname ||= ENV["HOSTNAME"]
+        end
+
+        def thread_id
+          Thread.current.object_id.to_s(16)
+        end
+
+        def translate_error(level)
+          SEVERITY_MAP[level] || "unknown"
+        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
+        end
+      end
+    end
+  end
+end

data/lib/manageiq/loggers/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Loggers
-    VERSION = "1.0.1".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/manageiq/loggers.rb

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

data/manageiq-loggers.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "manageiq/loggers/version"
@@ -30,6 +29,6 @@ Gem::Specification.new do |spec|
   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 "simplecov", ">= 0.21.2"
   spec.add_development_dependency "systemd-journal" if RbConfig::CONFIG['host_os'] =~ /linux/i
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-loggers
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description:
 email:
 executables: []
@@ -129,12 +129,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
-- ".travis.yml"
+- ".whitesource"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -148,6 +149,7 @@ files:
 - lib/manageiq/loggers/cloud_watch.rb
 - lib/manageiq/loggers/container.rb
 - lib/manageiq/loggers/journald.rb
+- lib/manageiq/loggers/json_logger.rb
 - lib/manageiq/loggers/version.rb
 - manageiq-loggers.gemspec
 homepage: https://github.com/ManageIQ/manageiq-loggers
@@ -169,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.18
 signing_key:
 specification_version: 4
 summary: Loggers for ManageIQ projects

data/.travis.yml

@@ -1,14 +0,0 @@
----
-language: ruby
-dist: bionic
-cache: bundler
-rvm:
-- 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
-- "./cc-test-reporter before-build"
-after_script:
-- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"