logjam_agent 0.29.6 → 0.32.2

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.29.6"
+  VERSION = "0.32.2"
 end

data/lib/logjam_agent/zmq_forwarder.rb

@@ -16,6 +16,7 @@ module LogjamAgent
       @sequence = SEQUENCE_START
       @socket = nil
       @ping_ensured = false
+      @socket_mutex = Mutex.new
     end
 
     def connection_specs
@@ -35,11 +36,11 @@ module LogjamAgent
       }
     end
 
-    @@mutex = Mutex.new
+    @@context_mutex = Mutex.new
     @@zmq_context = nil
 
     def self.context
-      @@mutex.synchronize do
+      @@context_mutex.synchronize do
         @@zmq_context ||=
           begin
             require 'ffi-rzmq'
@@ -50,24 +51,9 @@ module LogjamAgent
       end
     end
 
-    def socket
-      return @socket if @socket
-      @socket = self.class.context.socket(ZMQ::DEALER)
-      ensure_ping_at_exit
-      @socket.setsockopt(ZMQ::LINGER, @config[:linger])
-      @socket.setsockopt(ZMQ::SNDHWM, @config[:snd_hwm])
-      @socket.setsockopt(ZMQ::RCVHWM, @config[:rcv_hwm])
-      @socket.setsockopt(ZMQ::RCVTIMEO, @config[:rcv_timeo])
-      @socket.setsockopt(ZMQ::SNDTIMEO, @config[:snd_timeo])
-      spec = connection_specs.sort_by{rand}.first
-      @socket.connect(spec)
-      @socket
-    end
-
     def reset
-      if @socket
-        @socket.close
-        @socket = nil
+      @socket_mutex.synchronize do
+        reset_without_locking
       end
     end
 
@@ -84,27 +70,57 @@ module LogjamAgent
         key += ".#{engine}"
       end
       msg = LogjamAgent.encode_payload(data)
-      if options[:sync]
-        send_receive(app_env, key, msg)
-      else
-        publish(app_env, key, msg)
+      @socket_mutex.synchronize do
+        if options[:sync]
+          send_receive(app_env, key, msg)
+        else
+          publish(app_env, key, msg)
+        end
       end
     rescue => error
       reraise_expectation_errors!
       raise ForwardingError.new(error.message)
     end
 
+    private
+
+    def reset_without_locking
+      if @socket
+        @socket.close
+        @socket = nil
+      end
+    end
+
+    # this method assumes the caller holds the socket mutex
+    def socket
+      return @socket if @socket
+      @socket = self.class.context.socket(ZMQ::DEALER)
+      raise "ZMQ error on socket creation: #{ZMQ::Util.error_string}" if @socket.nil?
+      if LogjamAgent.ensure_ping_at_exit
+        ensure_ping_at_exit
+      else
+        at_exit { reset }
+      end
+      @socket.setsockopt(ZMQ::LINGER, @config[:linger])
+      @socket.setsockopt(ZMQ::SNDHWM, @config[:snd_hwm])
+      @socket.setsockopt(ZMQ::RCVHWM, @config[:rcv_hwm])
+      @socket.setsockopt(ZMQ::RCVTIMEO, @config[:rcv_timeo])
+      @socket.setsockopt(ZMQ::SNDTIMEO, @config[:snd_timeo])
+      spec = connection_specs.sort_by{rand}.first
+      @socket.connect(spec)
+      @socket
+    end
+
     def publish(app_env, key, data)
       info = pack_info(@sequence = next_fixnum(@sequence))
       parts = [app_env, key, data, info]
       if socket.send_strings(parts, ZMQ::DONTWAIT) < 0
+        error = ZMQ::Util.error_string
         reset if connection_specs.size > 1
-        raise "ZMQ error on publishing: #{ZMQ::Util.error_string}"
+        raise "ZMQ error on publishing: #{error}"
       end
     end
 
-    private
-
     def log_warning(message)
       LogjamAgent.error_handler.call ForwardingWarning.new(message)
     end
@@ -117,12 +133,12 @@ module LogjamAgent
       answer_parts = []
       if socket.send_strings(request_parts) < 0
         log_warning "ZMQ error on sending: #{ZMQ::Util.error_string}"
-        reset
+        reset_without_locking
         return nil
       end
       if socket.recv_strings(answer_parts) < 0
         log_warning "ZMQ error on receiving: #{ZMQ::Util.error_string}"
-        reset
+        reset_without_locking
         return nil
       end
       if answer_parts.first != "" || !VALID_RESPONSE_CODES.include?(answer_parts.second.to_s.to_i)
@@ -132,8 +148,10 @@ module LogjamAgent
     end
 
     def ping
-      if @socket && !send_receive("ping", @app_env, "{}", NO_COMPRESSION)
-        log_warning "failed to receive pong"
+      @socket_mutex.synchronize do
+        if @socket && !send_receive("ping", @app_env, "{}", NO_COMPRESSION)
+          log_warning "failed to receive pong"
+        end
       end
     end
 

data/test/sinatra_app.rb

@@ -0,0 +1,32 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'logjam_agent/sinatra'
+
+class SinatraTestApp < Sinatra::Base
+  register LogjamAgent::Sinatra
+
+  use LogjamAgent::Sinatra::Middleware
+
+  configure do
+    set :root, File.expand_path('../..', __FILE__)
+    set :environment, :test
+    set :loglevel, :debug
+    setup_logjam_logger
+
+    LogjamAgent.application_name = "myapp"
+    LogjamAgent.add_forwarder(:zmq, :host => "inproc://app")
+    LogjamAgent.parameter_filters << :password
+    LogjamAgent.ensure_ping_at_exit = false
+  end
+
+  before '/index' do
+    action_name "Simple#index"
+  end
+
+  get '/index' do
+    logger.info 'Hello World!'
+    'Hello World!'
+  end
+
+  run! if __FILE__ == $0
+end

data/test/sinatra_classic_app.rb

@@ -0,0 +1,31 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'logjam_agent/sinatra'
+
+use LogjamAgent::Sinatra::Middleware
+
+configure do
+  set :root, File.expand_path('../..', __FILE__)
+  set :environment, :test
+  set :loglevel, :debug
+  setup_logjam_logger
+
+  LogjamAgent.application_name = "myapp"
+  LogjamAgent.add_forwarder(
+    :zmq,
+    :host => "localhost",
+    :port => 9604,
+    :linger     => 10,
+    :snd_hwm    => 10,
+    :rcv_hwm    => 10,
+    :rcv_timeo  => 10,
+    :snd_timeo  => 10
+  )
+  LogjamAgent.parameter_filters << :password
+end
+
+get '/index' do
+  action_name "Simple#index"
+  logger.info 'Hello World!'
+  'Hello World!'
+end

data/test/sinatra_classic_test.rb

@@ -0,0 +1,20 @@
+require_relative "test_helper.rb"
+require_relative "sinatra_classic_app"
+require "rack/test"
+
+module LogjamAgent
+  class SinatraClassicTest < MiniTest::Test
+
+    include ::Rack::Test::Methods
+
+    def app
+      ::Sinatra::Application
+    end
+
+    def test_root
+      get '/index?mumu=1&password=5'
+      assert_equal 'Hello World!', last_response.body
+    end
+
+  end
+end

data/test/sinatra_test.rb

@@ -0,0 +1,54 @@
+require_relative "test_helper.rb"
+require_relative "sinatra_app"
+require "rack/test"
+
+module LogjamAgent
+  class SinatraTest < MiniTest::Test
+    def setup
+      @@receiver ||= LogjamAgent::Receiver.new
+      LogjamAgent.enable!
+    end
+
+    def teardown
+      LogjamAgent.disable!
+    end
+
+    def logjam_message
+      @@receiver.receive
+    end
+
+    include ::Rack::Test::Methods
+
+    def app
+      SinatraTestApp
+    end
+
+    def test_root
+      get '/index?mumu=1&password=5'
+      assert_equal 'Hello World!', last_response.body
+      assert_equal 200, last_response.status
+
+      stream, topic, payload = logjam_message
+      assert_equal "myapp-test", stream
+      assert_equal "logs.myapp.test", topic
+      assert_equal 200, payload["code"]
+      assert_equal "Simple#index", payload["action"]
+      assert_kind_of Float, payload["total_time"]
+      assert_kind_of String, payload["started_at"]
+      assert_kind_of Integer, payload["started_ms"]
+      assert_kind_of String, payload["ip"]
+      # assert_kind_of Float, payload["view_time"]
+      lines = payload["lines"]
+      assert_match(/Started GET.*password=\[FILTERED\]/, lines[0][2])
+      assert_match(/Hello World/, lines[1][2])
+      assert_match(/Completed 200 OK/, lines[2][2])
+      assert_nil(lines[3])
+      request_info = payload["request_info"]
+      method, url, query_parameters = request_info.values_at(*%w(method url query_parameters))
+      assert_equal method, "GET"
+      assert_equal url, "/index?mumu=1&password=[FILTERED]"
+      assert_equal(query_parameters, { "mumu" => "1", "password" => "[FILTERED]" })
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -1,11 +1,16 @@
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest/pride' if ENV['RAINBOW_COLORED_TESTS'] == "1" && $stdout.tty?
-require 'mocha/setup'
-
-require_relative "../lib/logjam_agent"
+require 'mocha/minitest'
 
 class MiniTest::Test
   require "active_support/testing/declarative"
   extend ActiveSupport::Testing::Declarative
 end
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require "logjam_agent"
+require "logjam_agent/receiver"
+
+# for Sinatra
+ENV['RACK_ENV'] = "test"

data/test/util_test.rb

@@ -24,5 +24,10 @@ module LogjamAgent
       assert_equal "tcp://a:1", augmented
     end
 
+    test "supports inproc" do
+      augmented = augment_connection_spec("inproc://hugo-schnugo", 2)
+      assert_equal "inproc://hugo-schnugo", augmented
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.29.6
+  version: 0.32.2
 platform: ruby
 authors:
 - Stefan Kaes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +184,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq-core
   requirement: !ruby/object:Gem::Requirement
@@ -185,32 +227,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
 - README.md
 - Rakefile
 - lib/logjam_agent.rb
 - lib/logjam_agent/actionpack/lib/action_dispatch/middleware/remote_ip.rb
+- lib/logjam_agent/active_support/core_ext/array/extract.rb
+- lib/logjam_agent/active_support/parameter_filter.rb
 - lib/logjam_agent/buffered_logger.rb
 - lib/logjam_agent/forwarders.rb
 - lib/logjam_agent/middleware.rb
+- lib/logjam_agent/monkey_patches/ffi-rzmq-patch.rb
 - lib/logjam_agent/rack/logger.rb
+- lib/logjam_agent/rack/rails_support.rb
+- lib/logjam_agent/rack/sinatra_request.rb
 - lib/logjam_agent/railtie.rb
+- lib/logjam_agent/receiver.rb
 - lib/logjam_agent/request.rb
+- lib/logjam_agent/sinatra.rb
 - lib/logjam_agent/syslog_like_formatter.rb
 - lib/logjam_agent/util.rb
 - lib/logjam_agent/version.rb
 - lib/logjam_agent/zmq_forwarder.rb
-- logjam_agent.gemspec
-- script/console
 - test/request_test.rb
+- test/sinatra_app.rb
+- test/sinatra_classic_app.rb
+- test/sinatra_classic_test.rb
+- test/sinatra_test.rb
 - test/test_helper.rb
 - test/util_test.rb
 - test/zmq_forwarder_test.rb
-homepage: ''
-licenses: []
+homepage: https://github.com/skaes/logjam_agent
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,12 +275,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Logjam client library to be used with logjam
 test_files:
+- test/sinatra_app.rb
+- test/sinatra_classic_test.rb
+- test/sinatra_classic_app.rb
 - test/request_test.rb
-- test/test_helper.rb
-- test/util_test.rb
 - test/zmq_forwarder_test.rb
+- test/util_test.rb
+- test/test_helper.rb
+- test/sinatra_test.rb