eventhub-components 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a573d8c1b9f662b10579d8d01acc4f231b7af96d0f0ae27e1f3e86a684396b
-  data.tar.gz: '093c2473b85281b5da27fb1b19acf75c23ccf82fedf529fe404f16b22d82a07d'
+  metadata.gz: 62b597731a526635002f05d2c12bd7a47992bad26ec2718e0fc5cfa9048ed856
+  data.tar.gz: a032f4272f7a1bd326c6ae62784d7ff68e5c1cd64af67bddac750f1770d3bed0
 SHA512:
-  metadata.gz: 3688e7175ff82e4057681aabacbd6337e80bc874700c48259be630d38007d2e773a0527680e99b5fa949a780b66ec8e06162952f6ae6851592731508114d8281
-  data.tar.gz: 840d0cfa01334cb3348cdf740db7dc16258a65517b198c46da5b5f9a9f89828323e06547c3650cededc62c1b42b9229741464b8748fe84f58f157bc5652c7f5b
+  metadata.gz: '09dd455c9ea23edb7371b50973cb599cbc5f45c876df95799536fe7c2d36a6db7cf55669b44734743489453d1d247847a0b9cf62617a87781c16a833c2f512d6'
+  data.tar.gz: 47071f03bfb054bc6b58df26b71d8a57502a0ed2e2e5b7ad30011f5eb8d205cbf9b8adbfeed67d22840cdda0f6a6d7c7c89fb4d3a0fdd0ded6ef2ae57127ef32

data/.github/dependabot.yml

@@ -1,6 +1,17 @@
 version: 2
 updates:
-  - package-ecosystem: 'bundler'
-    directory: '/'
+  - package-ecosystem: "bundler"
+    directory: "/"
     schedule:
-      interval: 'weekly'
+      interval: "weekly"
+      day: "saturday"
+      time: "04:05"
+      timezone: "Europe/Zurich"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "04:05"
+      timezone: "Europe/Zurich"

data/.github/workflows/cd.yml

@@ -10,12 +10,12 @@ jobs:
 
     steps:
     - name: Checkout current code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.1'
+        ruby-version: '3.3'
         bundler-cache: true
         cache-version: 1
 

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
       - "*"
 
   schedule:
-  - cron: 0 2 * * *
+  - cron: 0 2 * * 3,6
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -23,11 +23,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.1', '3.0', '2.7', '2.6']
+        ruby: [ '3.3', '3.2', '3.1', '3.0']
 
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.0 / 2024-07-24
+
+* Customized cloud stdout logstash logger
+* Update development dependencies (rake, rspec, standard)
+
 ## 0.3.1 / 2022-07-27
 
 * Update homepage url in gemspec file

data/README.md

@@ -11,10 +11,10 @@ Incldues logging, exception writing and pid file facilities for event hub proces
 
 Currently supported and tested ruby versions are:
 
+- 3.3
+- 3.2
 - 3.1
-- 3.0
-- 2.7
-- 2.6
+- 3.0 (EOL April 23 2024, is not part of CI anymore)
 
 ## Installation
 

data/eventhub-components.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.1"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "standard", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "standard", "~> 1.39"
   spec.add_development_dependency "simplecov", "~> 0.21"
 
   spec.add_runtime_dependency "logstash-logger", "~> 0.26"

data/lib/eventhub/components/logger.rb

@@ -18,4 +18,23 @@ class EventHub::Components::Logger
     end
     LogStashLogger.new([{type: :file, path: "logs/ruby/#{processor_name}.log", sync: true}])
   end
+
+  def self.logstash_cloud(processor_name, environment)
+    # configure logstash with custom fields
+    LogStashLogger.configure do |config|
+      config.customize_event do |event|
+        # renaming default fields to be eventhub cloud compatible
+        event["time"] = event.remove("@timestamp")
+        event["msg"] = event.remove("message")
+        event["level"] = event.remove("severity")
+        event["host"] = event.remove("host") # reordering
+        event.remove("@version") # not needed
+
+        # additional fields
+        event["app"] = processor_name
+        event["env"] = environment
+      end
+    end
+    LogStashLogger.new([{type: :stdout}])
+  end
 end

data/lib/eventhub/components/multi_logger.rb

@@ -22,7 +22,7 @@ class EventHub::Components::MultiLogger
     end
   end
 
-  def respond_to_missing?(method)
+  def respond_to_missing?(*args)
     true
   end
 end

data/lib/eventhub/components/structured_data_logger.rb

@@ -49,11 +49,11 @@ class EventHub::Components::StructuredDataLogger
 
   private
 
-  def method_missing(method, *args, &block)
-    target.send(method, *args, &block)
+  def method_missing(...)
+    target.send(...)
   end
 
-  def respond_to_missing?(method)
+  def respond_to_missing?(*args)
     true
   end
 

data/lib/eventhub/components/version.rb

@@ -1,5 +1,5 @@
 module EventHub
   module Components
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/spec/components/log_formatter_spec.rb

@@ -0,0 +1,8 @@
+require_relative "../spec_helper"
+
+RSpec.describe EventHub::Components::StructuredDataLogger do
+  let!(:logger) { EventHub::Components::LogFormatter.new }
+  it "formats logs" do
+    expect(logger.call("ERROR", Time.now, "rspec", "just a message")).to match(/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d+\t\d+\tERROR\tjust a message\n$/)
+  end
+end

data/spec/components/multi_logger_spec.rb

@@ -56,5 +56,20 @@ RSpec.describe EventHub::Components::StructuredDataLogger do
       logger.info("Yes, it works2!")
       expect(File.read("logs/ruby/processor.log")).to match(/Yes, it works2!/)
     end
+
+    it "response to an unknown method" do
+      expect(logger.respond_to?(:whatever)).to eq(true)
+    end
+
+    it "logs json to standard output" do
+      pattern = /\{"time":"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}\+\d{2}:\d{2}","msg":"hello","level":"(INFO|WARN|ERROR|DEBUG|FATAL)","host":"[^\"]+","app":"processor","env":"development"\}/
+
+      logger.add_device(EventHub::Components::Logger.logstash_cloud("processor", "development"))
+      expect { logger.info("hello") }.to output(pattern).to_stdout_from_any_process
+      expect { logger.warn("hello") }.to output(pattern).to_stdout_from_any_process
+      expect { logger.error("hello") }.to output(pattern).to_stdout_from_any_process
+      expect { logger.debug("hello") }.to output(pattern).to_stdout_from_any_process
+      expect { logger.fatal("hello") }.to output(pattern).to_stdout_from_any_process
+    end
   end
 end

data/spec/components/structured_data_logger_spec.rb

@@ -86,4 +86,15 @@ RSpec.describe EventHub::Components::StructuredDataLogger do
       expect(logger[:fatal]).to eq(expectation)
     end
   end
+
+  context "unknown methods" do
+    let(:logger) { EventHub::Components::StructuredDataLogger.new("something not nil", "app_name" => "an app", "env" => "test") }
+    it "response to an unknown method" do
+      expect(logger.respond_to?(:whatever)).to eq(true)
+    end
+
+    it "can call an unknown method" do
+      expect { logger.size }.not_to raise_error
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventhub-components
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Steiner, Thomas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ files:
 - lib/eventhub/components/structured_data_logger.rb
 - lib/eventhub/components/version.rb
 - spec/components/exception_writer_spec.rb
+- spec/components/log_formatter_spec.rb
 - spec/components/multi_logger_spec.rb
 - spec/components/pid_file_spec.rb
 - spec/components/structured_data_logger_spec.rb
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Additional eventhub components