metrics_logger 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50a0dd2beab583c7d2ec7de9473bd9ac44baade0
+  data.tar.gz: 3275069ade2f2504916022e68d76259ac306a34c
+SHA512:
+  metadata.gz: 3fa48ca3d2cbc862dca177aad53ee6bd8ea58f9362b09be50da3cda9e18daf680fbb137dc416b7dbe927ba833ee36608f8a01690ee45920e6400316bd7263907
+  data.tar.gz: 3c796f567c3a7a5fdfcc60d80df39b508f434169c8936177d7b0f6f022e41325ff8eadb51ee09b31d2cafe48f3efe36573686aadb5859e6b231fa2ab51022804

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Zhang
+
+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,67 @@
+# MetricsLogger
+
+For OpenTSDB data logging. For duration data and arbitrary logged values, total, count, average values are calculated per minute interval and sent to the server every minute. The logger singleton runs in a separate thread so this gem works well with jruby which supports native threads. If endpoint returns error or times out, backup_endpoint is tried.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metrics_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metrics_logger
+
+## Usage
+
+### Configure Logger
+```ruby
+  MetricsLogger.configure do |config|
+    config.app_name = "my_app" # used to make value key to opentsdb. eg: my_app.metric_name.total
+    config.endpoint = "http://my_opentsdb_server:4242/api/put"
+    config.backup_endpoint = "http://my_backup_opentsdb_server:4242/api/put"
+    config.sync_interval = 60 #in seconds
+```
+
+### Logging Things
+#### 1. log arbitrary values
+```ruby
+MetricsLogger.log("metric_name", key_1: "value_1", key_2: "value_2")
+```
+
+#### 2. log duration with block
+```ruby
+MetricsLogger.log_duration "metric_name" do 
+  #do something
+end
+```
+**Note: Remember that variables declared inside the block will not be accessible outside the block. If you want to initialize a varaible and use it after block closes, declare the variable before the block.**
+
+#### 3. log duration without block
+```ruby
+logger.MetricsLogger.new
+#do something
+logger.log_duration "metric_name"
+```
+
+#### 4. Log values once per minute
+```ruby
+MetricsLogger.sample("metric_name", object: some_ruby_object, method: "count")
+```
+
+###Start Logger Process
+```ruby
+Thread.new { MetricsLogger.start }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/metrics_logger/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/metrics_logger.rb

@@ -0,0 +1,13 @@
+require "metrics_logger/version"
+require "metrics_logger/configuration"
+require "metrics_logger/metrics_logger"
+require 'thread_safe'
+require 'timecop'
+require 'faraday'
+require 'json'
+
+module MetricsLogger
+  def self.method_missing(method, *args, &block)
+    MetricsLogger.send(method, *args, &block)
+  end
+end

data/lib/metrics_logger/configuration.rb

@@ -0,0 +1,13 @@
+module MetricsLogger
+  class Configuration
+    attr_accessor :endpoint, :backup_endpoint, :sync_interval, :app_name, :tags
+
+    def initialize
+      @endpoint = nil
+      @backup_endpoint = nil
+      @sync_interval = 60
+      @app_name = nil
+      @tags = {}
+    end
+  end
+end

data/lib/metrics_logger/metrics_logger.rb

@@ -0,0 +1,133 @@
+require 'timeout'
+
+module MetricsLogger
+  class MetricsLogger
+    TIMEOUT = 10
+
+    def initialize
+      @start_time_in_milliseconds = Time.now.to_f * 1000
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def log_duration(type)
+      end_time = Time.now
+      end_time_in_milliseconds = end_time.to_f * 1000
+      duration = end_time_in_milliseconds - @start_time_in_milliseconds
+      metric = {duration: duration}
+      self.class.enqueue(type, metric)
+    end
+
+    #Class Methods
+    def self.log(type, metrics)
+      metrics.each do |key, value|
+        self.enqueue(type, key => value)
+      end
+    end
+
+    def self.log_duration(type, &blk)
+      logger = self.new
+      yield
+      logger.log_duration(type)
+    end
+
+    def self.enqueue(type, metric)
+      key = metric.to_a[0][0]
+      value = metric.to_a[0][1]
+      puts caller.inspect if value.nil?
+
+      sub_type = "#{type}.#{key}"
+
+      if queue[sub_type].nil?
+        Mutex.new.synchronize do
+          queue[sub_type] ||= ThreadSafe::Array.new
+        end
+      end
+
+      queue[sub_type].push value
+      nil
+    end
+
+    def self.queue
+      if @queue.nil?
+        Mutex.new.synchronize do
+          @queue ||= ThreadSafe::Hash.new
+        end
+      else
+        @queue
+      end
+    end
+
+    def self.sampling_definitions
+      if @sampling_definitions.nil?
+        Mutex.new.synchronize do
+          @sampling_definitions ||= ThreadSafe::Array.new
+        end
+      else
+        @sampling_definitions
+      end
+    end
+
+    def self.reset
+      @queue = ThreadSafe::Hash.new
+      @sampling_definitions = ThreadSafe::Array.new
+    end
+
+    def self.sync
+      @queue, batched_data = ThreadSafe::Hash.new, queue
+
+      data = []
+      timestamp = (Time.now.to_f * 1000).to_i
+      app_name = configuration.app_name
+
+      batched_data.each do |sub_type, values|
+        total = values.compact.inject(:+)
+        count = values.count
+        average = total.to_f / count
+
+        data << {metric: "#{app_name}.#{sub_type}.total", timestamp: timestamp, value: total, tags: configuration.tags}
+        data << {metric: "#{app_name}.#{sub_type}.count", timestamp: timestamp, value: count, tags: configuration.tags}
+        data << {metric: "#{app_name}.#{sub_type}.average", timestamp: timestamp, value: average, tags: configuration.tags}
+      end
+
+      sampling_definitions.each do |defintion|
+        value = defintion[:object].send(defintion[:method])
+        data << {metric: "#{app_name}.#{defintion[:name]}", timestamp: timestamp, value: value, tags: configuration.tags}
+      end
+
+      send_data(data) if data[0]
+    end
+
+    def self.send_data(data)
+      begin
+        Timeout::timeout(TIMEOUT) { Faraday.post(configuration.endpoint, data.to_json) }
+      rescue
+        begin
+          Timeout::timeout(TIMEOUT) { Faraday.post(configuration.backup_endpoint, data.to_json) }
+        rescue
+          puts "#{Time.now} Cannot reach metrics server."
+        end
+      end
+    end
+
+    def self.sample(name, options = {})
+      sampling_definitions << {name: name, object: options[:object], method: options[:method]}
+    end
+
+    def self.start
+      raise "Must specify app name in MetricsLogger configuration" unless configuration.app_name
+      raise "Must specify endpoint in MetricsLogger configuration" unless configuration.endpoint
+
+      while true
+        sleep configuration.sync_interval
+        sync
+      end
+    end
+  end
+end

data/lib/metrics_logger/version.rb

@@ -0,0 +1,3 @@
+module MetricsLogger
+  VERSION = "0.0.3"
+end

data/metrics_logger.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrics_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metrics_logger"
+  spec.version       = MetricsLogger::VERSION
+  spec.authors       = ["Ben Zhang"]
+  spec.email         = ["benzhangpro@gmail.com"]
+  spec.summary       = %q{sends application metrics to opentsdb database.}
+  spec.description   = %q{sync with server asynchronusly in separate thread.}
+  spec.homepage      = "http://github.com/zben/metrics_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3.2"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "timecop", "~> 0.7.1"
+
+  spec.add_runtime_dependency "faraday", "~> 0.9.0"
+  spec.add_runtime_dependency "thread_safe", "~> 0.3.4"
+  spec.add_runtime_dependency "json", "~> 1.8.1"
+end

data/spec/metrics_logger_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe MetricsLogger do
+  after do
+    MetricsLogger.reset
+    Timecop.return
+  end
+
+  describe ".configure" do
+    before do
+      MetricsLogger.configure do |config|
+        config.endpoint = "http://movefast1.snc1:4242/test"
+        config.backup_endpoint = "http://movefast5.snc1:4242/test"
+        config.sync_interval = 60
+      end
+    end
+
+    it "sets correct endpoint and backup endpoint" do
+      expect(MetricsLogger.configuration.endpoint).to eq("http://movefast1.snc1:4242/test")
+      expect(MetricsLogger.configuration.backup_endpoint).to eq("http://movefast5.snc1:4242/test")
+      expect(MetricsLogger.configuration.sync_interval).to eq(60)
+    end
+  end
+
+  describe "#log_duration" do
+    it "logs correct duration" do
+      Timecop.freeze(Time.parse("2014-01-01 1:0:0"))
+      logger = MetricsLogger.new
+
+      Timecop.freeze(Time.parse("2014-01-01 1:0:1"))
+      logger.log_duration("stream")
+
+      Timecop.freeze(Time.parse("2014-01-01 2:0:0"))
+      logger = MetricsLogger.new
+
+      Timecop.freeze(Time.parse("2014-01-01 2:0:2"))
+      logger.log_duration("stream")
+
+      expect(MetricsLogger.queue).to eq({"stream.duration" => [1000, 2000]})
+    end
+  end
+
+  describe ".log" do
+    it "logs correct values" do
+      MetricsLogger.log('stream', lag: 100, other: 200)
+      MetricsLogger.log('stream', lag: 200, other: 400)
+
+      expect(MetricsLogger.queue).to eq({
+        "stream.lag" => [100, 200],
+        "stream.other" => [200, 400]
+      })
+
+    end
+  end
+
+  describe ".log_duration" do
+    it "logs correct values" do
+      MetricsLogger.log_duration "stream" do
+        sleep 0.1
+      end
+
+      expect(MetricsLogger.queue["stream.duration"][0]).to be_within(5).of(100)
+    end
+  end
+
+  describe ".sync" do
+    before do
+      Timecop.freeze(Time.parse("2014-01-01 1:0:0"))
+      MetricsLogger.configure do |config|
+        config.app_name = "test"
+        config.tags = {host: "hostname", env: "production"}
+      end
+    end
+
+    it "sends correct api call" do
+      MetricsLogger.log('stream', lag: 100, other: 200)
+      MetricsLogger.log('stream', lag: 200, other: 400)
+      MetricsLogger.log('stream', lag: 300, other: 600)
+
+      test_object = {a: 1, b: 2}
+      MetricsLogger.sample("queue_size", object: test_object, method: "size")
+
+      expected_data = [
+        {metric: "test.stream.lag.total",     timestamp: 1388566800000, value: 600,   tags: {host: "hostname", env: "production"}},
+        {metric: "test.stream.lag.count",     timestamp: 1388566800000, value: 3,     tags: {host: "hostname", env: "production"}},
+        {metric: "test.stream.lag.average",   timestamp: 1388566800000, value: 200.0, tags: {host: "hostname", env: "production"}},
+        {metric: "test.stream.other.total",   timestamp: 1388566800000, value: 1200,  tags: {host: "hostname", env: "production"}},
+        {metric: "test.stream.other.count",   timestamp: 1388566800000, value: 3,     tags: {host: "hostname", env: "production"}},
+        {metric: "test.stream.other.average", timestamp: 1388566800000, value: 400.0, tags: {host: "hostname", env: "production"}},
+        {metric: "test.queue_size",           timestamp: 1388566800000, value: 2,     tags: {host: "hostname", env: "production"}}
+      ]
+
+      expect(Faraday).to receive(:post).with(MetricsLogger.configuration.endpoint, expected_data.to_json)
+
+      MetricsLogger.sync
+    end
+  end
+
+  describe ".sample" do
+    it "adds to sampling_definitions correctly" do
+      object = {test: "test", test2: "test"}
+      MetricsLogger.sample("test", object: object, method: "size")
+      expect(MetricsLogger.sampling_definitions).to eq([{name: "test", object: object, method: "size"}])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'metrics_logger'
+
+require 'rubygems'
+require 'bundler'
+Bundler.require :all
+
+require 'thread_safe'
+require 'timecop'
+require 'faraday'
+require 'json'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: metrics_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Ben Zhang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: timecop
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: faraday
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  prerelease: false
+  type: :runtime
+description: sync with server asynchronusly in separate thread.
+email:
+- benzhangpro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metrics_logger.rb
+- lib/metrics_logger/configuration.rb
+- lib/metrics_logger/metrics_logger.rb
+- lib/metrics_logger/version.rb
+- metrics_logger.gemspec
+- spec/metrics_logger_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/zben/metrics_logger
+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.2.2
+signing_key:
+specification_version: 4
+summary: sends application metrics to opentsdb database.
+test_files:
+- spec/metrics_logger_spec.rb
+- spec/spec_helper.rb