opentsdb-consumer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 334956afe7507b50e68bdb15ee3fb1259e308c9a
-  data.tar.gz: 39e5074094710e559e0354f8eb6fd941b653f838
+  metadata.gz: 626245d54c787e59a863cd3e9f72be2f8dbbe26e
+  data.tar.gz: 2cd2406b17e766a69eafb285af78628f35e607f3
 SHA512:
-  metadata.gz: 04482b0690cc6e8b86e09300c17f10f5a999cb20e56fd6cf326aca2c191e633e65f5e8a5b63313d1d802c771dcf98487869eb3dff07cf082f77cd76ce63697d4
-  data.tar.gz: 16b717f60281eed71d6c8ec0e93b8661e63889576cb93564862d0fc87e1862df872fb8cef57f1da1a988502c7388d9f196bfc3b7e5dd6c411c5742f2b4233131
+  metadata.gz: 38b597f0545d30fee23dbbab0041876183a6633a5ad8d114db47e41dcaff356a1d44beb99f4bc804638971f4d6435098aea0c79f67c4a4b3f66074f6beef2885
+  data.tar.gz: 9633060a0de91f0228293ffe88d5534ca0169b981247d1fe8c723b413b9f80f950da8186d00e2dcce8d8d3597df8e8c4b3b927150ab33d1feb38a78d804dc988

data/.gitignore

@@ -15,7 +15,7 @@ doc
 # jeweler generated
 pkg
 
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
 #
 # * Create a file at ~/.gitignore
 # * Include files you want ignored
@@ -47,3 +47,6 @@ pkg
 
 # For rubinius:
 #*.rbc
+
+# Gemfile
+Gemfile.lock

data/Gemfile

@@ -1,14 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'excon', '~> 0.45.0'
-
-group :development do
-  gem 'rspec', '~> 3.3.0'
-  gem 'rdoc', '~> 3.12'
-  gem 'bundler', '~> 1.0'
-  gem 'jeweler', '~> 2.0.1'
-
-  gem 'byebug'
-  gem 'pry'
-  gem 'coveralls', require: false
-end
+gemspec

data/README.md

@@ -18,9 +18,24 @@ gem 'opentsdb-consumer'
 ## Usage
 
 ```ruby
+# First, you need a client.
 client = OpenTSDBConsumer::Client.new host: 'metrics.yourdomain.com', port: 4242
-metric = OpenTSDBConsumer::Metric.new name: 'my.metric', rate: true, aggregator: 'avg'
-OpenTSDBConsumer::Query.new([metric], client).run start: '24h-ago'
+
+# Default options
+data = client.fetch(%w(metric1 metric2))
+
+# Custom options for all the metrics
+data = client.fetch(
+  %w(metric1 metric2),
+  rate: true,
+  aggregator: 'avg',
+  tags: { environment: 'production' },
+  start: '24h-ago'
+)
+
+# Custom options for each metric
+metric = OpenTSDBConsumer::Metric.new name: 'my.metric', rate: true, aggregator: 'avg', tags: { environment: 'production' }
+data   = OpenTSDBConsumer::Query.new([metric], client).run start: '24h-ago'
 ```
 
 The rate can be configured by providing an hash with the rate options.
@@ -30,7 +45,6 @@ metric = OpenTSDBConsumer::Metric.new name: 'my.metric',
                                       aggregator: 'sum'
 ```
 
-
 ## Contributing to opentsdb-consumer
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
@@ -49,6 +63,5 @@ bin/opentsdb-consumer server.domain.com my.metric
 
 ## Copyright
 
-Copyright (c) 2015 Nine Internet Solutions AG. See LICENSE.txt for
+Copyright (c) 2016 Nine Internet Solutions AG. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/opentsdb-consumer.rb

@@ -1,9 +1 @@
-module OpenTSDBConsumer
-end
-
-require 'opentsdb-consumer/errors'
-require 'opentsdb-consumer/client'
-require 'opentsdb-consumer/metric'
-require 'opentsdb-consumer/rate'
-require 'opentsdb-consumer/query'
-require 'opentsdb-consumer/result'
+require 'opentsdb_consumer'

data/lib/opentsdb-consumer/client.rb

@@ -15,8 +15,34 @@ module OpenTSDBConsumer
       @connection = Excon.new url, options
     end
 
+    def fetch(metric_names, options = {})
+      options = {
+        start: '8h-ago',
+        aggregator: 'sum',
+        downsample: '5m-avg',
+        rate: false,
+        tags: {},
+      }.merge(options)
+
+      metrics = build_metrics(metric_names, options)
+
+      Query.new(metrics, self).run(start: options[:start])
+    end
+
     def url
       "http://#{host}:#{port}/api/query"
     end
+
+    private
+
+    def build_metrics(metric_names, options)
+      metric_names.map do |metric|
+        Metric.new(whitelisted_metric_options(options).merge(name: metric))
+      end
+    end
+
+    def whitelisted_metric_options(options)
+      options.select { |key, _| Metric::ATTRIBUTES_WHITELIST.include?(key) }
+    end
   end
 end

data/lib/opentsdb-consumer/errors.rb

@@ -3,4 +3,5 @@ module OpenTSDBConsumer
 
   class InvalidMetric < QueryError; end
   class InvalidTag < QueryError; end
+  class EmptyTag < InvalidTag; end
 end

data/lib/opentsdb-consumer/metric.rb

@@ -2,18 +2,20 @@ require 'opentsdb-consumer/rate'
 
 module OpenTSDBConsumer
   class Metric
+    ATTRIBUTES_WHITELIST = %i(aggregator rate downsample tags).freeze
+
     attr_reader :name, :aggregator, :rate, :downsample, :tags
 
     def initialize(name: nil, aggregator: 'sum', rate: false, downsample: '10m-avg', tags: {})
-      @name = name
+      @name       = name
       @aggregator = aggregator
-      @rate = Rate.new(rate) if rate
+      @rate       = Rate.new(rate) if rate
       @downsample = downsample
-      @tags = tags
+      @tags       = Tags.new(tags)
     end
 
     def to_s
-      query = tags.any? ? "{#{tags_to_query}}" : ''
+      query = tags.any? ? "{#{tags}}" : ''
       query += ":#{rate}" if rate
       [aggregator, downsample, name].compact.join(':') + query
     end
@@ -23,16 +25,12 @@ module OpenTSDBConsumer
         aggregator: aggregator,
         downsample: downsample,
         metric: name,
-        tags: tags,
+        tags: tags.to_h,
       }
-      hash.merge! rate.to_h if rate
-      hash
-    end
 
-    private
+      hash.merge! rate.to_h if rate
 
-    def tags_to_query
-      tags.map { |key, value| [key, value].join '=' }.join(',')
+      hash
     end
   end
 end

data/lib/opentsdb-consumer/tags.rb

@@ -0,0 +1,23 @@
+module OpenTSDBConsumer
+  class Tags < Hash
+    def initialize(tags = {})
+      merge!(tags)
+
+      check_tags!
+    end
+
+    def to_s
+      map do |key, value|
+        [key, value].join '='
+      end.join(',')
+    end
+
+    private
+
+    def check_tags!
+      each do |key, value|
+        raise EmptyTag if key && (value.nil? || value.to_s.empty?)
+      end
+    end
+  end
+end

data/lib/opentsdb_consumer.rb

@@ -0,0 +1,10 @@
+module OpenTSDBConsumer
+end
+
+require 'opentsdb-consumer/errors'
+require 'opentsdb-consumer/client'
+require 'opentsdb-consumer/metric'
+require 'opentsdb-consumer/rate'
+require 'opentsdb-consumer/tags'
+require 'opentsdb-consumer/query'
+require 'opentsdb-consumer/result'

data/opentsdb-consumer.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.email       = ['phil@nine.ch']
   s.homepage    = 'http://github.com/ninech/'
   s.license     = 'MIT'
-  s.summary     = "Client library to consume metrics from OpenTSDB"
-  s.description = "Client library to consume metrics from OpenTSDB"
+  s.summary     = 'Client library to consume metrics from OpenTSDB'
+  s.description = 'Client library to consume metrics from OpenTSDB'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -19,10 +19,12 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'excon', '~> 0.45.0'
 
-  s.add_development_dependency 'rspec', '~> 3.3', '>= 3.3.0'
+  s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rack', '~> 1' # Remove this dependency when using ruby 2.2.2+
+  s.add_development_dependency 'jeweler', '~> 2.0.1'
   s.add_development_dependency 'rdoc', '~> 3.12'
   s.add_development_dependency 'bundler', '~> 1.0'
-  s.add_development_dependency 'byebug', '~> 0'
   s.add_development_dependency 'pry', '~> 0'
   s.add_development_dependency 'coveralls', '~> 0'
 end

data/spec/opentsdb-consumer/client_spec.rb

@@ -1,12 +1,74 @@
 require 'spec_helper'
-require 'opentsdb-consumer/client'
 
 RSpec.describe OpenTSDBConsumer::Client do
-  let(:client) { described_class.new host: 'metrics.local', port: '4243' }
+  let(:host)         { 'myhost.com' }
+  let(:port)         { 4243 }
+  let(:metric_names) { %w(metric1 metric2) }
+
+  subject { described_class.new(host: host, port: port) }
 
   describe '#url' do
+    subject { super().url }
+
     it 'assembles a correct url for opentsdb requests' do
-      expect(client.url).to eq 'http://metrics.local:4243/api/query'
+      expect(subject).to eq 'http://myhost.com:4243/api/query'
+    end
+  end
+
+  describe '#fetch' do
+    subject do
+      super().fetch(metric_names, aggregator: 'cubic', start: 'now', unknown_key: 'not here')
+    end
+
+    before(:each) do
+      query_double = instance_double(OpenTSDBConsumer::Query)
+      allow(query_double).to receive(:run)
+      allow(OpenTSDBConsumer::Query).to receive(:new).and_return(query_double)
+    end
+
+    describe 'components' do
+      it 'uses OpenTSDB metric' do
+        expect(OpenTSDBConsumer::Metric).to receive(:new).with(
+          aggregator: 'cubic', downsample: '5m-avg', rate: false, tags: {}, name: 'metric1'
+        )
+
+        expect(OpenTSDBConsumer::Metric).to receive(:new).with(
+          aggregator: 'cubic', downsample: '5m-avg', rate: false, tags: {}, name: 'metric2'
+        )
+
+        subject
+      end
+
+      describe 'OpenTSDB query' do
+        it 'uses OpenTSDB query' do
+          fake_metric = double('fake_metric')
+
+          allow(OpenTSDBConsumer::Metric).to receive(:new).and_return(fake_metric)
+
+          expect(OpenTSDBConsumer::Query).to receive(:new).with([fake_metric, fake_metric], any_args)
+
+          subject
+        end
+
+        it 'makes a query to OpenTSDB backend' do
+          fake_query = double('fake_query')
+
+          allow(OpenTSDBConsumer::Query).to receive(:new).and_return(fake_query)
+
+          expect(fake_query).to receive(:run).with(start: 'now')
+
+          subject
+        end
+
+        it 'let exceptions bubble up' do
+          fake_query = double('fake_query')
+
+          allow(fake_query).to receive(:run).and_raise(OpenTSDBConsumer::InvalidMetric)
+          allow(OpenTSDBConsumer::Query).to receive(:new).and_return(fake_query)
+
+          expect { subject.datapoints }.to raise_error(OpenTSDBConsumer::InvalidMetric)
+        end
+      end
     end
   end
 end

data/spec/opentsdb-consumer/metric_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'opentsdb-consumer/metric'
-require 'opentsdb-consumer/rate'
 
 RSpec.describe OpenTSDBConsumer::Metric do
   let(:name) { 'my.metric' }

data/spec/opentsdb-consumer/rate_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'opentsdb-consumer/rate'
 
 RSpec.describe OpenTSDBConsumer::Rate do
   describe '#to_s' do

data/spec/opentsdb-consumer/result_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'opentsdb-consumer/result'
 
 RSpec.describe OpenTSDBConsumer::Result do
   describe '.initialize' do

data/spec/opentsdb-consumer/tags_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe OpenTSDBConsumer::Tags do
+  let(:tags) { { key: 'value' } }
+
+  describe '#new' do
+    context 'with empty tag' do
+      it 'throws EmptyTag exception' do
+        expect do
+          described_class.new(key: '')
+        end.to raise_error OpenTSDBConsumer::EmptyTag
+      end
+    end
+  end
+
+  describe '#to_h' do
+    subject { described_class.new(tags).to_h }
+
+    it { is_expected.to eq ({ key: 'value' }) }
+  end
+
+  describe '#to_s' do
+    subject { described_class.new(tags).to_s }
+
+    it { is_expected.to eq 'key=value' }
+  end
+
+  describe '#any?' do
+    subject { described_class.new(tags).any? }
+
+    it { is_expected.to be true }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentsdb-consumer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Philippe Hassig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,62 +30,90 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +155,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -140,12 +167,15 @@ files:
 - lib/opentsdb-consumer/query.rb
 - lib/opentsdb-consumer/rate.rb
 - lib/opentsdb-consumer/result.rb
+- lib/opentsdb-consumer/tags.rb
+- lib/opentsdb_consumer.rb
 - opentsdb-consumer.gemspec
 - spec/opentsdb-consumer/client_spec.rb
 - spec/opentsdb-consumer/metric_spec.rb
 - spec/opentsdb-consumer/query_spec.rb
 - spec/opentsdb-consumer/rate_spec.rb
 - spec/opentsdb-consumer/result_spec.rb
+- spec/opentsdb-consumer/tags_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ninech/
 licenses:
@@ -167,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Client library to consume metrics from OpenTSDB
@@ -177,4 +207,5 @@ test_files:
 - spec/opentsdb-consumer/query_spec.rb
 - spec/opentsdb-consumer/rate_spec.rb
 - spec/opentsdb-consumer/result_spec.rb
+- spec/opentsdb-consumer/tags_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,118 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.8)
-    builder (3.2.2)
-    byebug (5.0.0)
-      columnize (= 0.9.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    coveralls (0.8.2)
-      json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    domain_name (0.5.24)
-      unf (>= 0.0.5, < 1.0.0)
-    excon (0.45.4)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.12.4)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
-      oauth2
-    hashie (3.4.2)
-    highline (1.7.3)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.3)
-    jwt (1.5.1)
-    method_source (0.8.2)
-    mime-types (2.6.1)
-    mini_portile (0.6.2)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    netrc (0.10.3)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.4.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.1)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    term-ansicolor (1.3.2)
-      tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tins (1.6.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  byebug
-  coveralls
-  excon (~> 0.45.0)
-  jeweler (~> 2.0.1)
-  pry
-  rdoc (~> 3.12)
-  rspec (~> 3.3.0)
-
-BUNDLED WITH
-   1.10.6