logr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edc6a47b0f6e94f82ae3e8d98162b465cdd52d80
+  data.tar.gz: 797e47c86a404a48fca101fb572617311bf0ecb4
+SHA512:
+  metadata.gz: 9a472a43d476c50e83fd523ab22ebeee3cdea01463ffcda5d5724135dab53143404616ec5e58264e03cd239dcb12251e09d3ec90568a24446614d97ac4a35489
+  data.tar.gz: c2a461065fa95c510d37c5acc66d7eac59f0a3e965b6686a277a0da7b69bd505d3d5e1f7d1032c958558e4837527f94a53b984a4a0fffec885053420e615ca86

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Peter Marton
+
+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/README.md

@@ -0,0 +1,112 @@
+# Logr
+
+Structured logging with metrics and events.
+
+![Travis](https://api.travis-ci.org/sspinc/logr.svg?branch=master)
+
+## Description
+
+“Chaos was the law of nature; Order was the dream of man.”
+― Henry Adams
+
+Logr is a machine-friendly logging library for Ruby. It brings structure
+to what is usually just a messy stream of human-readable output, so you
+can later slice and dice your logs with ease. The library was designed with
+monitoring and analytics platforms in mind: bringing together events and
+metrics from your services and applications has never been easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logr
+
+## Usage
+
+```ruby
+require 'logr'
+
+class YourClass
+  def self.logger
+    @logger ||= Logr::Logger.new('your-logger-name')
+  end
+
+  .
+  .
+  .
+
+  # A complex event that you want to monitor and has metrics associated
+  YourClass.logger.event('event-name', arbitrary: 'context', add_what: 'you_need')
+                  .monitored('Title of the event', 'A longer description.')
+                  .metric('metric-name', 34.35)
+                  .metric('loglines', 1234535, type: 'counter')
+                  .info('Human readable old-school logline')
+
+  # A simple logline
+  YourClass.logger.warn('Oh-oh something is fishy!')
+end
+```
+
+The first log line pretty printed:
+```json
+{
+  "timestamp":"2015-11-16 16:47:42 UTC",
+  "level":"INFO",
+  "logger":"your-logger-name",
+  "event":{
+    "name":"event-name",
+    "arbitrary":"context",
+    "add_what":"you_need",
+    "monitored":true,
+    "title":"Title of the event",
+    "text":"A longer description."},
+  "metrics":[
+    {
+      "name":"metric-name",
+      "value":34.35,
+      "type":"counter"
+    },
+    {
+      "name":"loglines",
+      "value":1234535,
+      "type":"counter"
+    }],
+  "message":"Human readable old-school logline"
+}
+```
+
+Log line with simple message:
+```json
+{
+  "timestamp":"2015-11-16 16:47:42 UTC",
+  "level":"WARN",
+  "logger":"your-logger-name",
+  "message":"Oh-oh somethign is fishy!"
+}
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sspinc/logr.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "logr"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logr/entry.rb

@@ -0,0 +1,79 @@
+require "logr/event"
+require "logr/metric"
+
+module Logr
+  class Entry
+
+    attr_reader :metrics, :message
+
+    def initialize(logger, event=nil, metrics=[], message=nil)
+      @logger = logger
+      @event = event
+      @metrics = metrics
+      @message = message
+    end
+
+    def event(name=nil, tags={})
+      if name.nil?
+        @event
+      else
+        Entry.new(@logger, Event.new(name, tags), @metrics)
+      end
+    end
+
+    def with(tags={})
+      if @event.nil?
+        raise 'No event to append to. Please call #event first.'
+      end
+      Entry.new(@logger, @event.with(tags), @metrics)
+    end
+
+    def metric(name, value, type: "counter")
+      metric = Metric.new(name, value, type)
+      Entry.new(@logger, @event, @metrics + [metric])
+    end
+
+    def monitored(title, text)
+      if @event.nil?
+        raise 'No event to monitor. Please call #event first.'
+      end
+      event = @event.with(monitored: true, title: title, text: text)
+      Entry.new(@logger, event, @metrics)
+    end
+
+    def debug(message=nil)
+      add(:debug, message)
+    end
+
+    def info(message=nil)
+      add(:info, message)
+    end
+
+    def warn(message=nil)
+      add(:warn, message)
+    end
+
+    def error(message=nil)
+      add(:error, message)
+    end
+
+    def fatal(message=nil)
+      add(:fatal, message)
+    end
+
+    def to_hash
+      result = {}
+      result[:event] = @event.to_hash if @event
+      result[:metrics] = @metrics.map(&:to_hash) if @metrics.any?
+      result[:message] = @message if @message
+
+      result
+    end
+
+    private
+    def add(severity, message)
+      entry = Entry.new(@logger, @event, @metrics, message)
+      @logger.send(severity, entry)
+    end
+  end
+end

data/lib/logr/event.rb

@@ -0,0 +1,17 @@
+module Logr
+  class Event
+    attr_reader :name, :tags
+
+    def initialize(name, tags)
+      @name, @tags = name, tags
+    end
+
+    def to_hash
+      { name: @name }.merge(@tags)
+    end
+
+    def with(tags)
+      Event.new(@name, @tags.merge(tags))
+    end
+  end
+end

data/lib/logr/json_formatter.rb

@@ -0,0 +1,15 @@
+require "json"
+
+module Logr
+  class JSONFormatter
+    def call(severity, time, logger_name, entry)
+      line = {
+        timestamp: time.utc,
+        level: severity,
+        logger: logger_name,
+      }.merge(entry.to_hash)
+
+      line.to_json + "\n"
+    end
+  end
+end

data/lib/logr/metric.rb

@@ -0,0 +1,20 @@
+module Logr
+  class Metric
+    attr_reader :name, :value, :type
+
+    def initialize(name, value, type)
+      raise TypeError, "Metric must be a numeric value" unless value.is_a?(Numeric)
+      @name = name
+      @value = value
+      @type = type
+    end
+
+    def to_hash
+      {
+        name: name,
+        value: value,
+        type: type
+      }
+    end
+  end
+end

data/lib/logr/version.rb

@@ -0,0 +1,3 @@
+module Logr
+  VERSION = "0.1.0"
+end

data/lib/logr.rb

@@ -0,0 +1,45 @@
+require "logger"
+
+require "logr/version"
+require "logr/entry"
+require "logr/json_formatter"
+
+module Logr
+  class Logger
+    def initialize(name, level: ::Logger::INFO, log_device: STDOUT)
+      @logger = ::Logger.new(log_device).tap do |logger|
+        logger.formatter = JSONFormatter.new
+        logger.progname = name
+        logger.level = level
+      end
+    end
+
+    def event(name, tags={})
+      Entry.new(@logger).event(name, tags)
+    end
+
+    def metric(name, value, type: "counter")
+      Entry.new(@logger).metric(name, value, type: type)
+    end
+
+    def debug(message)
+      Entry.new(@logger).debug(message)
+    end
+
+    def info(message)
+      Entry.new(@logger).info(message)
+    end
+
+    def warn(message)
+      Entry.new(@logger).warn(message)
+    end
+
+    def error(message)
+      Entry.new(@logger).error(message)
+    end
+
+    def fatal(message)
+      Entry.new(@logger).fatal(message)
+    end
+  end
+end

data/logr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logr"
+  spec.version       = Logr::VERSION
+  spec.authors       = ["Peter Marton"]
+  spec.email         = ["martonpe@secretsaucepartners.com"]
+
+  spec.summary       = "Structured logging with events and metrics"
+  spec.description   = "Structured logging with events and metrics"
+  spec.homepage      = "https://github.com/sspinc/logr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "timecop", "~> 0.8"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: logr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Marton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Structured logging with events and metrics
+email:
+- martonpe@secretsaucepartners.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logr.rb
+- lib/logr/entry.rb
+- lib/logr/event.rb
+- lib/logr/json_formatter.rb
+- lib/logr/metric.rb
+- lib/logr/version.rb
+- logr.gemspec
+homepage: https://github.com/sspinc/logr
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Structured logging with events and metrics
+test_files: []