plogger 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a24e99ff9521bc048ab680b75e40167c7e16fbff
-  data.tar.gz: a6c6248a29d724b6c3eb3a72ea025c541c590e06
+  metadata.gz: fc41038c272be6e564f2bc10134e8d2eaf2003b9
+  data.tar.gz: 63c6b363aef8983d227fe68c70a2b007152d2e88
 SHA512:
-  metadata.gz: 169c36b1bb0cab81074afbef97a44748b4e0d13ec1cc80a3c8b7d1e25c6bf332c3448da2b9988f554d4d3747c70ea42b5dbad104ec4e63751fc440c3b91e882b
-  data.tar.gz: 9b0f62923040fadb5cf4868b2e0d49d30bbbab20a10c846bf2c62ab074a7cef0b5c34229276cc4833d312fd0f941c1e520ebbccfafa3bab0ee4a2402ff761a7b
+  metadata.gz: 159632fb6b98fe904c4a29dfc53b74f749096cdccbeeca222d955ec9c580d908e1a30d46ef2afeb37605b975b190d08bc01ceb00ba9260b5e1b9048c55c9ccc6
+  data.tar.gz: d536f5088365d1ae780c7f145f644e6470b9825e41958734c93a08a05c3ea438d8081a261da4909035d040afb02f327c1c48f072b17fb8604bd67dd0a461e0f4

data/.gitignore

@@ -1,12 +1,10 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
-plogger-*.gem
+plogger-*.gem

data/.rspec

@@ -1,3 +1,2 @@
 --format documentation
 --color
---require spec_helper

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.0
-before_install: gem install bundler -v 1.16.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in plogger.gemspec
+# Specify your gem's dependencies in Plogger.gemspec
 gemspec

data/{plogger.gemspec → Plogger.gemspec}

@@ -1,13 +1,13 @@
-
-lib = File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "plogger/version"
+require 'plogger/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "plogger"
   spec.version       = Plogger::VERSION
   spec.authors       = ["Daniel Merrill"]
-  spec.email         = ["danielmerrill6@gmail.com"]
+  spec.email         = ["daniel@papinotas.com"]
 
   spec.summary       = "Phoenix Logging Interface."
   spec.description   = "Provides a standard way to generate logs in the application."

data/README.md

@@ -1,39 +1,59 @@
 # Plogger
 
-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/plogger`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Introduction
 
-TODO: Delete this and the text above, and describe your gem
+Plogger stands for Papinotas Logger or Phoenix Logger (our current project, which raised the need for this gem). Plogger is a simple logging gem which receives a little more information than `Rails.Logger`, and can also send an exception to third party APIs (currently only Raven is supported). Plogger outputs the log in a parser friendly format, ready for other software such as Logstash to process it.
 
-## Installation
+## Instalation
 
-Add this line to your application's Gemfile:
+Add `gem 'plogger'` to your gemfile.
+
+## Configuring
 
 ```ruby
-gem 'plogger'
+# environments/[Environment].rb
+Rails.application.configure do
+  Plogger.configure do |config|
+    config.logger = ActiveSupport::Logger.new(STDOUT) # Or whatever logger you want to configure
+    config.module = 'MainModule' # Optional
+    config.raven_dsn = 'http://public:secret@example.com/project-id' # Optional
+  end
+end
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install plogger
-
 ## Usage
 
-TODO: Write usage instructions here
+The usage is similar to how you use the Rails Logger, but you can also log exceptions.
 
-## Development
+```ruby
+begin
+  1/0
+rescue e
+  trace = Plogger.exception(e, category: 'Bundle Creation')
+  # => trace = "130AH93MWS2"
+  return render "Too bad, an exception was raised. Read the full error at #{trace}"
+end
+trace_2 = Plogger.info("Processing ready", category: 'Bundle Creation')
+render "Your process finished successfully, check the logs at #{trace_2}"
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Plogger has the following methods: `exception`, `error`, `warning`, `info`, `debug`. It will use the logger you supplied in the config to output them, so make sure you have enabled the log level you are trying to use.
 
-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).
+## Params
 
-## Contributing
+Each of these methods can receive the following keyword params:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plogger.
+| Param         | Explanation   | Default   |
+| ------------- |---------------|-----------|
+| category      | Use it to categorize the thing you are logging, so you can later group related logs in Kibana or something |''|
+| type | Use it to manifest if the current log is generated by a system action or a user action | 'system' |
+| user_id      | Use it to track the user that is generating the log | ''
+| account_id | In Phoenix we use accounts (a user can have many accounts). You can track that too | '' |
+| extra_info | A hash with additional tags you can print in the log | {} |
 
-## License
+Example call:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+Plogger.info("Processing ready", type: 'user', category: "Bundle Creation", user_id: 1, extra_info: {happy: "yes"})
+# Will output 'Processing ready -- trace=194fjx43gp type='user' category='Bundle Creation' user_id=1 happy='yes'
+```

data/bin/console

@@ -11,4 +11,4 @@ require "plogger"
 # Pry.start
 
 require "irb"
-IRB.start(__FILE__)
+IRB.start

data/lib/Plogger/config.rb

@@ -0,0 +1,9 @@
+module Plogger
+  class Config
+    attr_accessor :raven_dsn, :logger, :module
+
+    def initialize(logger)
+      @logger = logger
+    end
+  end
+end

data/lib/Plogger/formatter.rb

@@ -0,0 +1,24 @@
+module Plogger
+  class Formatter
+    def self.format(message, trace, type: 'system', user_id: nil, account_id: nil, category: '', extra_info: {})
+      result = "#{message} -- trace='#{trace}'"
+      args = {type: type, category: category, user_id: user_id, account_id: account_id}
+      args.each do |key, value|
+        result = add_param_to_message(result, key, value) unless value.nil?
+      end
+
+      extra_info.keys.each do |key|
+        result = add_param_to_message(result, key, extra_info[key])
+      end
+      result
+    end
+
+    def self.add_param_to_message(message, key, value)
+      result = message
+      is_string = value.class == String
+      result += " #{key}=#{is_string ? "'" : ''}#{value}#{is_string ? "'" : ''}"
+      result
+    end
+
+  end
+end

data/lib/Plogger/handler.rb

@@ -0,0 +1,70 @@
+require 'plogger/id_generator'
+require 'plogger/formatter'
+
+module Plogger
+  class Handler
+    def initialize(config)
+      @logger = config.logger
+      @module = config.module
+      @raven_dsn = config.raven_dsn
+    end
+
+    def handle_exception(exception, type: '', category: '', user_id: nil, account_id: nil, extra_info: {})
+      unless @raven_dsn == nil || @raven_dsn.blank?
+        Raven.user_context(id: user_id)
+        Raven.tags_context(account_id: account_id)
+        Raven.capture_exception(exception)
+      end
+      handle_error(exception.message, category: category, user_id: user_id, account_id: account_id,
+                                      extra_info: extra_info, type: type)
+    end
+
+    def handle_error(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+      result = generate_id_and_message(message, category: category, user_id: user_id,
+                                                account_id: account_id, type: type,
+                                                extra_info: generate_extra_info(extra_info))
+      @logger.error(result[:message])
+      result[:trace]
+    end
+
+    def handle_warning(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+      result = generate_id_and_message(message, category: category, user_id: user_id,
+                                                account_id: account_id, type: type,
+                                                extra_info: generate_extra_info(extra_info))
+      @logger.warn(result[:message])
+      result[:trace]
+    end
+
+    def handle_info(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+      result = generate_id_and_message(message, category: category, user_id: user_id,
+                                                account_id: account_id, type: type,
+                                                extra_info: generate_extra_info(extra_info))
+      @logger.info(result[:message])
+      result[:trace]
+    end
+
+    def handle_debug(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+      result = generate_id_and_message(message, category: category, user_id: user_id,
+                                                account_id: account_id, type: type,
+                                                extra_info: generate_extra_info(extra_info))
+      @logger.debug(result[:message])
+      result[:trace]
+    end
+
+    private
+
+    def generate_id_and_message(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+      trace = Plogger::IdGenerator.generate
+      formatted_message = Plogger::Formatter.format(message, trace, user_id: user_id,
+                                                                    account_id: account_id,
+                                                                    category: category,
+                                                                    type: type,
+                                                                    extra_info: extra_info)
+      {trace: trace, message: formatted_message}
+    end
+
+    def generate_extra_info extra_info
+      extra_info.merge({module: @module})
+    end
+  end
+end

data/lib/Plogger/id_generator.rb

@@ -0,0 +1,11 @@
+module Plogger
+  class IdGenerator
+    def self.generate
+      [('a'..'z'), ('A'..'Z'), (0..9)].map(&:to_a).flatten.shuffle[0, id_length].join
+    end
+
+    def self.id_length
+      10
+    end
+  end
+end

data/lib/Plogger/version.rb

@@ -0,0 +1,3 @@
+module Plogger
+  VERSION = "0.8.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plogger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Merrill
@@ -68,7 +68,7 @@ dependencies:
         version: 2.7.1
 description: Provides a standard way to generate logs in the application.
 email:
-- danielmerrill6@gmail.com
+- daniel@papinotas.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -78,13 +78,17 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- Plogger.gemspec
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/plogger.rb
-- lib/plogger/version.rb
-- plogger.gemspec
+- lib/Plogger.rb
+- lib/Plogger/config.rb
+- lib/Plogger/formatter.rb
+- lib/Plogger/handler.rb
+- lib/Plogger/id_generator.rb
+- lib/Plogger/version.rb
 homepage: https://github.com/Papinotas-Desarrollo/Plogger
 licenses:
 - MIT

data/lib/plogger/version.rb

@@ -1,3 +0,0 @@
-module Plogger
-  VERSION = "0.7.0"
-end