module HttpLog

Constants

LOG_PREFIX
PARAM_MASK

Attributes

http_configuration[W]

Public Class Methods

call(options = {}) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 31
def call(options = {})
  if config.json_log
    log_json(options)
  elsif config.compact_log
    log_compact(options[:method], options[:url], options[:response_code], options[:benchmark])
  else
    HttpLog.log_request(options[:method], options[:url] )
    HttpLog.log_headers(options[:request_headers])
    HttpLog.log_data(options[:request_body])
    HttpLog.log_status(options[:response_code])
    HttpLog.log_benchmark(options[:benchmark])
    HttpLog.log_headers(options[:response_headers])
    HttpLog.log_body(options[:response_body], options[:encoding], options[:content_type])
  end
end
colorize(msg) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 238
def colorize(msg)
  return msg unless config.color
  if config.color.is_a?(Hash)
    msg = Rainbow(msg).color(config.color[:color]) if config.color[:color]
    msg = Rainbow(msg).bg(config.color[:background]) if config.color[:background]
  else
    msg = Rainbow(msg).color(config.color)
  end
  msg
rescue StandardError
  warn "HTTPLOG CONFIGURATION ERROR: #{config.color} is not a valid color"
  msg
end
config()
Alias for: configuration
configuration() click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 18
def configuration
  @http_configuration ||= HttpConfiguration.new
end
Also aliased as: config
configure() { |configuration| ... } click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 27
def configure
  yield(configuration)
end
log(msg) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 105
def log(msg)
  return unless config.enabled

  config.logger.public_send(config.logger_method, config.severity, colorize(prefix + msg))
end
log_benchmark(seconds) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 138
def log_benchmark(seconds)
  return unless config.log_benchmark

  log("Benchmark: #{seconds.to_f.round(6)} seconds")
end
log_body(body, encoding = nil, content_type = nil) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 144
def log_body(body, encoding = nil, content_type = nil)
  return unless config.log_response

  data = parse_body(body, encoding, content_type)

  if config.prefix_response_lines
    log('Response:')
    log_data_lines(data)
  else
    log("Response:\n#{data}")
  end
rescue BodyParsingError => e
  log("Response: #{e.message}")
end
log_compact(method, uri, status, seconds) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 196
def log_compact(method, uri, status, seconds)
  return unless config.compact_log
  status = Rack::Utils.status_code(status) unless status == /\d{3}/
  log("#{method.to_s.upcase} #{masked(uri)} completed with status code #{status} in #{seconds.to_f.round(6)} seconds")
end
log_connection(host, port = nil) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 111
def log_connection(host, port = nil)
  return if config.json_log || config.compact_log || !config.log_connect

  log("Connecting: #{[host, port].compact.join(':')}")
end
log_data(data) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 183
def log_data(data)
  return unless config.log_data

  data = utf_encoded(masked(data.dup).to_s) unless data.nil?

  if config.prefix_data_lines
    log('Data:')
    log_data_lines(data)
  else
    log("Data: #{data}")
  end
end
log_headers(headers = {}) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 123
def log_headers(headers = {})
  return unless config.log_headers

  masked(headers).each do |key, value|
    log("Header: #{key}: #{value}")
  end
end
log_json(data = {}) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 202
def log_json(data = {})
  return unless config.json_log

  data[:response_code] = transform_response_code(data[:response_code]) if data[:response_code].is_a?(Symbol)

  parsed_body = begin
    parse_body(data[:response_body], data[:encoding], data[:content_type])
  rescue BodyParsingError => e
    e.message
  end

  if config.compact_log
    log({
      method: data[:method].to_s.upcase,
      url: masked(data[:url]),
      response_code: data[:response_code].to_i,
      benchmark: data[:benchmark]
    }.to_json)
  else
    log({
      method: data[:method].to_s.upcase,
      url: masked(data[:url]),
      request_body: masked(data[:request_body]),
      request_headers: masked(data[:request_headers].to_h),
      response_code: data[:response_code].to_i,
      response_body: parsed_body,
      response_headers: data[:response_headers].to_h,
      benchmark: data[:benchmark]
    }.to_json)
  end
end
log_request(method, uri) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 117
def log_request(method, uri)
  return unless config.log_request

  log("Sending: #{method.to_s.upcase} #{masked(uri)}")
end
log_status(status) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 131
def log_status(status)
  return unless config.log_status

  status = Rack::Utils.status_code(status) unless status == /\d{3}/
  log("Status: #{status}")
end
parse_body(body, encoding, content_type) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 159
def parse_body(body, encoding, content_type)
  unless text_based?(content_type)
    raise BodyParsingError, "(not showing binary data)"
  end

  if body.is_a?(Net::ReadAdapter)
    # open-uri wraps the response in a Net::ReadAdapter that defers reading
    # the content, so the reponse body is not available here.
    raise BodyParsingError, '(not available yet)'
  end

  if encoding =~ /gzip/ && body && !body.empty?
    begin
      sio = StringIO.new(body.to_s)
      gz = Zlib::GzipReader.new(sio)
      body = gz.read
    rescue Zlib::GzipFile::Error
      log("(gzip decompression failed)")
    end
  end

  utf_encoded(body.to_s, content_type)
end
reset!() click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 23
def reset!
  @http_configuration = nil
end
save_in_db(options = {}) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 47
def save_in_db(options = {})
  #log("Connecting rails.http_client #{config.http_request_tracking_measurement} : #{config.http_request_tracking_id}")
  x_request_id = "AL_NONE"
  #al_txn_uid = nil
  al_request_id = "AL_NONE"
  al_request_guid = "AL_NONE"
  al_request_client_id = "AL_NONE"

  options[:request_headers].each do |header,value|
    al_request_client_id = value if(header === "al-request-client-id")
    #al_source = value if(header === "al-source")
    al_request_id = Thread.current["al_request_id"] if Thread.current["al_request_id"]
    al_request_guid = Thread.current["al_request_guid"] if Thread.current["al_request_guid"]

    #al_txn_uid = value if(header === config.http_request_tracking_id)
  end

  data = nil

  if options[:timestamp]
    data = {
        values: {value: options[:benchmark] ,  al_request_id: al_request_id, al_request_guid: al_request_guid, al_request_client_id: al_request_client_id},
        tags:   {app_name:  Rails.application.class.parent, url:  options[:url], method: options[:method], response_code: options[:response_code], location: InfluxDB::Rails.current.location},
        timestamp: options[:timestamp]
    }
  else
    data = {
        values: {value: options[:benchmark] , al_request_id: al_request_id, al_request_client_id: al_request_client_id},
        tags:   {app_name:  Rails.application.class.parent, url:    options[:url], method: options[:method], response_code: options[:response_code], location: InfluxDB::Rails.current.location},
    }
  end

  InfluxDB::Rails.client.write_point config.http_request_tracking_measurement, data
end
series(options = {}) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 82
def series(options = {})
    {
        value: options[:benchmark]
    }
  
end
tags(options = {}) click to toggle source
Calls superclass method
# File lib/influxdb/rails/httplog/http_log.rb, line 89
def tags(options = {})
  tags = {
      method:      options[:method],
      url:         options[:url],
      app_name:    configuration.application_name,
      host:      Socket.gethostname
  }
  super(tags)
end
transform_response_code(response_code_name) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 234
def transform_response_code(response_code_name)
  Rack::Utils::HTTP_STATUS_CODES.detect { |_k, v| v.to_s.casecmp(response_code_name.to_s).zero? }.first
end
url_approved?(url) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 99
def url_approved?(url)
  return false if config.url_blacklist_pattern && url.to_s.match(config.url_blacklist_pattern)

  !config.url_whitelist_pattern || url.to_s.match(config.url_whitelist_pattern)
end

Private Class Methods

hash_classes() click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 288
def hash_classes
  @hash_classes ||= begin
    hash_classes = [Hash, Enumerator]
    hash_classes << HTTP::Headers if defined?(HTTP::Headers)
    hash_classes
  end
end
log_data_lines(data) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 314
def log_data_lines(data)
  data.each_line.with_index do |line, row|
    if config.prefix_line_numbers
      log("#{row + 1}: #{line.chomp}")
    else
      log(line.strip)
    end
  end
end
masked(msg, key=nil) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 254
def masked(msg, key=nil)
  return msg if config.filter_parameters.empty?
  return msg if msg.nil?

  # If a key is given, msg is just the value and can be replaced
  # in its entirety.
  return (config.filter_parameters.include?(key.downcase) ? PARAM_MASK : msg) if key

  # Otherwise, we'll parse Strings for key=valye pairs...
  case msg
  when *string_classes
    config.filter_parameters.reduce(msg) do |m,key|
      m.to_s.gsub(/(#{key})=[^&]+/i, "#{key}=#{PARAM_MASK}")
    end
  # ...and recurse over hashes
  when *hash_classes
    Hash[msg.map {|k,v| [k, masked(v, k)]}]
  else
    log "*** FILTERING NOT APPLIED BECAUSE #{msg.class} IS UNEXPECTED ***"
    msg
  end
end
prefix() click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 324
def prefix
  if config.prefix.respond_to?(:call)
    config.prefix.call
  else
    config.prefix.to_s
  end
end
string_classes() click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 277
def string_classes
  @string_classes ||= begin
    string_classes = [String]
    string_classes << HTTP::Response::Body if defined?(HTTP::Response::Body)
    string_classes << HTTP::URI if defined?(HTTP::URI)
    string_classes << URI::HTTP if defined?(URI::HTTP)
    string_classes << HTTP::FormData::Urlencoded if defined?(HTTP::FormData::Urlencoded)
    string_classes
  end
end
text_based?(content_type) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 306
def text_based?(content_type)
  # This is a very naive way of determining if the content type is text-based; but
  # it will allow application/json and the like without having to resort to more
  # heavy-handed checks.
  content_type =~ /^text/ ||
    content_type =~ /^application/ && !['application/octet-stream', 'application/pdf'].include?(content_type)
end
utf_encoded(data, content_type = nil) click to toggle source
# File lib/influxdb/rails/httplog/http_log.rb, line 296
def utf_encoded(data, content_type = nil)
  charset = content_type.to_s.scan(/; charset=(\S+)/).flatten.first || 'UTF-8'
  begin
    data.force_encoding(charset)
  rescue StandardError
    data.force_encoding('UTF-8')
  end
  data.encode('UTF-8', invalid: :replace, undef: :replace)
end