logjam_agent 0.9.0 → 0.9.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGVlMTVjMWMzMTI1YzcxNzM3NTExZTc1MjQ3NmJkOTcxN2VhOTcyYw==
+    ZDhjMTU4YjU0MGMxMzVkN2JjNzhiOTU0ZjhhYjRkZTljY2ZkZTM5Mg==
   data.tar.gz: !binary |-
-    YWI2N2Q1NTFkOTMxMTRlZWQwMjNlYWVlZGZmZGI1YjhmZGE4NDQwZA==
+    MWE0YzJiZWE3YjE3YjI4MzZiOTY5OGYyODExZWFkOWI0NWM0ZDBjNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWEzMTVkNTUyNDUxMTZmZDUyNTY3YTNlMDI2NmI2YzgzMjM1NDI1ZWU0MmEz
-    MzdjZTA4ZmVjZTZiNjVkNTliOGU3ZmFhMTEzOTRkNGI1NzYyNmNlNTdkNWYw
-    ZTdkNjNjNjdlNWMxMjA4MmYwY2JmYmZmOTdiZGE5ZjAxNGZkMTc=
+    MDc1ZmQyZTdlZjRkNjFmMjhlMzQ2NWQ0MGJjM2E3YWVhMGEzYjZiMTEzOWI0
+    NzQ5YjExMWRhMTQxOWY5MmM4ODllN2EwOWIxMjQyNjAwODk5MmJhMWJiOWRh
+    M2RiZGRmMTEyMmE0M2U3ZWY0Zjk5ODg2ZjlmYzRlOWEwOTg5NjA=
   data.tar.gz: !binary |-
-    MDFlYTczMzNjMThlNDlmNTE0OTJmZTdlNzE4MTdmMzQ1OWU0MTRmYmEyODA0
-    ODkzOTJjOTZmZTA4NThmZjBkZTk0YjM5ZmRjNTUyNWMwZmNkMDI1OWJlZjM5
-    NzYwY2VhMTlhNjQwYTQ5NDUxZTU1MjQ3NjBlNzczZThkM2ZlODM=
+    ZTRjMGUzMjFjN2M5ODVmNTczYzJjMmQ3Y2UyNzA4NjY3YjhjMTI5ODA4ZjMz
+    ODJkNzIwNjAzMjRlZGQ4YjE4ODZhODQ1ZGQwYmM0OTQ5YjcyZWViZjdjYWJk
+    YjVlNWRkMWRmOTZhZWYwYjhiYjEzMjhlNDlkNTQ4ODY5ZDg1NGI=

data/README.md

@@ -0,0 +1,86 @@
+# Logjam Agent
+
+Client side library for logjam.
+
+Hooks into Rails, collects log lines, performance metrics, error/exception infomation and Rack
+environment information and sends this data to [Logjam](https://github.com/skaes/logjam_app).
+
+Currently two alternate mechanisms are available for data transport: AMQP or ZeroMQ.
+
+## Usage
+
+For AMQP, add
+
+    gem "logjam_agent"
+    gem "bunny"
+
+For ZeroMQ, add
+
+    gem "logjam_agent"
+    gem "ffi-rzmq"
+
+to your Gemfile.
+
+Add an initializer
+    config/initializers/logjam_agent.rb
+to your app and configure class LogjamAgent.
+
+````ruby
+    module LogjamAgent
+      # Configure the application name (required). Must not contain dots of hyphens.
+      self.application_name = "myapp"
+
+      # Configure the environment name (optional). Defaults to Rails.env.
+      # self.environment_name = Rails.env
+
+      # Configure request data forwarder for ZeroMQ.
+      add_forwarder(:zmq, :host => "logjam.instance.at.your.org", :port => 9605)
+
+      # Configure request data forwarder for ZeroMQ.
+      # add_forwarder(:amqp, :host => "message.broker.at.your.org"))
+
+      # Configure ip obfuscation. Defaults to no obfuscation.
+      self.obfuscate_ips = true
+
+      # Configure cookie obfuscation. Defaults to [/_session\z/].
+      # self.obfuscated_cookies = [/_session\z/]
+    end
+````
+
+## Troubleshooting
+
+If the agent experiences problems when sending data, it will log information to a file named
+`logjam_agent_error_log` which you can find under `Rails.root/log`.
+
+This behavior is customizable via a module level call back method:
+
+    LogjamAgent.error_handler = lambda {|exception| ... }
+
+# License
+
+The MIT License
+
+Copyright (c) 2013 Stefan Kaes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+
+
+

data/lib/logjam_agent.rb

@@ -47,8 +47,13 @@ module LogjamAgent
   mattr_accessor :logger
   self.logger = nil
 
+  mattr_accessor :forwarding_error_logger
+  self.forwarding_error_logger = nil
+
   mattr_accessor :error_handler
-  self.error_handler = lambda { |exception| }
+  self.error_handler = lambda do |exception|
+    forwarding_error_logger.error "#{exception.class.name}: #{exception.message}" if forwarding_error_logger
+  end
 
   mattr_accessor :application_name
   self.application_name = nil
@@ -82,6 +87,21 @@ module LogjamAgent
   mattr_accessor :disabled
   self.disabled = false
 
+  mattr_accessor :obfuscate_ips
+  self.obfuscate_ips = false
+
+  # TODO: ipv6 obfuscation
+  def self.ip_fuscator(ip)
+    obfuscate_ips ? ip.to_s.sub(/\d+\z/, 'XXX') : ip
+  end
+
+  mattr_accessor :obfuscated_cookies
+  self.obfuscated_cookies = [/_session\z/]
+
+  def self.cookie_obfuscator
+    @cookie_obfuscator ||= ActionDispatch::Http::ParameterFilter.new(obfuscated_cookies)
+  end
+
   extend RequestHandling
 
   mattr_accessor :exception_classes
@@ -109,6 +129,7 @@ module LogjamAgent
   end
 
   def self.auto_detect_logged_exceptions
+    return if @_exception_auto_detection_initialized
     determine_loaded_exception_classes
     Exception.class_eval <<-"EOS"
       def self.inherited(subclass)
@@ -116,6 +137,7 @@ module LogjamAgent
         ::LogjamAgent.reset_exception_matcher
       end
     EOS
+    @_exception_auto_detection_initialized = true
   end
 
   # setup uuid generation
@@ -152,6 +174,14 @@ module LogjamAgent
     forwarder.forward(encode_payload(fields), :routing_key => events_routing_key)
   end
 
+  def self.add_forwarder(type, *args)
+    case type
+    when :zmq then Forwarders.add(ZMQForwarder.new(*args))
+    when :amqp then Forwarders.add(AMQPForwarder.new(*args))
+    else raise ArgumentError.new("unkown logjam transport: '#{type}'")
+    end
+  end
+
   private
 
   def self.events_routing_key

data/lib/logjam_agent/amqp_forwarder.rb

@@ -5,10 +5,11 @@ module LogjamAgent
 
     attr_reader :app, :env
 
-    def initialize(app, env, opts = {})
-      @app = app
-      @env = env
-      @config = default_options(app, env).merge!(opts)
+    def initialize(*args)
+      opts = args.extract_options!
+      @app = args[0] || LogjamAgent.application_name
+      @env = args[1] || LogjamAgent.environment_name
+      @config = default_options(@app, @env).merge!(opts)
       @exchange = @bunny = nil
       ensure_bunny_gem_is_available
     end

data/lib/logjam_agent/rack/logger.rb

@@ -53,11 +53,11 @@ module LogjamAgent
         path = request.filtered_path
 
         logjam_fields = LogjamAgent.request.fields
-        logjam_fields.merge!(:started_at => start_time.iso8601, :ip => request.remote_ip, :host => @hostname)
+        ip = LogjamAgent.ip_fuscator(request.remote_ip)
+        logjam_fields.merge!(:started_at => start_time.iso8601, :ip => ip, :host => @hostname)
         logjam_fields.merge!(extract_request_info(request))
 
-        debug ""
-        info "Started #{request.request_method} \"#{path}\" for #{request.ip} at #{start_time.to_default_s}"
+        info "Started #{request.request_method} \"#{path}\" for #{ip} at #{start_time.to_default_s}"
       end
 
       def after_dispatch(env, result, run_time_ms)
@@ -108,7 +108,7 @@ module LogjamAgent
         result
       end
 
-      HIDDEN_VARIABLES = /\A([a-z]|SERVER|PATH|GATEWAY|REQUEST|SCRIPT|REMOTE|QUERY|PASSENGER|DOCUMENT|SCGI|UNION_STATION|ORIGINAL_FULLPATH|RAW_POST_DATA)/o
+      HIDDEN_VARIABLES = /\A([a-z]|SERVER|PATH|GATEWAY|REQUEST|SCRIPT|REMOTE|QUERY|PASSENGER|DOCUMENT|SCGI|UNION_STATION|ORIGINAL_|ROUTES_|RAW_POST_DATA)/o
 
       TRANSLATED_VARIABLES = /\A(HTTP|CONTENT_LENGTH|CONTENT_TYPE)/
 
@@ -118,6 +118,7 @@ module LogjamAgent
 
       REFERER = 'HTTP_REFERER'
       CONTENT_LENGTH = 'CONTENT_LENGTH'
+      COOKIE = 'HTTP_COOKIE'
 
       KV_RE   = '[^&;=]+'
       PAIR_RE = %r{(#{KV_RE})=(#{KV_RE})}
@@ -133,6 +134,12 @@ module LogjamAgent
           end
         end
 
+        if cookie = headers[COOKIE]
+          headers[COOKIE] = cookie.gsub(PAIR_RE) do |_|
+            LogjamAgent.cookie_obfuscator.filter([[$1, $2]]).first.join("=")
+          end
+        end
+
         headers.keys.each do |k|
           if t = TRANSLATED_KEYS[k]
             headers[t] = headers.delete(k)

data/lib/logjam_agent/railtie.rb

@@ -8,12 +8,15 @@ module LogjamAgent
   autoload :Middleware, 'logjam_agent/middleware'
 
   class Railtie < Rails::Railtie
+    def logjam_log_path(app)
+      paths = app.config.paths
+      (Rails::VERSION::STRING < "3.1" ? paths.log.to_a : paths['log']).first.to_s
+    end
 
     initializer "initialize_logjam_agent_logger", :before => :initialize_logger do |app|
       Rails.logger ||= app.config.logger ||
         begin
-          paths = app.config.paths
-          path = (Rails::VERSION::STRING < "3.1" ? paths.log.to_a : paths['log']).first.to_s
+          path = logjam_log_path(app)
           logger = LogjamAgent::BufferedLogger.new(path)
           logger.level = ::Logger.const_get(app.config.log_level.to_s.upcase)
           logger.formatter = LogjamAgent::SyslogLikeFormatter.new
@@ -38,9 +41,19 @@ module LogjamAgent
     end
 
     initializer "logjam_agent", :after => "time_bandits" do |app|
+      LogjamAgent.environment_name = Rails.env
+      LogjamAgent.auto_detect_logged_exceptions
+
       app.config.middleware.swap("TimeBandits::Rack::Logger", "LogjamAgent::Rack::Logger")
       app.config.middleware.insert_before("LogjamAgent::Rack::Logger", "LogjamAgent::Middleware")
 
+      # install a default error handler for forwarding errors
+      log_dir = File.dirname(logjam_log_path(app))
+      forwarding_error_logger = ::Logger.new("#{log_dir}/logjam_agent_error.log")
+      forwarding_error_logger.level = ::Logger::ERROR
+      forwarding_error_logger.formatter = ::Logger::Formatter.new
+      LogjamAgent.forwarding_error_logger = forwarding_error_logger
+
       # patch controller testing to create a logjam request, because middlewares aren't executed
       if Rails.env.test?
         ActiveSupport.on_load(:action_controller) do
@@ -58,7 +71,7 @@ module LogjamAgent
       end
     end
 
-    # make
+    # avoid garbled tempfile information in the logs
     ActiveSupport.on_load(:action_controller) do
       ActionDispatch::Http::UploadedFile.class_eval <<-"EVA"
         def to_hash

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/logjam_agent/zmq_forwarder.rb

@@ -2,10 +2,11 @@ module LogjamAgent
   class ZMQForwarder
     attr_reader :app, :env
 
-    def initialize(app, env, opts = {})
-      @app = app
-      @env = env
-      @config = default_options(app, env).merge!(opts)
+    def initialize(*args)
+      opts = args.extract_options!
+      @app = args[0] || LogjamAgent.application_name
+      @env = args[1] || LogjamAgent.environment_name
+      @config = default_options(@app, @env).merge!(opts)
       @exchange = @config[:exchange]
       @zmq_hosts = Array(@config[:host])
       @zmq_port = @config[:port]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/logjam_agent.rb
 - lib/logjam_agent/amqp_forwarder.rb

data/README.rdoc

@@ -1,8 +0,0 @@
-== Logjam Agent
-
-Client side library for logjam.
-
-Provides a customized logger, which logs lines and sends combined request information via
-AMQP or ZeroMQ to logjam.
-
-