researchable_loggable 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a23495beab24247d68a2d16b22b47c63dc62907f5a0cd97a2bf239a697d7bae
-  data.tar.gz: 6da7d0c63b104be64d7ba13006db69cc2ff24610ea6494db4460db4db328620b
+  metadata.gz: fbb2f10f55fe229b5aa4fa37200b4938d1f2bfca095bea3445cc02e45257cb36
+  data.tar.gz: e0929bdc0b5db11fc17a5515ef06582eab0b4ff8581c42b3c9f6f2bc45adaa25
 SHA512:
-  metadata.gz: 5d169fe09836a0aaa5d9a8537590e77ccbfb2a8b8fd5998a71bd9eb1ec3913d20f84deec030274c361e20f18284ec10df825eb8d1635d17f561beb4678471eaa
-  data.tar.gz: 7675af41ca588f916a67dc4ac782bdd21480d0b043ef22f4412cc7dbae063d4be23eaad9bb95bf9d7d7e33abc2c265900e289c987c23787b920c7fd9238e5156
+  metadata.gz: cc20b8d6d7952f11f8d735e6ebccf4d5ecb3b36daaa70e913df3f9e79bcd70c74d83cd0955c6dd432dec7126c510db9462afc1136f70eabed577e71e11903bcf
+  data.tar.gz: f184d1792cc43b07c01f878083767e65ba8f891961c8cafd0b7e531abd140718c6bb9bfd22ea03b800f48bfe66d02d0db2c7e966bb79acc4d1df43d6234ee81d

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [1.2.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.1.0...v1.2.0) (2024-09-03)
+
+
+### Features
+
+* add OpenTelemetry ([1dc8d60](https://gitlab.com/researchable/general/gems/loggable/commit/1dc8d60bfc736f2e24c76cb8ece35c0f9f81ac74))
+
+
+### Reverts
+
+* **config:** set loggable production_like back to [secure] ([68c1ec1](https://gitlab.com/researchable/general/gems/loggable/commit/68c1ec11f25d6b58e38ee1c36aa479e63ee1b9eb))
+
 # [1.1.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.0.2...v1.1.0) (2023-07-06)
 
 

data/Gemfile

@@ -14,3 +14,8 @@ gem 'ruboguide', '~> 1.0'
 gem 'ecs-logging', '~> 1.0'
 gem 'lograge'
 gem 'logstash-event'
+
+gem 'opentelemetry-instrumentation-all', '~> 0.63.0'
+gem 'opentelemetry-sdk', '~> 1.5'
+
+gem 'opentelemetry-exporter-otlp', '~> 0.28.1'

data/Gemfile.lock

@@ -1,10 +1,14 @@
 PATH
   remote: .
   specs:
-    researchable_loggable (1.0.2)
+    researchable_loggable (1.1.0)
       ecs-logging (~> 1.0)
       lograge
       logstash-event
+      opentelemetry-api
+      opentelemetry-exporter-otlp
+      opentelemetry-instrumentation-rails
+      opentelemetry-sdk
 
 GEM
   remote: https://rubygems.org/
@@ -28,12 +32,18 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    bigdecimal (3.1.8)
     builder (3.2.4)
     concurrent-ruby (1.2.0)
     crass (1.0.6)
     diff-lcs (1.5.0)
     ecs-logging (1.0.0)
     erubi (1.12.0)
+    google-protobuf (4.27.4-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    googleapis-common-protos-types (1.15.0)
+      google-protobuf (>= 3.18, < 5.a)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     lograge (0.12.0)
@@ -49,6 +59,62 @@ GEM
     minitest (5.17.0)
     nokogiri (1.14.1-x86_64-linux)
       racc (~> 1.4)
+    opentelemetry-api (1.3.0)
+    opentelemetry-common (0.21.0)
+      opentelemetry-api (~> 1.0)
+    opentelemetry-exporter-otlp (0.28.1)
+      google-protobuf (>= 3.18)
+      googleapis-common-protos-types (~> 1.3)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.20)
+      opentelemetry-sdk (~> 1.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-instrumentation-action_mailer (0.1.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-active_support (~> 0.1)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-action_pack (0.9.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+      opentelemetry-instrumentation-rack (~> 0.21)
+    opentelemetry-instrumentation-action_view (0.7.3)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-active_support (~> 0.6)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_job (0.7.7)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_record (0.7.4)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-active_support (0.6.0)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-base (0.22.6)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-common (~> 0.21)
+      opentelemetry-registry (~> 0.1)
+    opentelemetry-instrumentation-rack (0.24.6)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-instrumentation-rails (0.31.2)
+      opentelemetry-api (~> 1.0)
+      opentelemetry-instrumentation-action_mailer (~> 0.1.0)
+      opentelemetry-instrumentation-action_pack (~> 0.9.0)
+      opentelemetry-instrumentation-action_view (~> 0.7.0)
+      opentelemetry-instrumentation-active_job (~> 0.7.0)
+      opentelemetry-instrumentation-active_record (~> 0.7.0)
+      opentelemetry-instrumentation-active_support (~> 0.6.0)
+      opentelemetry-instrumentation-base (~> 0.22.1)
+    opentelemetry-registry (0.3.1)
+      opentelemetry-api (~> 1.1)
+    opentelemetry-sdk (1.5.0)
+      opentelemetry-api (~> 1.1)
+      opentelemetry-common (~> 0.20)
+      opentelemetry-registry (~> 0.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-semantic_conventions (1.10.1)
+      opentelemetry-api (~> 1.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
@@ -129,6 +195,10 @@ DEPENDENCIES
   ecs-logging (~> 1.0)
   lograge
   logstash-event
+  opentelemetry-api
+  opentelemetry-exporter-otlp
+  opentelemetry-instrumentation-rails
+  opentelemetry-sdk
   rake (~> 13.0)
   researchable_loggable!
   rspec (~> 3.0)

data/lib/loggable/opentelemetry_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'opentelemetry/sdk'
+require 'opentelemetry/instrumentation/all'
+
+module Loggable
+  # The OpenTelemetryConfig module provides a method to configure OpenTelemetry for Rails applications.
+  # It sets up the instrumentation and tracing with a specified service name, relying on environment
+  # variables for exporter configuration, such as sending traces to a remote backend like Grafana Cloud.
+  module OpenTelemetryConfig
+    # Configures OpenTelemetry for the application
+    def self.configure(service_name)
+      ::OpenTelemetry::SDK.configure do |c|
+        c.use_all
+        c.service_name = service_name
+      end
+    end
+  end
+end

data/lib/loggable/railtie.rb

@@ -20,6 +20,8 @@ module Loggable
         if production_like
           Rails.logger = ::EcsLogging::Logger.new($stdout)
           Rails.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
+
+          Loggable::OpenTelemetryConfig.configure(Rails.application.class.module_parent_name.underscore.dasherize)
         end
 
         # lograge configuration
@@ -54,6 +56,8 @@ module Loggable
           if Rails.env.production? || config.loggable.production_like
             Delayed::Worker.logger = ::EcsLogging::Logger.new($stdout)
             Delayed::Worker.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
+            Loggable::OpenTelemetryConfig.configure("#{Rails.application.class.module_parent_name.underscore.dasherize}
+                                                    -worker")
           else
             Delayed::Worker.logger = Logger.new($stdout)
             Delayed::Worker.logger.level = Logger::DEBUG

data/lib/loggable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loggable
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/researchable_loggable.rb

@@ -2,6 +2,7 @@
 
 require_relative 'loggable/version'
 require_relative 'loggable/railtie' if defined?(Rails::Railtie)
+require_relative 'loggable/opentelemetry_config'
 require_relative 'loggable/ecs_logging/formatter_monkey_patch'
 require_relative 'loggable/lograge/formatter'
 

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestGem
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: researchable_loggable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecs-logging
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: |2
       Researchable's Loggable relies on lograge and elastic's ecs format to log events in a way that is easy to ingest by
       logstash. This enables log correlation with traces across multiple services.
@@ -74,6 +116,7 @@ files:
 - Rakefile
 - lib/loggable/ecs_logging/formatter_monkey_patch.rb
 - lib/loggable/lograge/formatter.rb
+- lib/loggable/opentelemetry_config.rb
 - lib/loggable/railtie.rb
 - lib/loggable/version.rb
 - lib/researchable_loggable.rb
@@ -81,13 +124,13 @@ files:
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
 - sig/loggable.rbs
-homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/README.md
+homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.2.0/README.md
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/README.md
+  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.2.0/README.md
   source_code_uri: https://gitlab.com/researchable/general/gems/loggable
-  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/CHANGELOG.md
+  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.2.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -103,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Researchable's gem to standardize logging on all Rails applications.