nav-logger 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f1a39fee5ed7b1569a38d0edf614307e52fc09e
-  data.tar.gz: 47404afcb426ecb98252047c7576c00dd55ac4d7
+  metadata.gz: efbd45d44835cf65d532397c25413d30ef449ca6
+  data.tar.gz: 824873b52dde3b536f20c0f9c06fa97fa0cd8074
 SHA512:
-  metadata.gz: 55b5572ce252b6bcb64956f877690608171e6faa5276be4cdcb457ed5581743d4ac0b13a40c31632b24caa03c0f267264f4007ae74a14549045a1d4f4af19efa
-  data.tar.gz: d0d38f9b8651597e906cb6330bc634ecd336c0a042592df1e7b0cf42f9e628afb7ea264e6a5a5fa6c1100c8d1853401492d1582b808fd6a9a90cb4b2ac7726e6
+  metadata.gz: 32822765b8bde721698481db10e2f035305b0578d9d447972ee8ae6614553cc57ea394e888bd73212aa6134f528949e82f7c0f26aee982742cd2fb34b2fd95ff
+  data.tar.gz: f176b7ab2fc284f8a4b6498c1f14b9d70642c1649c04640793bf7023b1338036ee0f4f4b932f0060fc4d1065b2fc0e1cd8aab8c976116877c397b47ef9043474

data/.gitignore

@@ -4,6 +4,7 @@
 /Gemfile.lock
 /_yardoc/
 /pkg/
+/vendor/
 
 # Test files #
 /coverage

data/README.md

@@ -12,15 +12,31 @@ gem "nav-logger"
 
 And then execute:
 
-    $ bundle
+`$ bundle`
 
 Or install it yourself as:
 
-    $ gem install nav-logger
+`$ gem install nav-logger`
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Rails
+
+If you only want to tag your Rails logs with request and session ids, you just need to include the gem in your gemfile.
+
+If you also want logs being sent to the aggregator, you need add the following to the application.rb:
+```ruby
+config.middleware.use Nav::Logger::RequestLogger
+```
+
+#### Rack
+
+After installing gem into rack app, add in the config.ru
+```ruby
+use Nav::Logger::Middleware::RequestTagger
+use Nav::Logger::Middleware::RequestLogger
+```
+_Make sure RequestTagger comes before RequestLogger_
 
 ## Development
 
@@ -36,4 +52,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/credit
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/nav/logger.rb

@@ -6,9 +6,14 @@ require "socket"
 require "nav/logger/base_logger"
 require "nav/logger/console_logger"
 require "nav/logger/default_logger"
+require "nav/logger/httparty_formatter"
+require "nav/logger/middleware/request_logger"
+require "nav/logger/middleware/request_tagger"
 require "nav/logger/test_logger"
 require "nav/logger/version"
 
+require "nav/logger/rails/logger_tie" if defined?(::Rails)
+
 module Nav
   module_function
 
@@ -33,3 +38,9 @@ module Nav
     end
   end
 end
+
+if defined? HTTParty
+  HTTParty::Logger.add_formatter :nav, Nav::Logger::HTTPartyFormatter
+  #HTTParty.logger Nav.logger, :debug, :nav
+  #HTTParty.headers "X-Request-Id" => RequestStore[:request_id]
+end

data/lib/nav/logger/base_logger.rb

@@ -4,7 +4,9 @@ module Nav
       attr_reader :fluent_logger
 
       def level
-        @level ||= ::Logger::DEBUG
+        return @level if defined? @level
+        self.level = ENV["LOG_LEVEL"] || "info"
+        @level
       end
 
       def level_name(lookup = level)
@@ -44,6 +46,15 @@ module Nav
         add ::Logger::FATAL, message, hash
       end
 
+      def post(tag, hash)
+        full_hash = generate_log_hash hash
+        @fluent_logger.post tag, full_hash
+      end
+
+      def log_tag(secondary_tag)
+        [app_tag, secondary_tag.downcase].compact.join "."
+      end
+
       private
 
         def add(severity, message, hash)
@@ -51,8 +62,13 @@ module Nav
           return true if severity < level
 
           severity_name = level_name severity
-          log_hash = generate_log_hash severity_name, message, hash
-          @fluent_logger.post tag(severity_name), log_hash
+
+          hash[:level] = severity_name
+          hash[:message] = message
+
+          log_hash = generate_log_hash hash
+
+          @fluent_logger.post log_tag(severity_name), log_hash
         end
 
         def app_tag
@@ -68,18 +84,16 @@ module Nav
           @hostname ||= Socket.gethostname
         end
 
-        def generate_log_hash(severity, message, input)
+        def generate_log_hash(input = {})
           hash = input.merge RequestStore.store
-          hash.merge! message: message,
-                      level: severity,
-                      ts: Time.now.to_f,
+          hash.merge! ts: Time.now.to_f,
                       environment: environment,
-                      hostname: hostname
-          hash
+                      hostname: hostname,
+                      pid: pid
         end
 
-        def tag(severity)
-          [app_tag, severity.downcase].compact.join "."
+        def pid
+          @pid ||= Process.pid
         end
     end
   end

data/lib/nav/logger/console_logger.rb

@@ -1,8 +1,48 @@
 module Nav
   module Logger
     class ConsoleLogger < BaseLogger
+      # Mapping of color/style names to ANSI control values
+      CODEMAP = {
+        normal: 0,
+        bold: 1,
+        black: 30,
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
+        magenta: 35,
+        cyan: 36,
+        white: 37
+      }
+
+      # Map of log levels to colors
+      LEVELMAP = {
+        "FATAL" => :red,
+        "ERROR" => :red,
+        "WARN" => :yellow,
+        "INFO" => :green, # default color
+        "DEBUG" => :cyan
+      }
+
       def initialize
         @fluent_logger = Fluent::Logger::ConsoleLogger.open STDOUT
+
+        # Adds colorized loigging
+        def @fluent_logger.post_with_time(tag, map, time)
+          a = [time.strftime(@time_format), " ", tag, ":"]
+          map.each_pair { |k,v|
+            a << " #{k}="
+            a << JSON.dump(v)
+          }
+
+          color = LEVELMAP[map[:level]] || :green
+
+          a.unshift "\e[#{CODEMAP[color]}m"
+          a << "\e[#{CODEMAP[:normal]}m"
+
+          post_text a.join
+          true
+        end
       end
     end
   end

data/lib/nav/logger/file_logger.rb

@@ -0,0 +1,11 @@
+module Nav
+  module Logger
+    class FileLogger < BaseLogger
+      def initialize(path)
+        @fluent_logger = Fluent::Logger::ConsoleLogger.new path
+        io = @fluent_logger.instance_variable_get "@io"
+        io.sync = true
+      end
+    end
+  end
+end

data/lib/nav/logger/httparty_formatter.rb

@@ -0,0 +1,88 @@
+module Nav
+  module Logger
+    class HTTPartyFormatter
+      OUT = ">".freeze
+      IN = "<".freeze
+
+      attr_accessor :level, :logger
+
+      def initialize(logger, level)
+        @logger = logger
+        @level = level.to_sym
+        @messages = []
+      end
+
+      def format(request, response)
+        @request = request
+        @response = response
+
+        library_line = caller.detect{ |line| line !~ /httparty/ }
+
+        log_request
+        log_response
+
+        logger.send level, messages.join("\n"), caller: library_line
+      end
+
+      private
+
+      attr_reader :request, :response
+      attr_accessor :messages
+
+      def log_request
+        log_url
+        log_headers
+        log_query
+        log OUT, request.raw_body if request.raw_body
+        log OUT
+      end
+
+      def log_response
+        log IN, "HTTP/#{response.http_version} #{response.code}"
+        log_response_headers
+        log IN, "\n#{response.body}"
+        log IN
+      end
+
+      def log_url
+        http_method = request.http_method.name.split("::").last.upcase
+        uri = if request.options[:base_uri]
+                request.options[:base_uri] + request.path.path
+              else
+                request.path.to_s
+              end
+
+        log OUT, "#{http_method} #{uri}"
+      end
+
+      def log_headers
+        return unless request.options[:headers] && request.options[:headers].size > 0
+
+        log OUT, "Headers: "
+        log_hash request.options[:headers]
+      end
+
+      def log_query
+        return unless request.options[:query]
+
+        log OUT, "Query: "
+        log_hash request.options[:query]
+      end
+
+      def log_response_headers
+        headers = response.respond_to?(:headers) ? response.headers : response
+        response.each_header do |response_header|
+          log IN, "#{response_header.capitalize}: #{headers[response_header]}"
+        end
+      end
+
+      def log_hash(hash)
+        hash.each { |k, v| log(OUT, "#{k}: #{v}") }
+      end
+
+      def log(direction, line = "")
+        messages << "#{direction} #{line}"
+      end
+    end
+  end
+end

data/lib/nav/logger/middleware/request_logger.rb

@@ -0,0 +1,53 @@
+module Nav
+  module Logger
+    module Middleware
+      class RequestLogger
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          start_time = Time.now
+          status, headers, body = @app.call env
+          [status, headers, [body]]
+        ensure
+          log_request start_time, env, status, headers
+        end
+
+        private
+          def log_request(start_time, env, status, headers)
+            rack_log_hash = {
+              remote_addr: env["HTTP_X_FORWARDED_FOR"] || env["REMOTE_ADDR"] || "-",
+              remote_user: env["REMOTE_USER"] || "-",
+              request_method: env[Rack::REQUEST_METHOD],
+              request_path: env[Rack::PATH_INFO],
+              query_string: env[Rack::QUERY_STRING].empty? ? "" : "?#{env[Rack::QUERY_STRING]}",
+              status: status.to_s[0..3],
+              content_length: extract_content_length(headers),
+              duration: Time.now - start_time,
+              level: status_level(status)
+            }
+            tag = Nav.logger.log_tag "http"
+            Nav.logger.post tag, rack_log_hash
+          end
+
+          def status_level(status)
+            return "ERROR" if status.nil?
+            case status.to_i
+              when 400..499 then "WARN"
+              when 500..599 then "ERROR"
+              else               "INFO"
+            end
+          end
+
+          def extract_content_length(headers)
+            return "-" if headers.nil?
+            value = headers[Rack::CONTENT_LENGTH] or return "-"
+            value.to_s == "0" ? "-" : value
+          end
+
+      end
+    end
+  end
+end

data/lib/nav/logger/middleware/request_tagger.rb

@@ -0,0 +1,36 @@
+module Nav
+  module Logger
+    module Middleware
+      class RequestTagger
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          setup_request_store
+          store_request_var env
+          @app.call env
+        ensure
+          clear_request_store
+        end
+
+        private
+          def setup_request_store
+            RequestStore.begin!
+          end
+
+          def store_request_var(env)
+            RequestStore[:request_id] = env["HTTP_X_REQUEST_ID"] || SecureRandom.uuid
+            RequestStore[:session_id] = env["HTTP_X_SESSION_ID"] if env.key? "HTTP_X_SESSION_ID"
+          end
+
+          def clear_request_store
+            RequestStore.end!
+            RequestStore.clear!
+          end
+
+      end
+    end
+  end
+end

data/lib/nav/logger/rails/logger_tie.rb

@@ -0,0 +1,27 @@
+module Nav
+  module Logger
+    module Rails
+      class LoggerTie < ::Rails::Railtie
+        initializer "logger_tie.configure_rails_initialization" do |app|
+
+          # We add the request id and session it from the RequestStore as tags
+          # on all Rails logs.
+          app.config.log_tags ||= []
+          app.config.log_tags << lambda { |_arg| RequestStore[:request_id] }
+          app.config.log_tags << lambda { |_arg| RequestStore[:session_id] }
+
+          # We insert the nav logger middleware into the middleware stack.  We
+          # need to insert it before the Rails::Rack::Logger, since that is when
+          # the tag lambdas get executed. If the Nav Logger middleware hasn't
+          # already been run the request store will be empty and the lambdas
+          # will come back nil.
+          app.config.middleware.insert_before(
+            ::Rails::Rack::Logger,
+            Nav::Logger::Middleware::RequestTagger
+          )
+
+        end
+      end
+    end
+  end
+end

data/lib/nav/logger/version.rb

@@ -1,5 +1,5 @@
 module Nav
   module Logger
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.4".freeze
   end
 end

data/nav-logger.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "fluent-logger", "~> 0.6.1"
-  spec.add_dependency "request_store"
+  spec.add_dependency "request_store", "~> 1.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nav-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - JohnnyT
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -28,16 +28,16 @@ dependencies:
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
 description: 
 email:
 - ubergeek3141@gmail.com
@@ -63,6 +63,11 @@ files:
 - lib/nav/logger/base_logger.rb
 - lib/nav/logger/console_logger.rb
 - lib/nav/logger/default_logger.rb
+- lib/nav/logger/file_logger.rb
+- lib/nav/logger/httparty_formatter.rb
+- lib/nav/logger/middleware/request_logger.rb
+- lib/nav/logger/middleware/request_tagger.rb
+- lib/nav/logger/rails/logger_tie.rb
 - lib/nav/logger/test_logger.rb
 - lib/nav/logger/version.rb
 - nav-logger.gemspec
@@ -86,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Nav's logger
 test_files: []
-has_rdoc: