tsdb_time_series 4.1.2

data/lib/time_series/version.rb

@@ -0,0 +1,9 @@
+# -*- encoding: utf-8 -*-
+# @see Opower::TimeSeries::TSDBClient
+module Opower
+  # @see Opower::TimeSeries::TSDBClient
+  module TimeSeries
+    # Controls the version of the TimeSeries gem.
+    VERSION = '4.1.2'
+  end
+end

data/spec/acceptance/lib/time_series/metric_spec.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+require 'time_series'
+
+describe Opower::TimeSeries::TSClient do
+  describe '#write' do
+    subject { Opower::TimeSeries::TSClient.new('127.0.0.1', 60000) }
+    let(:config) { { name: 'test1.test2', timestamp: 12132342, value: 1, tags: { host: 'localhost' } } }
+    let(:metric) { Opower::TimeSeries::Metric.new(config) }
+
+    context 'in dry run mode' do
+      it 'returns the put string' do
+        subject.configure(dry_run: true)
+        call = subject.write(metric)
+        expect(call).to eq("echo \"put test1.test2 12132342 1 host=localhost\" | nc -w 30 127.0.0.1 60000")
+      end
+    end
+
+    context 'in normal mode' do
+      it 'errors on failing to insert data' do
+        message = "Failed to insert metric #{metric.name} with value of #{metric.value} into OpenTSDB."
+        expect { subject.write(metric) }.to raise_error(IOError, message)
+      end
+    end
+  end
+end

data/spec/acceptance/lib/time_series/synthetic_result_spec.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+require 'time_series'
+
+describe Opower::TimeSeries::TSClient do
+  describe '#run_synthetic_query' do
+    subject { Opower::TimeSeries::TSClient.new('opentsdb.foo.com', 4242) }
+
+    it 'computes a simple formula correctly' do
+      m = [{ metric: 'sys.numa.allocation', tags: { host: 'opentsdb.foo.com' } }]
+      config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+      @query_one = Opower::TimeSeries::Query.new(config)
+
+      m = [{ metric: 'sys.numa.zoneallocs', tags: { host: 'opentsdb.foo.com' } }]
+      config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+      @query_two = Opower::TimeSeries::Query.new(config)
+
+      # stub requests
+      stub_request(:get, subject.query_uri(@query_one)).to_return(status: 200, body: Fixtures::SYS_ALLOCATION)
+      stub_request(:get, subject.query_uri(@query_two)).to_return(status: 200, body: Fixtures::SYS_ZONE_ALLOCS)
+
+      synthetic_results = subject.run_synthetic_query('test', 'x / y', x: @query_one, y: @query_two)
+      expect(synthetic_results.length).not_to eq(0)
+    end
+  end
+end

data/spec/acceptance/lib/time_series/ts_client_spec.rb

@@ -0,0 +1,146 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+require 'time_series'
+
+describe Opower::TimeSeries::TSClient do
+  describe '#suggest' do
+    subject { Opower::TimeSeries::TSClient.new('opentsdb.foo.com', 4242) }
+
+    before do
+      stub_request(:get, subject.suggest_uri('mtest')).to_return(body: '[]')
+      stub_request(:get, subject.suggest_uri('sys')).to_return(body: Fixtures::SUGGEST_SYS)
+    end
+
+    context 'in dry run mode' do
+      subject do
+        super().configure(dry_run: true)
+        super()
+      end
+
+      it 'returns the proper URI' do
+        url = subject.suggest_uri('mtest')
+        expect(url).to eq('http://opentsdb.foo.com:4242/api/suggest?type=metrics&q=mtest&max=25')
+      end
+    end
+
+    context 'in normal mode' do
+      subject do
+        super().configure(dry_run: false)
+        super()
+      end
+
+      it 'returns an empty array for a query with no expected results' do
+        suggestions = subject.suggest('mtest')
+        expect(suggestions).to eq([])
+      end
+
+      it 'returns data for a query with expected results' do
+        suggestions = subject.suggest('sys')
+        expect(suggestions).to eq(JSON.parse(Fixtures::SUGGEST_SYS))
+      end
+    end
+  end
+
+  describe '#run_query' do
+    subject { Opower::TimeSeries::TSClient.new('opentsdb.foo.com', 4242) }
+
+    context 'with invalid input' do
+      it 'raises an error for a bad metric name' do
+        m = [{ metric: 'mtest' }]
+        config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        stub_request(:get, subject.query_uri(query)).to_return(status: 500, body: Fixtures::BAD_METRIC)
+
+        results = subject.run_query(query).results
+        expect(results).to include(JSON.parse(Fixtures::BAD_METRIC))
+      end
+
+      it 'raises an error for a bad tagk name ' do
+        m = [{ metric: 'sys.numa.allocation', tags: { bad_tagk: 'opentsdb.foo.com' } }]
+        config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        stub_request(:get, subject.query_uri(query)).to_return(status: 500, body: Fixtures::BAD_TAGK)
+
+        results = subject.run_query(query).results
+        expect(results).to include(JSON.parse(Fixtures::BAD_TAGK))
+      end
+    end
+
+    context 'with valid input' do
+      it 'returns an empty JSON array for a query with no expected results' do
+        m = [{ metric: 'sys.numa.allocation' }]
+        config = { format: :json, start: 1420676714, finish: 1420676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        stub_request(:get, subject.query_uri(query)).to_return(status: 200, body: '[]')
+
+        results = subject.run_query(query).results
+        expect(results).to eq([])
+      end
+
+      it 'returns data for a query in JSON format' do
+        m = [{ metric: 'sys.numa.allocation', tags: { host: 'opentsdb.foo.com' } }]
+        config = { format: :json, start: 1420676714, finish: 1420676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        stub_request(:get, subject.query_uri(query)).to_return(body: Fixtures::SYS_ALLOCATION)
+
+        results = subject.run_query(query).results
+        expect(results).to eq(JSON.parse(Fixtures::SYS_ALLOCATION))
+      end
+
+      it 'returns data for a rate query in JSON format' do
+        m = [{ metric: 'sys.numa.allocation', rate: true, tags: { host: 'opentsdb.foo.com' } }]
+        config = { format: :json, start: 1420676714, finish: 1420676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        stub_request(:get, subject.query_uri(query)).to_return(body: Fixtures::SYS_ALLOC_RATE)
+
+        results = subject.run_query(query).results
+        expect(results).to eq(JSON.parse(Fixtures::SYS_ALLOC_RATE))
+      end
+
+      it 'returns a URL for a query in PNG format' do
+        m = [{ metric: 'sys.numa.allocation', tags: { host: 'opentsdb.foo.com' } }]
+        config = { format: :png, start: 1420676714, finish: 1420676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+        results = subject.run_query(query)
+        expect(results).not_to eq('')
+        expect(results).not_to include('Internal Server Error')
+      end
+
+      it 'returns data for multiple queries' do
+        queries = []
+        3.times do
+          m = [{ metric: 'sys.numa.allocation', tags: { host: 'opentsdb.foo.com' } }]
+          config = { format: :json, start: '1h-ago', m: m }
+          query = Opower::TimeSeries::Query.new(config)
+          stub_request(:get, subject.query_uri(query)).to_return(body: Fixtures::SYS_ALLOCATION)
+          queries << query
+        end
+
+        results = subject.run_queries(queries)
+        expect(results.length).to eq(3)
+        results.each do |r|
+          expect(r.results).not_to eq('')
+        end
+      end
+    end
+  end
+
+  describe '#valid?' do
+    subject { Opower::TimeSeries::TSClient.new('opentsdb.foo.com', 4242) }
+
+    context 'with a valid connection' do
+      it 'returns true' do
+        stub_request(:get, "#{subject.client}api/version").to_return(status: 200)
+        expect(subject.valid?).to be_truthy
+      end
+    end
+
+    context 'with an invalid connection' do
+      it 'returns false' do
+        stub_request(:get, "#{subject.client}api/version").to_timeout
+        expect(subject.valid?).to be_falsey
+      end
+    end
+  end
+end

data/spec/fixtures.rb

@@ -0,0 +1,17 @@
+# Fixtures wrapper - contains raw data used by webmocks
+module Fixtures
+  def self.fixture(filename)
+    File.expand_path("../fixtures/#{filename}", __FILE__)
+  end
+
+  def self.read_file(filename)
+    IO.read(fixture(filename))
+  end
+
+  BAD_METRIC = read_file('errors/no_metric.json')
+  BAD_TAGK = read_file('errors/no_tag_key.json')
+  SUGGEST_SYS = read_file('suggest/sys.json')
+  SYS_ALLOCATION = read_file('query/sys.numa.allocation.json')
+  SYS_ALLOC_RATE = read_file('query/sys.numa.allocation.rate.json')
+  SYS_ZONE_ALLOCS = read_file('query/sys.numa.zoneallocs.json')
+end

data/spec/fixtures/errors/no_metric.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": 500,
+    "message": "No such name for 'metrics': 'mtest'"
+  }
+}

data/spec/fixtures/errors/no_tag_key.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": 500,
+    "message": "No such name for 'tagk': 'bad_tagk'"
+  }
+}

data/spec/fixtures/query/sys.numa.allocation.json

@@ -0,0 +1,17 @@
+[
+  {
+    "metric": "sys.numa.allocation",
+    "tags": { "host": "opentsdb.foo.com" },
+    "aggregateTags": [
+      "type",
+      "node"
+    ],
+    "dps": {
+      "1421676714": 15,
+      "1421676729": 16,
+      "1421676744": 0,
+      "1421676759": 5,
+      "1421676774": 13
+    }
+  }
+]

data/spec/fixtures/query/sys.numa.allocation.rate.json

@@ -0,0 +1,17 @@
+[
+  {
+    "metric": "sys.numa.allocation",
+    "tags": { "host": "opentsdb.foo.com" },
+    "aggregateTags": [
+      "type",
+      "node"
+    ],
+    "dps": {
+      "1421676714": 0.02,
+      "1421676729": 0.05,
+      "1421676744": 0,
+      "1421676759": 0.01,
+      "1421676774": 0.02
+    }
+  }
+]

data/spec/fixtures/query/sys.numa.zoneallocs.json

@@ -0,0 +1,17 @@
+[
+  {
+    "metric": "sys.numa.zoneallocs",
+    "tags": {"host": "opentsdb.foo.com"},
+    "aggregateTags": [
+      "type",
+      "node"
+    ],
+    "dps": {
+      "1421676714": 3,
+      "1421676729": 2,
+      "1421676744": 55,
+      "1421676759": 1,
+      "1421676774": 3
+    }
+  }
+]

data/spec/fixtures/suggest/sys.json

@@ -0,0 +1 @@
+["sys.numa.allocation","sys.numa.foreign_allocs","sys.numa.interleave","sys.numa.zoneallocs","system.context_switches_per_second","system.interrupts_per_second"]

data/spec/integration/lib/time_series/integration_spec.rb

@@ -0,0 +1,129 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+require 'time_series'
+require 'docker'
+
+describe Opower::TimeSeries::TSClient do
+  # Integration tests run inside a Docker container
+  before :all do
+    # allow HTTP during integration tests
+    WebMock.allow_net_connect!
+
+    @container = Docker::Container.create('Image' => 'opower/opentsdb')
+    @container.start('PortBindings' => { '4242/tcp' => [{ 'HostPort' => '48000' }] })
+
+    # check if we're runing boot2docker
+    if ENV['DOCKER_HOST'].nil?
+      network_settings = @container.json.fetch('NetworkSettings')
+      @ip = network_settings.fetch('IPAddress') # TODO: verify this works for boot2docker
+      @port = 4242
+    else
+      @ip = `boot2docker ip 2> /dev/null`
+      @port = 48000
+    end
+
+    sleep 30
+    attempts = 0
+    client = Opower::TimeSeries::TSClient.new(@ip, @port)
+
+    while client.valid? == false && attempts < 10
+      sleep 5
+      attempts += 1
+    end
+
+    fail RemoteError('Failed to start Docker container!') if attempts > 10 && !client.valid?
+
+    # prewrite expected metrics
+    metrics = [{ name: 'cpu.load', timestamp: 1420676750, value: 1, tags: { host: 'localhost' } },
+               { name: 'test1.test2', timestamp: 12132343, value: 1, tags: { host: 'localhost' } },
+               { name: 'metric1', timestamp: 1421676714, value: 1, tags: { host: 'localhost' } },
+               { name: 'metric2', timestamp: 1421676714, value: 2, tags: { host: 'localhost' } }]
+
+    metrics.each { |metric| client.write(Opower::TimeSeries::Metric.new(metric)) }
+
+    # wait for OpenTSDB to synch
+    sleep 3
+  end
+
+  after :all do
+    @container.stop
+    @container.delete(force: true)
+
+    # resume blocking afterwards (in case acceptance tests afterwards)
+    WebMock.disable_net_connect!
+  end
+
+  describe '#suggest' do
+    subject { Opower::TimeSeries::TSClient.new(@ip, @port) }
+
+    context 'with no expected results' do
+      it 'returns an empty array' do
+        suggestions = subject.suggest('mtest')
+        expect(suggestions).to eq([])
+      end
+    end
+
+    context 'with expected results' do
+      it 'returns data' do
+        suggestions = subject.suggest('test1.test2')
+        expect(suggestions).to eq(['test1.test2'])
+      end
+    end
+  end
+
+  describe '#run_query' do
+    subject { Opower::TimeSeries::TSClient.new(@ip, @port) }
+
+    context 'with bad input' do
+      it 'raises an error for a bad metric name' do
+        m = [{ metric: 'mtest' }]
+        config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+
+        results = subject.run_query(query)
+        expect(results.errors?).to be_truthy
+        expect(results.error_message).to eq("No such name for 'metrics': 'mtest'")
+      end
+
+      it 'raises an error for a bad tagk name ' do
+        m = [{ metric: 'test1.test2', tags: { bad_tagk: 'opentsdb.foo.com' } }]
+        config = { format: :json, start: 1421676714, finish: 1421676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+
+        results = subject.run_query(query)
+        expect(results.errors?).to be_truthy
+        expect(results.error_message).to eq("No such name for 'tagk': 'bad_tagk'")
+      end
+    end
+
+    context 'with valid input' do
+      it 'returns data' do
+        m = [{ metric: 'cpu.load' }]
+        config = { format: :json, start: 1420676714, finish: 1420676774, m: m }
+        query = Opower::TimeSeries::Query.new(config)
+
+        results = subject.run_query(query).results
+        expect(results.length).not_to eq(0)
+        expect(results[0].fetch('dps')).to include('1420676750' => 1)
+      end
+    end
+  end
+
+  describe '#run_synthetic_query' do
+    subject { Opower::TimeSeries::TSClient.new(@ip, @port) }
+
+    it 'computes a simple formula correctly' do
+      m = [{ metric: 'metric1' }]
+      config = { format: :json, start: 1421676000, finish: 1421676774, m: m }
+      query_one = Opower::TimeSeries::Query.new(config)
+
+      m = [{ metric: 'metric2' }]
+      config = { format: :json, start: 1421676000, finish: 1421676774, m: m }
+      query_two = Opower::TimeSeries::Query.new(config)
+
+      synthetic_results = subject.run_synthetic_query('test', 'x / y', x: query_one, y: query_two)
+      expect(synthetic_results.length).not_to eq(0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'webmock/rspec'
+
+SimpleCov.start 'rails' do
+  coverage_dir 'metrics/coverage'
+end
+
+pid = Process.pid
+SimpleCov.at_exit do
+  SimpleCov.result.format! if Process.pid == pid
+end
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require File.expand_path('../fixtures.rb', __FILE__)