instrumental_pubnub_example 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec2b173fb8e13dae02e158f14b75dbf50d3db55b
+  data.tar.gz: 4317fe833f317e275497a2aa5dacb9e57d8e29f3
+SHA512:
+  metadata.gz: 57fef30bdb80e4407d52d4eb1c5c9734b04ef2a78dd63089fa61a12a1c59a6554890c63d680debb004f4c90de271af216838754a2ae193fb8221f856bd15980c
+  data.tar.gz: 2cb3f12086e19b7d54d5c7564910c07a60e89a9734abadd9fda841d68b529208c7ebdd7379b6732a7213688959530e59956a55434d440260f6bc5df414a61b78

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*.log

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    instrumental_pubnub_example (0.0.1)
+      instrumental_agent (>= 0.12.7)
+      pubnub (>= 3.6.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    eventmachine (1.0.4)
+    instrumental_agent (0.12.7)
+    json (1.8.1)
+    net-http-persistent (2.9.4)
+    pubnub (3.6.9)
+      eventmachine (~> 1.0)
+      json (~> 1.8)
+      net-http-persistent (~> 2.9)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  instrumental_pubnub_example!
+  rake

data/README.md

@@ -0,0 +1,32 @@
+An example Instrumental relay using data received via PubNub. Run via command line, `instrumental_pubnub_relay`.
+
+Will receive messages from your PubNub channel and try to coerce them to Instrumental measurements. By default, each metric
+will be prefixed by the hostname of the machine you are running the relay on. You can specify a different prefix via the `-p`
+command.
+
+Metrics will be suffixed with the index that they appear in if they are in a Hash or Array. That is to say, if your PubNub message looks like this:
+
+```
+{ "foo": 20.0, "baz": [10.0, 5.0] }
+```
+
+the metrics sent will look like this:
+
+```
+hostname.foo
+hostname.baz.0
+hostname.baz.1
+```
+
+## Command line usage
+
+From help:
+```sh
+Usage: instrumental_pubnub_relay [options]
+    -k, --pubnub-subscribe-key KEY   Your PubNub subscribe key
+    -c, --pubnub-channel CHANNEL     Your PubNub channel
+    -i API_KEY,                      Your Instrumental API key
+        --instrumental-api-key
+    -p, --key-prefix PREFIX          String to prefix all received metrics with (default: my.machine)
+    -l, --log-level LEVEL            Log level for output, valid values are: ["debug", "warn", "info", "fatal"]
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/instrumental_pubnub_relay

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'instrumental/pub_nub/relay'
+require 'logger'
+require 'optparse'
+require 'socket'
+
+pubnub_subscribe = nil
+pubnub_channel   = nil
+instrumental_key = nil
+log_level        = 'warn'
+log_levels       = %w{debug warn info fatal}
+key_prefix       = Socket.gethostname
+
+OptionParser.new do |opts|
+  opts.on("-k", "--pubnub-subscribe-key KEY", "Your PubNub subscribe key") do |k|
+    pubnub_subscribe = k
+  end
+  opts.on("-c", "--pubnub-channel CHANNEL", "Your PubNub channel") do |c|
+    pubnub_channel = c
+  end
+  opts.on("-i", "--instrumental-api-key API_KEY", "Your Instrumental API key") do |i|
+    instrumental_key = i
+  end
+  opts.on("-p", "--key-prefix PREFIX", "String to prefix all received metrics with (default: #{key_prefix})") do |p|
+    key_prefix = p
+  end
+  opts.on("-l", "--log-level LEVEL", log_levels, "Log level for output, valid values are: #{log_levels.inspect}") do |l|
+    log_level = l
+  end
+end.parse!
+
+if pubnub_subscribe.to_s.strip.empty?
+  raise "You must provide a PubNub subscribe key"
+end
+
+if pubnub_channel.to_s.strip.empty?
+  raise "You must provide a PubNub channel name"
+end
+
+if instrumental_key.to_s.strip.empty?
+  raise "You must provide an Instrumental API key"
+end
+
+if key_prefix.to_s.strip.empty?
+  raise "You must provide a non-empty key prefix"
+end
+
+logger       = Logger.new(STDOUT)
+logger.level = Logger.const_get(log_level.upcase)
+relay        = Instrumental::PubNub::Relay.new(pubnub_subscribe,
+                                                pubnub_channel,
+                                                instrumental_key,
+                                                key_prefix,
+                                                logger)
+
+trap('INT') do
+  relay.disconnect!
+end
+
+relay.run!

data/instrumental-pubnub-example.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "instrumental/pub_nub/version"
+
+Gem::Specification.new do |s|
+  s.name        = "instrumental_pubnub_example"
+  s.version     = Instrumental::PubNub::VERSION
+  s.authors     = ["Christopher Zelenak"]
+  s.email       = ["support@instrumentalapp.com"]
+  s.homepage    = "http://github.com/expectedbehavior/instrumental_pubnub_example"
+  s.summary     = %q{Relay PubNub data to instrumentalapp.com}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency(%q<pubnub>, [">= 3.6.9"])
+  s.add_dependency(%q<instrumental_agent>, [">= 0.12.7"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
+end

data/lib/instrumental/pub_nub/relay.rb

@@ -0,0 +1,117 @@
+require 'instrumental_agent'
+require 'pubnub'
+
+module Instrumental
+  module PubNub
+    class Relay
+
+      def initialize(pubnub_subscribe_key, pubnub_channel_name, instrumental_api_key, key_prefix, logger)
+        @logger        = logger
+        @agent         = Instrumental::Agent.new(instrumental_api_key)
+        @pubnub        = Pubnub.new(:subscribe_key    => pubnub_subscribe_key,
+                                    :error_callback   => method(:on_error),
+                                    :connect_callback => method(:on_connect))
+        @channel       = pubnub_channel_name
+        @prefix        = key_prefix
+        @disconnecting = false
+      end
+
+      def run!
+        @pubnub.subscribe(:channel => @channel, :callback => method(:on_message))
+        block_for_messages
+      end
+
+      def disconnect!
+        @disconnecting = true
+        @pubnub.leave(:channel => @channel, :callback => method(:on_leave))
+      end
+
+      def on_leave(msg)
+        shutdown
+      end
+
+      def on_message(msg)
+        data              = msg.message
+        submitted_metrics = case data
+                            when Hash
+                              data.flat_map do |k, v|
+                                gauge_array([@prefix, k].join("."), Array(v))
+                              end
+                            when Array
+                              gauge_array(@prefix, data)
+                            else
+                              if data.to_s.size > 0
+                                gauge_metric(@prefix, data.to_s)
+                              end
+                            end
+        submitted_metrics = Array(submitted_metrics).compact
+        if submitted_metrics.size > 0
+          info "Sent #{submitted_metrics.size} metrics"
+        end
+      end
+
+      def gauge_array(name, val)
+        if val.size != 1
+          val.map.with_index do |measurement, i|
+            gauge_metric([name, i].join("."), measurement)
+          end
+        else
+          gauge_metric(name, val.first)
+        end
+      end
+
+      def gauge_metric(name, value)
+        case value
+        when Numeric
+          debug "Gauge metric %s with value %s" % [name.inspect, value.inspect]
+          @agent.gauge(name, value)
+          name
+        else
+          warn "Not measuring metric %s, not a numeric value (%s)" % [name.inspect, value.inspect]
+          nil
+        end
+      end
+
+      def on_error(msg)
+        error "%s (%s)" % [msg.message, msg.response.inspect]
+        if @disconnecting
+          shutdown
+        end
+      end
+
+      def on_connect(msg)
+        info "Connected"
+      end
+
+      private
+
+      %w{warn debug info fatal error}.each do |level|
+        define_method(level.to_sym) do |msg|
+          @logger.send(level.to_sym, msg)
+        end
+      end
+
+      def force_shutdown_after_wait(wait_time = 10)
+        EM.add_timer(wait_time) do
+          info "Forcing shutdown"
+          shutdown
+          exit 1
+        end
+      end
+
+      def eventmachine_running?
+        EM.reactor_running? && EM.reactor_thread
+      end
+
+      def block_for_messages
+        sleep 1 while !eventmachine_running?
+        EM.reactor_thread.join
+      end
+
+      def shutdown
+        EM.stop_event_loop
+      end
+
+    end
+  end
+end

data/lib/instrumental/pub_nub/version.rb

@@ -0,0 +1,5 @@
+module Instrumental
+  module PubNub
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: instrumental_pubnub_example
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Zelenak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pubnub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.9
+- !ruby/object:Gem::Dependency
+  name: instrumental_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: 
+email:
+- support@instrumentalapp.com
+executables:
+- instrumental_pubnub_relay
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/instrumental_pubnub_relay
+- instrumental-pubnub-example.gemspec
+- lib/instrumental/pub_nub/relay.rb
+- lib/instrumental/pub_nub/version.rb
+homepage: http://github.com/expectedbehavior/instrumental_pubnub_example
+licenses: []
+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: Relay PubNub data to instrumentalapp.com
+test_files: []