emque-stats 1.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TeamSnap
+
+MIT License
+
+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,79 @@
+[![Build Status](https://travis-ci.org/emque/emque-stats.png)](https://travis-ci.org/emque/emque-stats)
+
+# Emque Stats
+
+A library that provides any [Emque::Producing](https://github.com/emque/emque-producing)
+application instrumentation capabilities for collecting application statistics
+and events. Stats and events are sent as just another Emque message through the
+Message Broker (RabbitMQ).
+
+A separate [Emque::Consuming](https://github.com/emque/emque-consuming)
+service must be created and deployed to process the data. In doing so, you can
+use your preferred graphing or analytics solution, be it Graphite, StatsD,
+New Relic, Keen.io, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'emque-stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emque-stats
+
+## Usage
+
+For any app already using Emque::Producing, there is nothing further to do.
+Emque::Stats will re-use the same configuration.
+
+For an app that is not already using Emque::Producing.
+
+``` ruby
+  Emque::Stats.configure do |config|
+    emque_configuration = Emque::Producing::Configuration.new
+    emque_configuration.app_name = "your_app"
+    emque_configuration.rabbitmq_options = { :url => "your rabbitmq url" }
+    config.emque_producing_configuration = emque_configuration
+  end
+```
+
+Send some stats
+
+``` ruby
+  # track activity
+  Emque::Stats.track("login", {:user_id => 1, :another_property => "something"} )
+
+  # counter
+  Emque::Stats.increment("garets")
+  Emque::Stats.count("garets", 20)
+
+  # timing
+  Emque::Stats.timer("glork", 320)
+
+  # gauge
+  Emque::Stats.gauge("bork", 100)
+```
+
+## Tests
+
+To run tests...
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+FIRST: Read our style guides at
+https://github.com/teamsnap/guides/tree/master/ruby
+
+1. Fork it ( http://github.com/emque/emque-stats/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/gem_tasks"
+require "rake/clean"
+require "rspec/core/rake_task"
+require "coveralls/rake/task"
+
+CLOBBER.include("coverage")
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = false
+end
+task :default => :spec
+
+Coveralls::RakeTask.new

data/emque-stats.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "emque/stats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "emque-stats"
+  spec.version       = Emque::Stats::VERSION
+  spec.authors       = ["Ryan Williams"]
+  spec.email         = ["oss@teamsnap.com"]
+  spec.description   = %q{Collect and send application stats and events via Emque}
+  spec.summary       = %q{Collect and send application stats and events via Emque}
+  spec.homepage      = "https://github.com/teamsnap/emque-stats"
+  spec.license       = "MIT"
+
+  spec.require_paths = %w(lib)
+  spec.files = %w(LICENSE.txt README.md Rakefile emque-stats.gemspec)
+  spec.files += Dir.glob('lib/**/*.rb')
+  spec.files += Dir.glob('spec/**/*')
+  spec.test_files = Dir.glob('spec/**/*')
+
+  spec.add_dependency "emque-producing",  "1.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake",    "~> 10.4.2"
+  spec.add_development_dependency "rspec",   "~> 3.2.0"
+  spec.add_development_dependency "bunny",   "~> 1.7.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
+end

data/lib/emque-stats.rb

@@ -0,0 +1,3 @@
+module Emque; end
+
+require "emque/stats"

data/lib/emque/stats.rb

@@ -0,0 +1,45 @@
+require "emque/stats/version"
+require "emque/stats/configuration"
+require "emque/stats/client"
+
+module Emque
+  module Stats
+    class << self
+      attr_accessor :client
+      attr_writer :configuration
+
+      def logger
+        self.configuration.logger
+      end
+
+      def configure
+        yield(configuration)
+        self.client = Client.new(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def track(event_name, props = {})
+        Emque::Stats.client.produce_track_event(event_name, props)
+      end
+
+      def increment(event_name)
+        count(event_name, 1)
+      end
+
+      def count(event_name, count=1)
+        Emque::Stats.client.produce_count(event_name, count)
+      end
+
+      def timer(event_name, duration)
+        Emque::Stats.client.produce_timer(event_name, duration)
+      end
+
+      def gauge(event_name, value)
+        Emque::Stats.client.produce_gauge(event_name, value)
+      end
+    end
+  end
+end

data/lib/emque/stats/client.rb

@@ -0,0 +1,36 @@
+require "emque-producing"
+require "emque/stats/messages/count_message"
+require "emque/stats/messages/gauge_message"
+require "emque/stats/messages/timer_message"
+require "emque/stats/messages/track_event_message"
+
+module Emque
+  module Stats
+    class Client
+
+      def initialize(config)
+        Emque::Producing.configuration = config.emque_producing_configuration
+      end
+
+      def produce_track_event(event_name, properties = {})
+        message = TrackEventMessage.new(:event_name => event_name, :properties => properties)
+        message.publish
+      end
+
+      def produce_count(event_name, count=1)
+        message = CountMessage.new(:event_name => event_name, :count => count)
+        message.publish
+      end
+
+      def produce_timer(event_name, duration)
+        message = TimerMessage.new(:event_name => event_name, :duration => duration)
+        message.publish
+      end
+
+      def produce_gauge(event_name, value)
+        message = GaugeMessage.new(:event_name => event_name, :value => value)
+        message.publish
+      end
+    end
+  end
+end

data/lib/emque/stats/configuration.rb

@@ -0,0 +1,11 @@
+module Emque
+  module Stats
+    class Configuration
+      attr_accessor :emque_producing_configuration
+
+      def initialize
+        @emque_producing_configuration = nil
+      end
+    end
+  end
+end

data/lib/emque/stats/messages/count_message.rb

@@ -0,0 +1,12 @@
+class CountMessage
+  include Emque::Producing::Message
+
+  topic "metrics"
+  message_type "metrics.count"
+  raise_on_failure false
+
+  values do
+    attribute :event_name, String, :required => true
+    attribute :count, Integer, :required => true
+  end
+end

data/lib/emque/stats/messages/gauge_message.rb

@@ -0,0 +1,12 @@
+class GaugeMessage
+  include Emque::Producing::Message
+
+  topic "metrics"
+  message_type "metrics.gauge"
+  raise_on_failure false
+
+  values do
+    attribute :event_name, String, :required => true
+    attribute :value, Integer, :required => true
+  end
+end

data/lib/emque/stats/messages/meter_message.rb

@@ -0,0 +1,11 @@
+class MeterMessage
+  include Emque::Producing::Message
+
+  topic "metrics"
+  message_type "metrics.meter"
+  raise_on_failure false
+
+  values do
+    attribute :event_name, String, :required => true
+  end
+end

data/lib/emque/stats/messages/timer_message.rb

@@ -0,0 +1,12 @@
+class TimerMessage
+  include Emque::Producing::Message
+
+  topic "metrics"
+  message_type "metrics.timer"
+  raise_on_failure false
+
+  values do
+    attribute :event_name, String, :required => true
+    attribute :duration, Integer, :required => true
+  end
+end

data/lib/emque/stats/messages/track_event_message.rb

@@ -0,0 +1,12 @@
+class TrackEventMessage
+  include Emque::Producing::Message
+
+  topic "track"
+  message_type "track.event"
+  raise_on_failure false
+
+  values do
+    attribute :event_name, String, :required => true
+    attribute :properties, Hash
+  end
+end

data/lib/emque/stats/version.rb

@@ -0,0 +1,5 @@
+module Emque
+  module Stats
+    VERSION = "1.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "pry"
+require "emque-stats"
+
+RSpec.configure do |config|
+  config.order = :random
+end

data/spec/stats/client_spec.rb

@@ -0,0 +1,26 @@
+describe Emque::Stats::Client do
+  subject {
+    producing_configuration = Emque::Producing::Configuration.new
+    producing_configuration.publish_messages = false
+    stats_configuration = Emque::Stats::Configuration.new
+    stats_configuration.emque_producing_configuration = producing_configuration
+    client = Emque::Stats::Client.new(stats_configuration)
+    client
+  }
+
+  it "produces event" do
+    subject.produce_track_event("signin")
+  end
+
+  it "produces count" do
+    subject.produce_count("signin")
+  end
+
+  it "produces timers" do
+    subject.produce_timer("timer", 10)
+  end
+
+  it "produces gauge" do
+    subject.produce_gauge("gauge", 10)
+  end
+end

data/spec/stats/configuration_spec.rb

@@ -0,0 +1,12 @@
+describe Emque::Stats::Configuration do
+  subject { Emque::Stats::Configuration.new }
+
+  it "emque_producing_configuration is nil by default" do
+    expect(subject.emque_producing_configuration).to eq nil
+  end
+
+  it "allows emque_producing_configuration to be overwritten" do
+    subject.emque_producing_configuration = Emque::Producing::Configuration.new
+    expect(subject.emque_producing_configuration).to_not be_nil
+  end
+end

data/spec/stats_spec.rb

@@ -0,0 +1,35 @@
+describe Emque::Stats do
+  describe "#configure" do
+    before do
+      Emque::Stats.configure do |config|
+        emque_configuration = Emque::Producing::Configuration.new
+        emque_configuration.app_name = "emque_stats"
+        config.emque_producing_configuration = emque_configuration
+      end
+    end
+
+    it "has a configuration" do
+      expect(
+        Emque::Stats.configuration.emque_producing_configuration.app_name
+      ).to eq "emque_stats"
+    end
+  end
+
+  describe "#count" do
+    subject {
+      Emque::Stats.configure do |config|
+      end
+      Emque::Stats.client
+    }
+
+    it "by default, produces a count of 1" do
+      expect(subject).to receive(:produce_count).with("an.event", 1)
+      Emque::Stats.count("an.event")
+    end
+
+    it "produces an arbitrary count" do
+      expect(subject).to receive(:produce_count).with("an.event", 5)
+      Emque::Stats.count("an.event", 5)
+    end
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: emque-stats
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: emque-producing
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collect and send application stats and events via Emque
+email:
+- oss@teamsnap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- emque-stats.gemspec
+- lib/emque-stats.rb
+- lib/emque/stats.rb
+- lib/emque/stats/configuration.rb
+- lib/emque/stats/client.rb
+- lib/emque/stats/messages/gauge_message.rb
+- lib/emque/stats/messages/meter_message.rb
+- lib/emque/stats/messages/count_message.rb
+- lib/emque/stats/messages/track_event_message.rb
+- lib/emque/stats/messages/timer_message.rb
+- lib/emque/stats/version.rb
+- spec/spec_helper.rb
+- spec/stats_spec.rb
+- spec/stats/configuration_spec.rb
+- spec/stats/client_spec.rb
+homepage: https://github.com/teamsnap/emque-stats
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Collect and send application stats and events via Emque
+test_files:
+- spec/spec_helper.rb
+- spec/stats_spec.rb
+- spec/stats/configuration_spec.rb
+- spec/stats/client_spec.rb