plogger 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 110fbede7ba261da02ee2861e3d5375e0e31ccea
+  data.tar.gz: 0a832143e20bfa24ad41746b10d4f6569e6aa3de
+SHA512:
+  metadata.gz: edcab56c3b72cc592f5ceaab0bb6a7f6d5935cf24d6f1ec6092c03f94d8fc6398f0c943316091c84951a0af941cf67d9239deab788e89a239c5ab50b3a1fddc0
+  data.tar.gz: 1250d98bd14d0a5cdd805badf2cf9a7f16475c5bc0e27bc310faf75107668601c55bf3a11cf52cef6308644227e7c5381d3a6851083eb237e600397a98a493f0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Plogger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daniel Merrill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Plogger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Plogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plogger"
+  spec.version       = Plogger::VERSION
+  spec.authors       = ["Daniel Merrill"]
+  spec.email         = ["daniel@papinotas.com"]
+
+  spec.summary       = "Phoenix Logging Interface."
+  spec.description   = "Provides a standard way to generate logs in the application."
+  spec.homepage      = "https://github.com/Papinotas-Desarrollo/Plogger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "sentry-raven", '~> 2.7.1'
+end

data/README.md

@@ -0,0 +1,59 @@
+# Plogger
+
+## Introduction
+
+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.
+
+## Instalation
+
+Add `gem 'plogger'` to your gemfile.
+
+## Configuring
+
+```ruby
+# 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
+```
+
+## Usage
+
+The usage is similar to how you use the Rails Logger, but you can also log exceptions.
+
+```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}"
+```
+
+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.
+
+## Params
+
+Each of these methods can receive the following keyword params:
+
+| 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 | {} |
+
+Example call:
+
+```ruby
+Plogger.info("Processing ready", type: 'user', category: "Bundle Creation", user_id: 1, extra_info: {happy: "yes"})
+# Will output 'Processing ready -- type='user' category='Bundle Creation' user_id=1 happy='yes'
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "Plogger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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,12 @@
+module Plogger
+  class Formatter
+    def self.format(message, trace, type: 'system', user_id: 'null', account_id: 'null', category: '', extra_info: {})
+      result = "#{message} -- type='#{type}' category='#{category}' user_id=#{user_id} account_id=#{account_id} trace=#{trace}"
+      extra_info.keys.each do |key|
+        is_string = extra_info[key].class == String
+        result += " #{key}=#{is_string ? "'" : ''}#{extra_info[key]}#{is_string ? "'" : ''}"
+      end
+      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.2.0"
+end

data/lib/Plogger.rb

@@ -0,0 +1,50 @@
+require "Plogger/version"
+require 'Plogger/config'
+require 'Plogger/handler'
+require 'logger'
+
+module Plogger
+  def self.logger
+    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
+
+  def self.config
+    @@config ||= Plogger::Config.new(logger)
+  end
+
+  def self.configure
+    yield(config)
+    @@logger = config.logger
+    @@config = config
+  end
+
+  def self.exception(exception, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+    handler = Plogger::Handler.new(config)
+    handler.handle_exception(exception, category: category, user_id: user_id, account_id: account_id,
+                                        extra_info: extra_info)
+  end
+
+  def self.error(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+    handler = Plogger::Handler.new(config)
+    handler.handle_error(message, category: category, user_id: user_id, account_id: account_id,
+                                  extra_info: extra_info)
+  end
+
+  def self.warn(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+    handler = Plogger::Handler.new(config)
+    handler.handle_warning(message, category: category, user_id: user_id, account_id: account_id,
+                                  extra_info: extra_info)
+  end
+
+  def self.info(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+    handler = Plogger::Handler.new(config)
+    handler.handle_info(message, category: category, user_id: user_id, account_id: account_id,
+                                  extra_info: extra_info)
+  end
+
+  def self.debug(message, type: '', category: '', user_id: '', account_id: '', extra_info: {})
+    handler = Plogger::Handler.new(config)
+    handler.handle_debug(message, category: category, user_id: user_id, account_id: account_id,
+                                  extra_info: extra_info)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: plogger
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Daniel Merrill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: Provides a standard way to generate logs in the application.
+email:
+- daniel@papinotas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- Plogger.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Phoenix Logging Interface.
+test_files: []