researchable_loggable 1.7.1 → 1.8.0

data/README.md

@@ -97,6 +97,23 @@ This method is used for ECS logging, if the method is not found, the user.id fie
 config.loggable.disable_open_telemetry = true
 ```
 
+`disable_pyroscope`. Loggable can configure [Pyroscope](https://grafana.com/docs/pyroscope/) for continuous profiling in production. The `pyroscope` gem is optional, so it is not installed with loggable (it has no prebuilt binaries for Alpine/musl). To enable profiling, add it to your Gemfile:
+
+```ruby
+gem 'pyroscope', '~> 1.0'
+```
+
+The configuration is the same regardless of the backend it points to (Grafana Cloud, a self-hosted Pyroscope or an Alloy instance):
+
+- `PYROSCOPE_SERVER_ADDRESS` (required): the address of the backend (e.g. `https://profiles-prod-001.grafana.net` or `http://localhost:4040`).
+- `PYROSCOPE_BASIC_AUTH_USER` and `PYROSCOPE_BASIC_AUTH_PASSWORD` (optional): basic auth credentials, used when both are set.
+
+If `PYROSCOPE_SERVER_ADDRESS` is not present, Pyroscope configuration is skipped entirely. If you want to disable profiling regardless, you may add the following to your `config/application.rb` file:
+
+```ruby
+config.loggable.disable_pyroscope = true
+```
+
 No other configuration options are provided because this gem seeks to enforce consistency across all applications.
 
 For applications that already had some level of log customization, some cleanup might be needed:

data/lib/loggable/pyroscope_config.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'socket'
+
+module Loggable
+  # The PyroscopeConfig module provides a method to configure Pyroscope for continuous profiling.
+  # The same env vars are used regardless of the backend (Grafana Cloud, a self-hosted Pyroscope or Alloy instance):
+  #   - PYROSCOPE_SERVER_ADDRESS (required)
+  #   - PYROSCOPE_BASIC_AUTH_USER and PYROSCOPE_BASIC_AUTH_PASSWORD (optional, enables basic auth when both are set)
+  # If PYROSCOPE_SERVER_ADDRESS is not present, Pyroscope configuration is skipped.
+  # The pyroscope gem is optional: applications that want profiling must add it to their own Gemfile.
+  module PyroscopeConfig
+    def self.configure(application_name)
+      server_address = env('PYROSCOPE_SERVER_ADDRESS')
+      return unless server_address && pyroscope_available?
+
+      ::Pyroscope.configure do |config|
+        config.application_name = application_name
+        config.server_address = server_address
+        configure_basic_auth(config)
+        config.tags = {
+          'pod' => env('HOSTNAME') || Socket.gethostname,
+          'domain' => env('HOST_NAME')
+        }.compact
+      end
+    end
+
+    def self.pyroscope_available?
+      require 'pyroscope'
+      true
+    rescue LoadError
+      warn 'Loggable: PYROSCOPE_SERVER_ADDRESS is set but the pyroscope gem is not installed, skipping Pyroscope'
+      false
+    end
+    private_class_method :pyroscope_available?
+
+    def self.configure_basic_auth(config)
+      username = env('PYROSCOPE_BASIC_AUTH_USER')
+      password = env('PYROSCOPE_BASIC_AUTH_PASSWORD')
+      if username.nil? ^ password.nil?
+        warn 'Loggable: PYROSCOPE_BASIC_AUTH_USER and PYROSCOPE_BASIC_AUTH_PASSWORD must both be set, ' \
+             'skipping basic auth'
+      end
+      return unless username && password
+
+      config.basic_auth_username = username
+      config.basic_auth_password = password
+    end
+    private_class_method :configure_basic_auth
+
+    def self.env(name)
+      ENV.fetch(name, nil).presence
+    end
+    private_class_method :env
+  end
+end

data/lib/loggable/railtie.rb

@@ -11,6 +11,7 @@ module Loggable
     config.loggable = ActiveSupport::OrderedOptions.new
     config.loggable.production_like = false
     config.loggable.current_user_method = :current_user
+    config.loggable.disable_pyroscope = false
 
     # Initializer runs before initialize_logger (found in Bootstrap) so from the very beginning we are logging using
     # the logfmt format, even during the initialization process
@@ -19,6 +20,7 @@ module Loggable
       Rails.application.configure do
         production_like = Rails.env.production? || config.loggable.production_like
         disable_open_telemetry = config.loggable.disable_open_telemetry
+        disable_pyroscope = config.loggable.disable_pyroscope
 
         if production_like
           if Rails.application.config.respond_to?(:assets) && Rails.application.config.assets.quiet
@@ -30,6 +32,10 @@ module Loggable
           unless disable_open_telemetry
             Loggable::OpenTelemetryConfig.configure(Rails.application.class.module_parent_name.underscore.dasherize)
           end
+
+          unless disable_pyroscope
+            Loggable::PyroscopeConfig.configure(Rails.application.class.module_parent_name.underscore.dasherize)
+          end
         end
 
         # lograge configuration

data/lib/loggable/version.rb

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

data/lib/researchable_loggable.rb

@@ -3,6 +3,7 @@
 require_relative 'loggable/version'
 require_relative 'loggable/railtie' if defined?(Rails::Railtie)
 require_relative 'loggable/opentelemetry_config'
+require_relative 'loggable/pyroscope_config'
 require_relative 'loggable/logfmt/logger'
 
 module ResearchableLoggable

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.7.1'
+  VERSION = '1.8.0'
 end

data/vendor/ruby/ruby/3.2.0/gems/concurrent-ruby-1.2.0/lib/concurrent-ruby/concurrent/version.rb

@@ -1,3 +1,3 @@
 module Concurrent
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/vendor/ruby/ruby/3.2.0/gems/crass-1.0.6/lib/crass/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Crass
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/vendor/ruby/ruby/3.2.0/gems/lograge-0.12.0/lib/lograge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lograge
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/vendor/ruby/ruby/3.2.0/gems/method_source-1.0.0/lib/method_source/version.rb

@@ -1,3 +1,3 @@
 module MethodSource
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-api-1.3.0/lib/opentelemetry/version.rb

@@ -6,5 +6,5 @@
 
 module OpenTelemetry
   ## Current OpenTelemetry version
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-common-0.21.0/lib/opentelemetry/common/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Common
-    VERSION = '1.7.1'
+    VERSION = '1.8.0'
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-exporter-otlp-0.28.1/lib/opentelemetry/exporter/otlp/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Exporter
     module OTLP
       ## Current OpenTelemetry OTLP exporter version
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-helpers-mysql-0.1.1/lib/opentelemetry/helpers/mysql/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module MySQL
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-helpers-sql-obfuscation-0.2.0/lib/opentelemetry/helpers/sql_obfuscation/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module SqlObfuscation
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-action_mailer-0.1.0/lib/opentelemetry/instrumentation/action_mailer/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionMailer
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-action_pack-0.9.0/lib/opentelemetry/instrumentation/action_pack/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionPack
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-action_view-0.7.3/lib/opentelemetry/instrumentation/action_view/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionView
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-active_job-0.7.7/lib/opentelemetry/instrumentation/active_job/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveJob
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-active_model_serializers-0.20.2/lib/opentelemetry/instrumentation/active_model_serializers/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveModelSerializers
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-active_record-0.7.4/lib/opentelemetry/instrumentation/active_record/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveRecord
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-active_support-0.6.0/lib/opentelemetry/instrumentation/active_support/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveSupport
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-all-0.63.0/lib/opentelemetry/instrumentation/all/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module All
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-aws_lambda-0.1.1/lib/opentelemetry/instrumentation/aws_lambda/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsLambda
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-aws_sdk-0.5.4/lib/opentelemetry/instrumentation/aws_sdk/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-base-0.22.6/lib/opentelemetry/instrumentation/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Instrumentation
-    VERSION = '1.7.1'
+    VERSION = '1.8.0'
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-bunny-0.21.4/lib/opentelemetry/instrumentation/bunny/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Bunny
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-concurrent_ruby-0.21.4/lib/opentelemetry/instrumentation/concurrent_ruby/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ConcurrentRuby
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-dalli-0.25.4/lib/opentelemetry/instrumentation/dalli/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Dalli
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-delayed_job-0.22.4/lib/opentelemetry/instrumentation/delayed_job/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module DelayedJob
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-ethon-0.21.8/lib/opentelemetry/instrumentation/ethon/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Ethon
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-excon-0.22.4/lib/opentelemetry/instrumentation/excon/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Excon
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-faraday-0.24.6/lib/opentelemetry/instrumentation/faraday/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Faraday
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-grape-0.2.0/lib/opentelemetry/instrumentation/grape/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Instrumentation
     module Grape
       # Current gem version
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-graphql-0.28.4/lib/opentelemetry/instrumentation/graphql/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module GraphQL
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-gruf-0.2.1/lib/opentelemetry/instrumentation/gruf/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Gruf
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-http-0.23.4/lib/opentelemetry/instrumentation/http/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HTTP
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-http_client-0.22.7/lib/opentelemetry/instrumentation/http_client/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HttpClient
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-koala-0.20.5/lib/opentelemetry/instrumentation/koala/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Koala
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-lmdb-0.22.3/lib/opentelemetry/instrumentation/lmdb/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module LMDB
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-mongo-0.22.4/lib/opentelemetry/instrumentation/mongo/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mongo
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-mysql2-0.27.2/lib/opentelemetry/instrumentation/mysql2/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-net_http-0.22.7/lib/opentelemetry/instrumentation/net/http/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Instrumentation
     module Net
       module HTTP
-        VERSION = '1.7.1'
+        VERSION = '1.8.0'
       end
     end
   end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-pg-0.28.0/lib/opentelemetry/instrumentation/pg/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-que-0.8.4/lib/opentelemetry/instrumentation/que/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Que
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-racecar-0.3.4/lib/opentelemetry/instrumentation/racecar/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Racecar
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-rack-0.24.6/lib/opentelemetry/instrumentation/rack/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-rails-0.31.2/lib/opentelemetry/instrumentation/rails/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rails
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-rake-0.2.2/lib/opentelemetry/instrumentation/rake/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rake
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-rdkafka-0.4.8/lib/opentelemetry/instrumentation/rdkafka/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rdkafka
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-redis-0.25.7/lib/opentelemetry/instrumentation/redis/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-resque-0.5.2/lib/opentelemetry/instrumentation/resque/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Resque
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-restclient-0.22.7/lib/opentelemetry/instrumentation/restclient/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module RestClient
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-ruby_kafka-0.21.3/lib/opentelemetry/instrumentation/ruby_kafka/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module RubyKafka
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-sidekiq-0.25.7/lib/opentelemetry/instrumentation/sidekiq/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-sinatra-0.24.1/lib/opentelemetry/instrumentation/sinatra/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sinatra
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end

data/vendor/ruby/ruby/3.2.0/gems/opentelemetry-instrumentation-trilogy-0.59.3/lib/opentelemetry/instrumentation/trilogy/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Trilogy
-      VERSION = '1.7.1'
+      VERSION = '1.8.0'
     end
   end
 end