httplog 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5d566f72650b5c55a8ae3dfc25dd551b9779eccce87cd307b31a0e134e25443
-  data.tar.gz: 6842fc573dfe4dc2e747b4c480b2a03c547813a05fc0bec13263af20c8a599b5
+  metadata.gz: 899f0ffc584e0b7c88daa0e6895502f4d1a20d850d59ae1483de9dac829346f3
+  data.tar.gz: ee045f1978c1955ef213382b166bcf6e824fe42c352704476b3683ef0c495f54
 SHA512:
-  metadata.gz: 61809a350f2a87225e275d49691539a10081ae8e4457c772cdc056fc9788c2c11913bf63647e76b3d5b81da2c6aaf83e4405e8224adc1120e04eabedd8f3b541
-  data.tar.gz: ac37ba6e331d1a553925b13361ea786728e20f608bddb9f3037b9fbb346ece62577def82c18319e9ae397e00c5bcccfd0b7637ea642c0659118c94689dfa0c37
+  metadata.gz: a7a9ae16ba3ff2391021c8284d4e0ff43c40b30bfed7f33d8f288312410a527dec550af3eb993c355e8e6d07132fa46378b09dc6535ffdea00650d256e34c9c6
+  data.tar.gz: 58f22a5832993eefef75b2a2a3f9e6ab6c41286553b404b44e2df8fbee3a6623116b7729222a3ef842380969ea8edc53b9dd4b93755b612594b1f473560d2b3f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.3 - 2019-11-14
+
+* [#83](https://github.com/trusche/httplog/pull/83) Support for graylog
+
 ## 1.3.1 - 2019-06-07
 
 * [#76](https://github.com/trusche/httplog/pull/76) Added configurable logger method

data/README.md

@@ -76,6 +76,9 @@ HttpLog.configure do |config|
   # You can also log in JSON format
   config.json_log = false
 
+  # For Graylog you can set this to `true`
+  config.graylog = false
+
   # Prettify the output - see below
   config.color = false
 
@@ -118,6 +121,18 @@ HttpLog.configure do |config|
 end
 ```
 
+If you use Graylog and want to use its search features such as "rounded_benchmark:>1 AND method:PUT",
+you can use this configuration:
+
+```ruby
+HttpLog.configure do |config|
+  config.logger        = <your GELF::Logger>
+  config.logger_method = :add
+  config.severity      = GELF::Levels::DEBUG
+  config.graylog       = true
+end
+```
+
 For more color options please refer to the [rainbow documentation](https://github.com/sickill/rainbow)
 
 ### Compact logging
@@ -232,19 +247,3 @@ This will launch a simple rack server on port 9292 and run all tests locally aga
 If you have any issues with or feature requests for httplog,
 please [open an issue](https://github.com/trusche/httplog/issues) on GitHub
 or fork the project and send a pull request. **Please include passing specs with all pull requests.**
-
-### Contributors
-
-Thanks to these fine folks for contributing pull requests:
-
-* [Doug Johnston](https://github.com/dougjohnston)
-* [Eric Cohen](https://github.com/eirc)
-* [Nikos Dimitrakopoulos](https://github.com/nikosd)
-* [Marcos Hack](https://github.com/marcoshack)
-* [Andrew Hammond](https://github.com/andrhamm)
-* [Chris Keele](https://github.com/christhekeele)
-* [Ryan Souza](https://github.com/ryansouza)
-* [Ilya Bondarenko](https://github.com/sedx)
-* [Kostas Zacharakis](https://github.com/kzacharakis)
-* [Yuri Smirnov](https://github.com/tycooon)
-* [Manuel Bustillo Alonso](https://github.com/bustikiller)

data/httplog.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'excon', ['~> 0.60']
   gem.add_development_dependency 'faraday', ['~> 0.14']
   gem.add_development_dependency 'guard-rspec', ['~> 4.7']
-  gem.add_development_dependency 'http', ['~> 3.0']
+  gem.add_development_dependency 'http', ['~> 4.0']
   gem.add_development_dependency 'httparty', ['~> 0.16']
   gem.add_development_dependency 'httpclient', ['~> 2.8']
   gem.add_development_dependency 'listen', ['~> 3.0']

data/lib/httplog/configuration.rb

@@ -5,6 +5,7 @@ module HttpLog
     attr_accessor :enabled,
                   :compact_log,
                   :json_log,
+                  :graylog,
                   :logger,
                   :logger_method,
                   :severity,
@@ -28,6 +29,7 @@ module HttpLog
       @enabled               = true
       @compact_log           = false
       @json_log              = false
+      @graylog               = false
       @logger                = Logger.new($stdout)
       @logger_method         = :log
       @severity              = Logger::Severity::DEBUG

data/lib/httplog/http_log.rb

@@ -31,6 +31,8 @@ module HttpLog
     def call(options = {})
       if config.json_log
         log_json(options)
+      elsif config.graylog
+        log_graylog(options)
       elsif config.compact_log
         log_compact(options[:method], options[:url], options[:response_code], options[:benchmark])
       else
@@ -111,7 +113,7 @@ module HttpLog
 
       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.
+        # the content, so the response body is not available here.
         raise BodyParsingError, '(not available yet)'
       end
 
@@ -147,38 +149,6 @@ module HttpLog
       log("#{method.to_s.upcase} #{masked(uri)} completed with status code #{status} in #{seconds.to_f.round(6)} seconds")
     end
 
-    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
-
     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
@@ -199,6 +169,50 @@ module HttpLog
 
     private
 
+    def log_json(data = {})
+      return unless config.json_log
+
+      log(json_payload(data).to_json)
+    end
+
+    def log_graylog(data = {})
+      result = json_payload(data)
+
+      result[:rounded_benchmark] = data[:benchmark].round
+      result[:short_message]     = result.delete(:url)
+      config.logger.public_send(config.logger_method, config.severity, result)
+    end
+
+    def json_payload(data = {})
+      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
+        {
+          method:        data[:method].to_s.upcase,
+          url:           masked(data[:url]),
+          response_code: data[:response_code].to_i,
+          benchmark:     data[:benchmark]
+        }
+      else
+        {
+          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]
+        }
+      end
+    end
+
     def masked(msg, key=nil)
       return msg if config.filter_parameters.empty?
       return msg if msg.nil?

data/lib/httplog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpLog
-  VERSION = '1.3.2'.freeze
+  VERSION = '1.3.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement