scout_apm_logging 1.0.3 → 1.2.0

data/lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/logger_provider.rb

@@ -12,6 +12,9 @@ module ScoutApm
           module Logs
             # The SDK implementation of OpenTelemetry::Logs::LoggerProvider.
             class LoggerProvider < OpenTelemetry::Logs::LoggerProvider
+              Key = Struct.new(:name, :version)
+              private_constant(:Key)
+
               UNEXPECTED_ERROR_MESSAGE = 'unexpected error in ' \
                 'OpenTelemetry::SDK::Logs::LoggerProvider#%s'
 
@@ -21,13 +24,18 @@ module ScoutApm
               #
               # @param [optional Resource] resource The resource to associate with
               #   new LogRecords created by {Logger}s created by this LoggerProvider.
+              # @param [optional LogRecordLimits] log_record_limits The limits for
+              #   attributes count and attribute length for LogRecords.
               #
               # @return [OpenTelemetry::SDK::Logs::LoggerProvider]
-              def initialize(resource: OpenTelemetry::SDK::Resources::Resource.create)
+              def initialize(resource: OpenTelemetry::SDK::Resources::Resource.create, log_record_limits: LogRecordLimits::DEFAULT)
                 @log_record_processors = []
+                @log_record_limits = log_record_limits
                 @mutex = Mutex.new
                 @resource = resource
                 @stopped = false
+                @registry = {}
+                @registry_mutex = Mutex.new
               end
 
               # Returns an {OpenTelemetry::SDK::Logs::Logger} instance.
@@ -44,7 +52,9 @@ module ScoutApm
                     "invalid name. Name provided: #{name.inspect}")
                 end
 
-                Logger.new(name, version, self)
+                @registry_mutex.synchronize do
+                  @registry[Key.new(name, version)] ||= Logger.new(name, version, self)
+                end
               end
 
               # Adds a new log record processor to this LoggerProvider's
@@ -134,6 +144,7 @@ module ScoutApm
                           trace_flags: nil,
                           instrumentation_scope: nil,
                           context: nil)
+                return if @stopped
 
                 log_record = LogRecord.new(timestamp: timestamp,
                                           observed_timestamp: observed_timestamp,
@@ -145,7 +156,8 @@ module ScoutApm
                                           span_id: span_id,
                                           trace_flags: trace_flags,
                                           resource: @resource,
-                                          instrumentation_scope: instrumentation_scope)
+                                          instrumentation_scope: instrumentation_scope,
+                                          log_record_limits: @log_record_limits)
 
                 @log_record_processors.each { |processor| processor.on_emit(log_record, context) }
               end

data/lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/version.rb

@@ -11,10 +11,10 @@ module ScoutApm
         module SDK
           module Logs
             # Current OpenTelemetry logs sdk version
-            VERSION = '0.1.0'
+            VERSION = '0.2.0'
           end
         end
       end
     end
   end
-end
+end

data/lib/scout_apm/logging/loggers/opentelemetry/sdk/logs.rb

@@ -11,6 +11,7 @@ require_relative 'logs/log_record'
 require_relative 'logs/log_record_data'
 require_relative 'logs/log_record_processor'
 require_relative 'logs/export'
+require_relative 'logs/log_record_limits'
 
 module ScoutApm
   module Logging

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '1.0.3'
+    VERSION = '1.2.0'
   end
 end

data/lib/scout_apm_logging.rb

@@ -15,9 +15,7 @@ module ScoutApm
       # If we are in a Rails environment, setup the monitor daemon manager.
       class RailTie < ::Rails::Railtie
         initializer 'scout_apm_logging.monitor', after: :initialize_logger, before: :initialize_cache do
-          context = Context.new
-          context.config = Config.with_file(context, context.config.value('config_file'))
-          context.config.log_settings(context.logger)
+          context = ScoutApm::Logging::Context.instance
 
           Loggers::Capture.new(context).setup!
         end

data/scout_apm_logging.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.authors     = 'Scout APM'
   s.email       = ['support@scoutapp.com']
   s.homepage    = 'https://github.com/scoutapp/scout_apm_ruby_logging'
-  s.summary     = 'Ruby Logging Support'
+  s.summary     = 'Managed log monitoring for Ruby applications.'
   s.description = 'Sets up log monitoring for Scout APM Ruby clients.'
   s.license     = 'MIT'
 
@@ -29,4 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop', '1.50.2'
   s.add_development_dependency 'rubocop-ast', '1.30.0'
   s.add_development_dependency 'webmock'
+  # Old, but works. It is a small wrapper library around websocket-eventmachine
+  # for ActionCable protocols.
+  s.add_development_dependency 'action_cable_client'
 end

data/spec/integration/rails/lifecycle_spec.rb

@@ -1,10 +1,20 @@
 require 'webmock/rspec'
 
+# Old, but still works.
+require 'action_cable_client'
+require 'eventmachine'
 require 'spec_helper'
 require 'zlib'
 require 'stringio'
+require 'securerandom'
 require_relative '../../rails/app'
 
+ScoutApm::Logging::Loggers::FileLogger.class_exec do
+  define_method(:filter_log_location) do |locations|
+    locations.find { |loc| loc.path.include?(Rails.root.to_s) && !loc.path.include?('scout_apm/logging') }
+  end
+end
+
 describe ScoutApm::Logging do
   before do
     @file_path = '/app/response_body.txt'
@@ -38,6 +48,27 @@ describe ScoutApm::Logging do
     # Call the app to generate the logs
     `curl localhost:9292`
 
+    channel_client = fork do
+      url = 'ws://localhost:9292/cable'
+      channel_name = 'TestChannel'
+      # Loops.
+      EventMachine.run do
+        client = ActionCableClient.new(url, channel_name)
+        # called whenever a welcome message is received from the server
+        client.connected { puts 'successfully connected.' }
+
+        client.subscribed do
+          puts 'client subscribed to the channel.'
+          client.perform('ding', { message: 'hello from client' })
+        end
+
+        # called whenever a message is received from the server
+        client.received do |message|
+          puts message
+        end
+      end
+    end
+
     sleep 5
 
     proxy_dir = context.config.value('logs_proxy_log_dir')
@@ -54,18 +85,19 @@ describe ScoutApm::Logging do
       end
     end
 
+    puts lines
+
     local_messages = lines.map { |item| item['msg'] }
+    puts local_messages
 
     # Verify we have all the logs in the local log file
     expect(local_messages.count('[TEST] Some log')).to eq(1)
     expect(local_messages.count('[YIELD] Yield Test')).to eq(1)
     expect(local_messages.count('Another Log')).to eq(1)
     expect(local_messages.count('Should not be captured')).to eq(0)
-
-    log_locations = lines.map { |item| item['log_location'] }.compact
-
-    # Verify that log attributes aren't persisted
-    expect(log_locations.size).to eq(1)
+    expect(local_messages.count('Warn level log')).to eq(1)
+    expect(local_messages.count('Error level log')).to eq(1)
+    expect(local_messages.count('Fatal level log')).to eq(1)
 
     # Verify the logs are sent to the receiver
     receiver_contents = File.readlines(@file_path, chomp: true)
@@ -73,9 +105,21 @@ describe ScoutApm::Logging do
     expect(receiver_contents.count('[YIELD] Yield Test')).to eq(1)
     expect(receiver_contents.count('Another Log')).to eq(1)
     expect(receiver_contents.count('Should not be captured')).to eq(0)
+    expect(local_messages.count('Warn level log')).to eq(1)
+    expect(local_messages.count('Error level log')).to eq(1)
+    expect(local_messages.count('Fatal level log')).to eq(1)
+
+    # Verify we recorded server ActionCable messages
+    expect(receiver_contents.count { |msg| msg.include?('ActionCable Connected:') }).to eq(1)
+    expect(receiver_contents.count('Subscribed to test_channel')).to eq(1)
+    expect(receiver_contents.count { |msg| msg.include?('Ding received with data: {"message"') }).to eq(1)
+    expect(local_messages.count { |msg| msg.include?('ActionCable Connected:') }).to eq(1)
+    expect(local_messages.count('Subscribed to test_channel')).to eq(1)
+    expect(local_messages.count { |msg| msg.include?('Ding received with data: {"message"') }).to eq(1)
 
     # Kill the rails process. We use kill as using any other signal throws a long log line.
     Process.kill('KILL', rails_pid)
+    Process.kill('KILL', channel_client)
   end
 
   private

data/spec/rails/app.rb

@@ -5,6 +5,7 @@ rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
 require 'action_controller/railtie'
+require 'action_cable/engine'
 require 'logger'
 require 'scout_apm_logging'
 
@@ -13,24 +14,58 @@ Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
 class App < ::Rails::Application
   config.eager_load = false
   config.log_level = :info
+  config.action_cable.cable = { 'adapter' => 'async' }
+  config.action_cable.connection_class = -> { ApplicationCable::Connection }
+  config.action_cable.disable_request_forgery_protection = true
 
   routes.append do
+    mount ActionCable.server => '/cable'
     root to: 'root#index'
   end
 end
 
 class RootController < ActionController::Base
-  def index
-    Rails.logger.warn('Add location log attributes')
+  def index # rubocop:disable Metrics/AbcSize
     Rails.logger.tagged('TEST').info('Some log')
     Rails.logger.tagged('YIELD') { logger.info('Yield Test') }
     Rails.logger.info('Another Log')
     Rails.logger.debug('Should not be captured')
+    Rails.logger.warn('Warn level log')
+    Rails.logger.error('Error level log')
+    Rails.logger.fatal('Fatal level log')
 
     render plain: Rails.version
   end
 end
 
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :id
+
+    def connect
+      self.id = SecureRandom.uuid
+      logger.info("ActionCable Connected: #{id}")
+    end
+  end
+end
+
+class TestChannel < ApplicationCable::Channel
+  def subscribed
+    stream_from 'test_channel'
+    logger.info 'Subscribed to test_channel'
+  end
+
+  def ding(data)
+    logger.info "Ding received with data: #{data.inspect}"
+    transmit({ dong: "Server response to: '#{data['message']}'" })
+  end
+end
+
 def initialize_app
   App.initialize!
 

data/spec/unit/loggers/logger_spec.rb

@@ -0,0 +1,95 @@
+require 'logger'
+require 'stringio'
+
+require 'spec_helper'
+
+require 'scout_apm_logging'
+
+ScoutApm::Logging::Loggers::Formatter.class_exec do
+  define_method(:emit_log) do |msg, severity, time, attributes_to_log|
+  end
+end
+
+def capture_stdout
+  old_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  $stdout.string
+ensure
+  $stdout = old_stdout
+end
+
+describe ScoutApm::Logging::Loggers::Logger do
+  it 'should not capture call stack or log line' do
+    ScoutApm::Logging::Context.instance
+
+    output_from_log = capture_stdout do
+      logger = ScoutApm::Logging::Loggers::FileLogger.new($stdout).tap do |instance|
+        instance.level = 0
+        instance.formatter = ScoutApm::Logging::Loggers::Formatter.new
+      end
+
+      logger.info('Hi')
+    end
+
+    expect(output_from_log).not_to include('"log_location":"')
+    expect(output_from_log).not_to include('"msg":"[logger_spec.rb')
+  end
+
+  it 'should capture call stack' do
+    ENV['SCOUT_LOGS_CAPTURE_CALL_STACK'] = 'true'
+    ScoutApm::Logging::Context.instance
+
+    output_from_log = capture_stdout do
+      logger = ScoutApm::Logging::Loggers::FileLogger.new($stdout).tap do |instance|
+        instance.level = 0
+        instance.formatter = ScoutApm::Logging::Loggers::Formatter.new
+      end
+
+      logger.info('Hi')
+    end
+
+    expect(output_from_log).to include('"log_location":"')
+    expect(output_from_log).not_to include('"msg":"[logger_spec.rb')
+    ENV['SCOUT_LOGS_CAPTURE_LOG_LINE'] = 'false' # set back to default
+  end
+
+  it 'should capture log line and call stack' do
+    ENV['SCOUT_LOGS_CAPTURE_CALL_STACK'] = 'true'
+    ENV['SCOUT_LOGS_CAPTURE_LOG_LINE'] = 'true'
+
+    ScoutApm::Logging::Context.instance
+
+    output_from_log = capture_stdout do
+      logger = ScoutApm::Logging::Loggers::FileLogger.new($stdout).tap do |instance|
+        instance.level = 0
+        instance.formatter = ScoutApm::Logging::Loggers::Formatter.new
+      end
+
+      logger.info('Hi')
+    end
+
+    expect(output_from_log).to include('"msg":"[logger_spec.rb')
+    expect(output_from_log).to include('"log_location":"')
+    ENV['SCOUT_LOGS_CAPTURE_CALL_STACK'] = 'false' # set back to default
+    ENV['SCOUT_LOGS_CAPTURE_LOG_LINE'] = 'false' # set back to default
+  end
+
+  it 'should capture log line' do
+    ENV['SCOUT_LOGS_CAPTURE_LOG_LINE'] = 'true'
+    ScoutApm::Logging::Context.instance
+
+    output_from_log = capture_stdout do
+      logger = ScoutApm::Logging::Loggers::FileLogger.new($stdout).tap do |instance|
+        instance.level = 0
+        instance.formatter = ScoutApm::Logging::Loggers::Formatter.new
+      end
+
+      logger.info('Hi')
+    end
+
+    expect(output_from_log).not_to include('"log_location":"')
+    expect(output_from_log).to include('"msg":"[logger_spec.rb')
+    ENV['SCOUT_LOGS_CAPTURE_LOG_LINE'] = 'false' # set back to default
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos-types
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: action_cable_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sets up log monitoring for Scout APM Ruby clients.
 email:
 - support@scoutapp.com
@@ -208,6 +222,7 @@ files:
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/export/log_record_exporter.rb
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/log_record.rb
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/log_record_data.rb
+- lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/log_record_limits.rb
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/log_record_processor.rb
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/logger.rb
 - lib/scout_apm/logging/loggers/opentelemetry/sdk/logs/logger_provider.rb
@@ -229,6 +244,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/config_spec.rb
 - spec/unit/loggers/capture_spec.rb
+- spec/unit/loggers/logger_spec.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby_logging
 licenses:
 - MIT
@@ -251,7 +267,7 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Ruby Logging Support
+summary: Managed log monitoring for Ruby applications.
 test_files:
 - spec/data/config_test_1.yml
 - spec/data/mock_config.yml
@@ -260,3 +276,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/config_spec.rb
 - spec/unit/loggers/capture_spec.rb
+- spec/unit/loggers/logger_spec.rb