regrapher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c6c54892db698ad0b8d1befa73224f9f6c115c2
+  data.tar.gz: 9cb429ea5c0c2660a5ee5107265b238d83e656ed
+SHA512:
+  metadata.gz: c367ec86a1f35b7a0d2e1624dd99faa07ff1ed2a37e7a86c117242d89b4ff33244b0928e03e24bb3a64d49c186996d7a46bcc48cd62ec893666f02e869b7f956
+  data.tar.gz: 71f591c3db855bfa594e693e8248df7ed18939fcfec637f8d8bed2bd4f7f6dac68de51389c76a1a59e2b49a77781d895074344e02bd12837764ffb121fe7eb8b

data/README.md

@@ -0,0 +1,5 @@
+Regrapher Ruby Logger
+======================
+
+Provides convenience logger to print events and metric values in the Regrapher format.
+

data/Rakefile

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

data/lib/regrapher/client.rb

@@ -0,0 +1,111 @@
+require 'json'
+require 'securerandom'
+
+module Regrapher
+  # Examples:
+  #   client.increment 'page.views'
+  #   client.gauge 'users.online', 100.43
+  #   client.event 'clients.sign_ups', :title=>'Premium Package Sold', :text=>'Hurray !'
+  class Client
+    # A namespace to prepend to all statsd calls. Defaults to no namespace.
+    attr_reader :namespace
+
+    # Global tags to be added to every statsd call. Defaults to no tags.
+    attr_reader :tags
+
+    # Output stream used to log metrics and event data. Defaults to STDOUT.
+    attr_reader :output_stream
+
+    # @param [Hash] opts
+    # @option opts [String] :namespace set a namespace to be prepended to every metric name
+    # @option opts [Array<String>] :tags tags to be added to every metric
+    # @option opts :output_stream an object with a puts method that takes accepts a string parameter
+    def initialize(opts = {})
+      @namespace     = opts[:namespace]
+      @tags          = opts.fetch(:tags, []).uniq
+      @output_stream = opts.fetch(:output_stream, STDOUT)
+    end
+
+    # Sends an increment (count = 1) for the given metric.
+    #
+    # @param [String] name metric name
+    # @param [Hash] opts the options to create the metric with
+    # @option opts [Numeric] :sample_rate sample rate, 1 for always
+    # @option opts [Array<String>] :tags An array of tags
+    # @see #count
+    def increment(name, opts={})
+      count(name, 1, opts)
+    end
+
+    # Sends a decrement (count = -1) for the given metric.
+    #
+    # @param [String] name metric name
+    # @param [Hash] opts the options to create the metric with
+    # @option opts [Numeric] :sample_rate sample rate, 1 for always
+    # @option opts [Array<String>] :tags An array of tags
+    # @see #count
+    def decrement(name, opts={})
+      count(name, -1, opts)
+    end
+
+    # Sends an arbitrary count for the given metric.
+    #
+    # @param [String] name metric name
+    # @param [Integer] count count
+    # @param [Hash] opts the options to create the metric with
+    # @option opts [Numeric] :sample_rate sample rate, 1 for always
+    # @option opts [Array<String>] :tags An array of tags
+    def count(name, count, opts={})
+      send_metric('c', name, count, opts)
+    end
+
+    # Sends an arbitrary gauge value for the given metric.
+    #
+    # This is useful for recording things like available disk space,
+    # memory usage, and the like, which have different semantics than
+    # counters.
+    #
+    # @param [String] name metric name.
+    # @param [Numeric] value gauge value.
+    # @param [Hash] opts the options to create the metric with
+    # @option opts [Numeric] :sample_rate sample rate, 1 for always
+    # @option opts [Array<String>] :tags An array of tags
+    # @example Report the current user count:
+    #   client.gauge('user.count', User.count)
+    def gauge(name, value, opts={})
+      send_metric('g', name, value, opts)
+    end
+
+    # Sends events to the stream of events.
+    #
+    # @param [String] name metric name.
+    # @param [Hash] value the event value. Should contain a title and text. Could contain any other custom data.
+    # @option value[String] :title Event title.
+    # @option value [String, nil] :text Event text. Supports +\n+.
+    # @param [Hash] opts the additional data about the event
+    # @option opts [Array<String>] :tags tags to be added to every metric
+    # @example Report an event:
+    #   client.event('clients.sign_ups', {:title=>'New VIP Client', text=>'Hurray !',
+    #     :data=>{:name=>'Doe',:photo=>'http://example.com/12.jpg'}}, :tags=>['region:US_CAL','payment:paypal'])
+    def event(name, value, opts={})
+      send_metric('e', name, value, opts)
+    end
+
+    private
+
+    def send_metric(type, name, value, opts={})
+      sample_rate = opts.fetch(:sample_rate, 1)
+      return unless sample_rate >= 1 || rand < sample_rate
+      name = "#{namespace}.#{name}" if namespace
+      obj  = opts.merge(:type  => type,
+                        :name  => name,
+                        :value => value,
+                        :ts    => Time.now.to_i,
+                        :id    => SecureRandom.uuid)
+      tags = (opts[:tags] || []) | self.tags
+      obj.merge!(:tags => tags) unless tags.empty?
+      obj_json = JSON::generate(obj)
+      output_stream.puts "[regrapher][#{obj_json.length}]#{obj_json}"
+    end
+  end
+end

data/lib/regrapher/parser.rb

@@ -0,0 +1,16 @@
+module Regrapher
+  class Parser
+    LINE_REGEX = /^\[regrapher\]\[(\d+)\](.+)$/
+
+    def parse(line)
+      _, length, rest = line.match(LINE_REGEX).to_a
+      if length && rest && rest.length >= 2 && (length=length.to_i) <= rest.length
+        begin
+          JSON.parse rest[0, length], symbolize_names: true
+        rescue JSON::ParserError
+          # mute exception
+        end
+      end
+    end
+  end
+end

data/lib/regrapher/version.rb

@@ -0,0 +1,3 @@
+module Regrapher
+  VERSION = '0.1.0'
+end

data/lib/regrapher.rb

@@ -0,0 +1,15 @@
+require 'regrapher/client'
+
+module Regrapher
+
+  class << self
+
+    def client=(client)
+      @client = client
+    end
+
+    def client
+      @client ||= Client.new(options)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Regrapher::Client do
+
+  LINE_REGEX = /^\[regrapher\]\[(\d+)\](.*)$/
+
+  let(:output_stream) { StringIO.new }
+
+  let(:client) { Regrapher::Client.new(output_stream: output_stream) }
+
+  let(:string) { output_stream.string }
+
+  {
+      gauge:     ['basket.value', 34.2],
+      increment: ['users.count'],
+      decrement: ['users.count'],
+      count:     ['users.count', -55],
+      event:     ['users.sign_up', { name: 'John', company: 'Acme Corp' }]
+  }.each do |method, params|
+    context "##{method}" do
+
+      it 'has a "[regrapher][<length>]" prefix' do
+        client.send method, *params
+        expect(string).to match(LINE_REGEX)
+        _, length, json = string.match(LINE_REGEX).to_a
+        expect(json.length).to eq(length.to_i)
+      end
+
+      it '<length> equals the json length' do
+        client.send method, *params
+        _, length, json = string.match(LINE_REGEX).to_a
+        expect(json.length).to eq(length.to_i)
+      end
+    end
+  end
+end

data/spec/examples.txt

@@ -0,0 +1,12 @@
+example_id                   | status | run_time        |
+---------------------------- | ------ | --------------- |
+./spec/client_spec.rb[1:1:1] | passed | 0.00011 seconds |
+./spec/client_spec.rb[1:1:2] | passed | 0.00013 seconds |
+./spec/client_spec.rb[1:2:1] | passed | 0.00013 seconds |
+./spec/client_spec.rb[1:2:2] | passed | 0.00015 seconds |
+./spec/client_spec.rb[1:3:1] | passed | 0.00254 seconds |
+./spec/client_spec.rb[1:3:2] | passed | 0.00019 seconds |
+./spec/client_spec.rb[1:4:1] | passed | 0.0002 seconds  |
+./spec/client_spec.rb[1:4:2] | passed | 0.00017 seconds |
+./spec/client_spec.rb[1:5:1] | passed | 0.00017 seconds |
+./spec/client_spec.rb[1:5:2] | passed | 0.00018 seconds |

data/spec/spec_helper.rb

@@ -0,0 +1,77 @@
+require 'regrapher'
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered     = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order            = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: regrapher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramzi Ben Salah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Provides convenience logger to format events and metric values in the
+  regrapher format
+email:
+- ramzi.salah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/regrapher.rb
+- lib/regrapher/client.rb
+- lib/regrapher/parser.rb
+- lib/regrapher/version.rb
+- spec/client_spec.rb
+- spec/examples.txt
+- spec/spec_helper.rb
+homepage: http://github.com/regrapher/regrapher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Regrapher logger for ruby
+test_files:
+- spec/client_spec.rb
+- spec/examples.txt
+- spec/spec_helper.rb
+has_rdoc: