cx_log 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2d7e420b20d5a986adba26eeb6277079e8d8ae882c056d1d6d12f0c5b3c14e
-  data.tar.gz: 9f48d8bd501b4bc0219d77226531062cce81bb7f96ed8ca8bab030bfee1ea4c2
+  metadata.gz: 77157e52dd674aaf049dcd64095bc28d917c0cdeedbc8075a6414fbc7843e50f
+  data.tar.gz: 1d833fa429d8f00fc7380d86dd1b9ff5d61847b5739613ef316654c1edd42979
 SHA512:
-  metadata.gz: 107ecb4bbe102ee3d1cd4a4c6b64919745dc0ea7c6e8aebd5e792a7a1fcbde3de835895280bd26bf65a44b53e6033bf9eb0ec7d2b778f878e2bca72bf501f711
-  data.tar.gz: 10ec92d839bd0f4d8dbc8c535c60d46e7557dbd52a1181f94a6c2a0a4355e847a8748330be159d4b55d2f3835d77406d3b96e51e5b44b2b65318d281f2a96474
+  metadata.gz: 7261d32b7baf464ad4f0da80f04f09758db05721353367f534f8a28b99fe58d08a9197dd4d39ad57dfdd52aa7e9bcef006e91f626d65aabcfa4fca384cfd543e
+  data.tar.gz: 03a2cf1022dee28cc7d6758cb82a4afcc35f9af0e13c7d0a5a68aa3c17f6bedde8fbbe9e2a0435d19da33ccedd9b951117c63a259fd40885a3c2c5a28265b5c6

data/README.md

@@ -1,24 +1,91 @@
 # CxLog
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cx_log`. To experiment with that code, run `bin/console` for an interactive prompt.
+Trying to debug an issue by looking at multiple logs is often cumbersome. 
+CxLog allows you to create a single log line for a context (request, background job, etc.) in your application.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+    $ bundle add cx_log
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+    $ gem install cx_log
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+CxLog generates structured logs. All logs will have a `message` attribute (that can be overwritten) using `CxLog.add`.
+In order to add an attribute the log, use `CxLog.add`:
+
+```ruby
+    CxLog.log(message: 'test', foo: 'bar')
+```
+Flushing the log will generate `{"message":"test","foo":"bar"}`.
+
+CxLog supports multiple values per key:
+
+```ruby
+    CxLog.log(message: 'test', foo: 'bar')
+    # some code
+    CxLog.add(foo: 'baz')
+```
+
+Flushing the log will generate `{"message":"test","foo":["bar","baz"]}`.
+
+### Rails
+If you are using Rails, you can use the CxLog middleware to automatically generate context logs.
+
+Add the following to your `config/application.rb`:
+
+```ruby
+    config.middleware.use CxLog::Middleware
+```
+
+### Log Format
+By default, CxLog generates logs in JSON format.
+You can use your own or choose one that is shipped with the gem
+
+```ruby
+  CxLog.options = { 
+    formatter: CxLog::Formatters::KeyValueFormatter.new 
+  }
+```
+
+If you are using Rails middleware, you can set the formatter in an initializer:
+
+```ruby
+  config.middleware.use CxLog::Middleware, formatter: CxLog::Formatters::KeyValueFormatter.new
+```
+
+### Filter Parameters
+CxLog supports filtering parameters by default. But, you can overwrite the list of filter parameters by
+setting the `filter_parameters` option:
+
+```ruby
+  CxLog.options = { 
+    filter_parameters: ['password', 'secret']
+  }
+```
+
+If you are using Rails middleware, you can set the filter parameters in an initializer:
+
+```ruby
+  config.middleware.use CxLog::Middleware, filter_parameters: ['password', 'secret']
+```
+
+The log will replace the value of sensitive parameters with `[FILTERED]`:
+```
+{"message":"","request_id":"b41e3733-3ca6-46e9-a968-73e995443ec2",
+ "controller":"posts","action":"index","method":"GET","post_count":1,
+ "password":"[FILTERED]"}
+```
+
 
 ## Development
 

data/lib/cx_log/log.rb

@@ -34,7 +34,8 @@ module CxLog
 
     def default_options
       {
-        formatter: CxLog::Formatters::Json.new
+        formatter: CxLog::Formatters::Json.new,
+        filter_parameters: %i[passw secret token key _key salt cert]
       }
     end
 
@@ -65,8 +66,23 @@ module CxLog
 
     def flush(logger)
       log_level = @context.key?(:error) ? :error : :info
-      logger.public_send(log_level, @options[:formatter].call(@context))
+      logger.public_send(log_level, @options[:formatter].call(sanitized_context))
       clear
     end
+
+    def sanitized_context
+      @context.to_a.map do |key, value|
+        if sensitive_key?(key)
+          [key, "[FILTERED]"]
+        else
+          [key, value]
+        end
+      end.to_h
+    end
+
+    def sensitive_key?(key)
+      regex = Regexp.union(@options[:filter_parameters].map(&:to_s))
+      key.to_s.match?(regex)
+    end
   end
 end

data/lib/cx_log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CxLog
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cx_log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ankit Gupta