pier_logging 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d355c6b8850fce6ffea3a958ade583412cc4d315668c2b3795924ec281ceb1e
-  data.tar.gz: 0c3382adb12ff55ebb201468f6470b722baa6344460a62b8666be0effba6a07c
+  metadata.gz: eff84f20b75432ad8b9677f443507f89618bb16cb10fb540cea1f15e9ef38f44
+  data.tar.gz: 3ccee8b70edaf743e2a4696eb1b405c505b0d6d6d2aaffd565d761e318feca21
 SHA512:
-  metadata.gz: 9cb167ecc0b099d029a22b7c60a9d8ad2f8dddf0e586435d936a0344c1b6d3da0e6a8630ddc8e5ad3cb60d0271d56d4e1063ee385064fb7534b31735031b7ce9
-  data.tar.gz: 68c003813d5e5bdb3aa07ee1008cd16e6faad3361d6add6849f3503e6aaadc8621ca86c6fe192719f71c12a20b21f3d602ff06f5ab8f35aa768fd38103d6319a
+  metadata.gz: 16da7e85dbb12163a9bc5c9d660258ef51b0d968e55be28c04159cad2481ed62f3349e902a3dd9cc74417ec15c4d8bb0d3decab17cd717eecdb39a404d821b48
+  data.tar.gz: 88f4e611ab39c17fdb669bae02cffd16a6466e8c11d1403a9a60c84aceb834f707d212e72f908ca532fd1802c1522e1c497229082cf0a7b55235662287258e3a

data/.github/CODEOWNERS

@@ -0,0 +1,40 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*               @pier-digital/backend
+.github/*       @pier-digital/backend @pier-digital/devops
+bin/*           @pier-digital/backend @pier-digital/devops
+
+# # Order is important; the last matching pattern takes the most
+# # precedence. When someone opens a pull request that only
+# # modifies JS files, only @js-owner and not the global
+# # owner(s) will be requested for a review.
+# *.js    @js-owner
+
+# # You can also use email addresses if you prefer. They'll be
+# # used to look up users just like we do for commit author
+# # emails.
+# *.go docs@example.com
+
+# # In this example, @doctocat owns any files in the build/logs
+# # directory at the root of the repository and any of its
+# # subdirectories.
+# /build/logs/ @doctocat
+
+# # The `docs/*` pattern will match files like
+# # `docs/getting-started.md` but not further nested files like
+# # `docs/build-app/troubleshooting.md`.
+# docs/*  docs@example.com
+
+# # In this example, @octocat owns any file in an apps directory
+# # anywhere in your repository.
+# apps/ @octocat
+
+# # In this example, @doctocat owns any file in the `/docs`
+# # directory in the root of your repository.
+# /docs/ @doctocat
+

data/README.md

@@ -1,8 +1,6 @@
 # PierLogging
 
-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/pier_logging`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A gem developed by [PIER](https://www.pier.digital/) to standardize our logs (request and general-purpose)
 
 ## Installation
 
@@ -22,17 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+- Create an initializer at `config/initializers/pier_logging.rb` to configure the gem.
+- Configure General-purpose logging, Request logging and register the request logger rails middleware.
+- Configure your logger on `config/application.rb` to use `PierLogging::Logger`
+
+### General-purpose logging
+
+Use `PierLogging.configure_logger` block to configure general-purpose logs. Accepted configs are:
+
+| config    | Required | Type                      | Default                            |
+| --------- | --------:| -------------------------:| ----------------------------------:|
+| app_name  | true     | string                    | nil                                |
+| env       | true     | string                    | nil                                |
+| formatter | false    | `Ougai::Formatters::Base` | `PierLogging::Formatter::Json.new` |
+
+### Request logging
+
+Use `PierLogging.configure_request_logger` block to configure request logs. Accepted configs are:
+
+| config           | Required | Type            | Default    |
+| ---------------- | --------:| ---------------:| ----------:|
+| enabled          | false    | boolean         | false      |
+| user_info_getter | true     | block (headers) | nil        |
+
+The block passed to `user_info_getter` receives the headers of the request so you can use your headers to define the username or role. 
 
-## Development
+You have at your disposal the following helper methods:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- has_basic_credentials(headers): checks if there are basic auth credentials in the header
+- get_basic_credentials_user(headers): get the user from the basic auth credential
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Example
+
+```ruby
+# config/initializers/pier_logging.rb
+
+PierLogging.configure_logger do |config|
+  config.app_name = Rails.application.class.module_parent_name.underscore.dasherize
+  config.env = Rails.env
+  config.formatter = Rails.env.production? ? PierLogging::Formatter::Json.new : 
+    PierLogging::Formatter::Readable.new
+end 
+
+PierLogging.configure_request_logger do |config|
+  config.user_info_getter do |headers|
+    if headers['MY-USER-HEADER'].present?
+      { username: headers['MY-USER-HEADER']  }
+    elsif has_basic_credentials?(headers)
+      { username: get_basic_credentials_user(headers) }
+    else
+      { username: 'anonymous' }
+    end
+  end
+  config.enabled = ENV.fetch('REQUEST_LOG_ENABLED', 'true') == 'true'
+end
+
+Rails.application.config.middleware.use PierLogging::RequestLogger, PierLogging::Logger.new(STDOUT)
+```
+
+```ruby
+# config/application.rb
+
+# ...
+config.logger = PierLogging::Logger.new(STDOUT)
+# ...
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pier_logging.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pier-digital/pier_logging.
 
 ## License
 

data/lib/pier_logging.rb

@@ -57,12 +57,13 @@ module PierLogging
       @enabled = false
     end
 
-    def user_info_getter(&block)
-      raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless block_given?
-      @user_info_getter = block
+    def user_info_getter=(proc)
+      raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless proc.is_a? Proc
+      @user_info_getter = proc
     end
     
     def enabled=(enabled = false)
+      raise ArgumentError, "Config 'enabled' must be a 'boolean'" unless !!enabled == enabled
       @enabled = enabled
     end
   end

data/lib/pier_logging/request_logger.rb

@@ -88,11 +88,11 @@ module PierLogging
 
     def parse_body(body)
       if body.is_a? String # when string
-        JSON.parse(body, nil, allow_blank: true)
+        Oj.load(body, allow_blank: true)
       elsif body.is_a? Array # Grape body
-        JSON.parse(body.last, nil, allow_blank: true)
+        Oj.load(body.last, allow_blank: true)
       elsif body.is_a? ActionDispatch::Response::RackBody # Rails body
-        JSON.parse(body.body, nil, allow_blank: true)
+        Oj.load(body.body, allow_blank: true)
       else
         body
       end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pier_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mauricio Banduk
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/workflows/publish.yml"
 - ".gitignore"
 - ".ruby-version"