logjam_agent.rb

require "socket"
require "time_bandits"
require "logjam_agent/monkey_patches/ffi-rzmq-patch"

# monkey patch log levels to include NONE
require "logger"
module Logger::Severity
  NONE = UNKNOWN + 1
end

require "logjam_agent/version"
require "logjam_agent/util"
require "logjam_agent/obfuscation"
require "logjam_agent/zmq_forwarder"
require "logjam_agent/forwarders"
require "logjam_agent/request"
require "logjam_agent/selective_logging"
require "logjam_agent/request_handling"
require "logjam_agent/buffered_logger"
require "logjam_agent/logging_attributes"
require "logjam_agent/syslog_like_formatter"
require "logjam_agent/railtie" if defined?(Rails::Railtie)

module LogjamAgent

  class ForwardingError < StandardError; end
  class ForwardingWarning < StandardError; end

  mattr_accessor :logger
  self.logger = nil

  mattr_accessor :log_format
  self.log_format = :text

  mattr_accessor :forwarding_error_logger
  self.forwarding_error_logger = nil

  mattr_accessor :error_handler
  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

  mattr_accessor :environment_name
  self.environment_name = nil

  mattr_accessor :application_revision
  self.application_revision = nil

  mattr_accessor :action_name_proc
  self.action_name_proc = lambda{|name| name}

  mattr_accessor :parameter_filters
  self.parameter_filters = []

  def self.get_hostname
    name = Socket.gethostname
    host = name.split('.').first
    Addrinfo.getaddrinfo(host, nil, nil, :STREAM, nil, Socket::AI_CANONNAME).first.canonname rescue name
  end

  mattr_accessor :hostname
  self.hostname = self.get_hostname

  def self.disable!
    self.disabled = true
  end

  def self.enable!
    self.disabled = false
  end

  mattr_accessor :disabled
  self.disabled = false

  mattr_accessor :ensure_ping_at_exit
  self.ensure_ping_at_exit = true

  extend Obfuscation
  extend RequestHandling
  extend SelectiveLogging

  NO_COMPRESSION = 0
  ZLIB_COMPRESSION = 1
  SNAPPY_COMPRESSION = 2
  LZ4_COMPRESSION= 3

  mattr_reader :compression_method
  def self.compression_method=(compression_method)
    case compression_method
    when SNAPPY_COMPRESSION
      begin
        require "snappy"
        @@compression_method = SNAPPY_COMPRESSION
      rescue LoadError
        # do nothing
      end
    when LZ4_COMPRESSION
      begin
        require "ruby-lz4"
        @@compression_method = LZ4_COMPRESSION
      rescue LoadError
        # do nothing
      end
    when NO_COMPRESSION, ZLIB_COMPRESSION
      @@compression_method = compression_method
    else
      raise ArgumentError.new("unknown compression method")
    end
  end
  self.compression_method = NO_COMPRESSION

  mattr_accessor :exception_classes
  self.exception_classes = []

  mattr_accessor :exception_matcher
  self.exception_matcher = nil

  mattr_accessor :ignored_request_urls
  self.ignored_request_urls = []

  mattr_accessor :ignore_asset_requests
  self.ignore_asset_requests = false

  mattr_accessor :ignore_render_events
  self.ignore_render_events = false

  mattr_accessor :log_device_ignored_lines
  self.log_device_ignored_lines = nil

  mattr_accessor :max_logged_param_size
  self.max_logged_param_size = 1024

  mattr_accessor :max_logged_cookie_size
  self.max_logged_cookie_size = 1024 * 100

  def self.max_logged_size_for(key)
    if key == 'HTTP_COOKIE'.freeze
      max_logged_cookie_size
    else
      max_logged_param_size
    end
  end

  mattr_accessor :max_line_length
  self.max_line_length = 2048

  mattr_accessor :max_bytes_all_lines
  self.max_bytes_all_lines = 1024 * 1024

  mattr_accessor :log_device_log_level
  self.log_device_log_level = Logger::INFO

  mattr_accessor :split_hard_and_soft_exceptions
  self.split_hard_and_soft_exceptions = true

  def self.log_to_log_device?(severity, msg)
    return false if severity < log_device_log_level
    if override_global_ignore_lines?
      msg !~ request.log_device_ignored_lines
    else
      !(log_device_ignored_lines && msg =~ log_device_ignored_lines)
    end
  rescue
    true
  end

  mattr_accessor :exception_auto_detection_level
  self.exception_auto_detection_level = Logger::ERROR

  def self.auto_detect_exception(exception_class)
    # ignore Exception classes created with Class.new (timeout.rb, my old friend)
    if (class_name = exception_class.to_s) =~ /^[\w:]+$/
      exception_classes << class_name unless exception_classes.include?(class_name)
    end
  end

  def self.reset_exception_matcher
    self.exception_matcher = Regexp.new(self.exception_classes.map{|e| Regexp.escape(e)}.join("|"))
  end

  def self.determine_loaded_exception_classes
    ObjectSpace.each_object(Class) do |klass|
      auto_detect_exception(klass) if klass != Exception && klass.ancestors.include?(Exception)
    end
    reset_exception_matcher
  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)
        ::LogjamAgent.auto_detect_exception(subclass)
        ::LogjamAgent.reset_exception_matcher
      end
    EOS
    @_exception_auto_detection_initialized = true
  end

  # setup uuid generation
  begin
    require "uuid4r"
    def self.generate_uuid
      UUID4R::uuid(4).gsub('-','')
    end
  rescue LoadError
    def self.generate_uuid
      SecureRandom.uuid.gsub('-','')
    end
  end

  # setup json encoding
  begin
    require "oj"
    def self.json_encode_payload(data)
      Oj.dump(data, :mode => :compat)
    end
  rescue LoadError
    def self.json_encode_payload(data)
      data.to_json
    end
  end

  def self.encode_payload(data)
    json = json_encode_payload(data)
    case compression_method
    when SNAPPY_COMPRESSION
      Snappy.deflate(json)
    when LZ4_COMPRESSION
      n = data.byte_size
      max_compressed_size = n + n/256 + 16
      buf = String.new([n].pack("N"), capacity: max_compressed_size + 4)
      LZ4::Raw.compress(json, input_size: n, dest: buf, max_ouput_size: max_compressed_size).first
    when ZLIB_COMPRESSION
      ActiveSupport::Gzip.compress(json)
    else
      json
    end
  end

  def self.decode_payload(data)
    case compression_method
    when SNAPPY_COMPRESSION
      Snappy.inflate(data)
    when LZ4_COMPRESSION
      uncompressed_size = data[0..3].unpack("N")
      buf = String.new("", capacity: uncompressed_size)
      LZ4::Raw.decompress(data[4..-1], uncompressed_size, dest: buf).first
    when ZLIB_COMPRESSION
      ActiveSupport::Gzip.decompress(data)
    else
      data
    end
  end

  def self.event(label, extra_fields = {})
    fields = {
      :label      => label,
      :started_at => Time.now.iso8601,
      :host       => hostname,
      :uuid       => generate_uuid
    }
    fields.merge!(extra_fields)
    forwarder.forward(fields, :routing_key => events_routing_key, :sync => true)
  end

  def self.add_forwarder(type, *args)
    case type
    when :zmq then Forwarders.add(ZMQForwarder.new(*args))
    when :amqp then ArgumentError.new("logjam amqp transport no longer supported")
    else raise ArgumentError.new("unkown logjam transport: '#{type}'")
    end
  end

  private

  def self.events_routing_key
    "events.#{application_name}.#{environment_name}"
  end

  def self.forwarder
    @forwarder ||= Forwarders.get(application_name, environment_name)
  end

  def self.override_global_ignore_lines?
    request && request.log_device_ignored_lines
  end

end