opentsdb-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0965273870cf1d0e970171c7f3feb80e14de6050
-  data.tar.gz: 7bd33e7972ef2a6c1f194fe4d042d2b137835f9d
+  metadata.gz: c6358b79d7e73fa08c4da97bdb3d195d24d08f20
+  data.tar.gz: 1cc144968d1f8850dabb531163ed5268ffb54cea
 SHA512:
-  metadata.gz: b35e664047831e9afa4f5d93f0a1a58f868d65eb8b4b5b13b7b1a6bc2fab9e9c6c323cec0b88f87f228546bb954265d446ceeac7d4e44153b5ca7a805a53b280
-  data.tar.gz: 2c155b03575e551bae84f72e8a0674857e7427486730a449c2d900de5f8d7db754ebb88e3627ed8aeda68b3b6436d6a0c56d1d29397bd34f057d47b622678e9c
+  metadata.gz: bff20bcf46714f1adff97035646bd0d3b387d086e5393866a966d7f72623e514fa2639c67963449043cd2af4131a80d05a44845edbaea41c6d36733b1d3803f8
+  data.tar.gz: 44663760bc00891ab53b225c90b6d5613f2156b3eef69d08816fe10cb88647f56619a184d7dafceef0d5ee34374ae9b57be50e23e26aa3848d0f5ec04c7f3610

data/README.md

@@ -26,12 +26,12 @@ Or install it yourself as:
 ### Configure opentsdb
 
 ```ruby
-    #config/initializers/opentsdb.rb
-    #require 'opentsdb'
-    Opentsdb.configure do |config|
-      config.host = 'localhost'  # opentsdb server host default: localhost
-      config.port =  4242        # opentsdb server port default: 4242
-    end 
+  #config/initializers/opentsdb.rb
+  #require 'opentsdb'
+  Opentsdb.configure do |config|
+    config.host = 'localhost'  # opentsdb server host default: localhost
+    config.port =  4242        # opentsdb server port default: 4242
+  end 
 ```
 
 ### Usage
@@ -43,18 +43,53 @@ Or install it yourself as:
   # opensted
   client = Opentsdb::Client.new(params)
   result = client.query # opentsdb json result
-
+  # => { status: 'ok', condition: #<Opentsdb::QueryParam: @metric="system.load.1",..., result: '[{"metric": "system.load.1", "tags": ... "dps":[...]}]}'
 
   # complicate query params
   params = { begin: Time.now.ago(1.hour), end: Time.now, q: 'avg:system.load.1{host=server1, host=server2, tagk=tagv}by{host}', interval: 360 }
   client = Opentsdb::Client.new(params)
   result = client.query # opentsdb json result
-  
+  # => { status: 'ok', condition: #<Opentsdb::QueryParam: @metric="system.load.1",..., result: '[{"metric": "system.load.1", "tags": ... "dps":[...]}]}'
 
-  # reconfig opentsdb host port
+  # reconfig opentsdb host and port
   params = { host: '192.168.0.100', port: 8000, q: 'avg:system.load.1{host=*}' }
   client = Opentsdb::Client.new(params)
   result = client.query # opentsdb json result
+  # => { status: 'ok', condition: #<Opentsdb::QueryParam: @metric="system.load.1",..., result: '[{"metric": "system.load.1", "tags": ... "dps":[...]}]}'
+
+  #query exception
+  client = Opentsdb::Client.new(q: 'avg:unknown_metric')
+  result = client.query # opentsdb json result
+  # => { status: 'error', condition: #<Opentsdb::QueryParam: @metric="system.load.1",..., result: '{"error":{"code":400,"message":"No such name for 'metrics'...}}'
+
 ```
 
+### Contributing
+  
+#### Fork the Project
+  
+  ```
+  $ git https://github.com/cloudinsight/opentsdb-ruby.git
+  $ cd opentsdb-ruby
+  $ git remote add upstream https://github.com/cloudinsight/opentsdb-ruby.git  
+  ```
+#### Create a Toptic Branch
+
+  ```
+  $ git checkout master
+  $ git pull upstream master
+  $ git checkout -b my-feature-branch
+  ```
+#### Run Test 
+  ```
+  $ bundle exec rake test
+  ```
+#### Make a Pull Request
+
+  Click the `'Pull Request'` button and fill out the form.
+
+### License
+
+MIT License. See [LICENSE](https://github.com/cloudinsight/opentsdb-ruby/blob/master/LICENSE.md) for details.
+
 

data/lib/opentsdb/client.rb

@@ -6,24 +6,27 @@ module Opentsdb
 
     def_instance_delegators :@http, :post
 
-    attr_reader :host, :port, :query_options
+    attr_reader :host, :port
+    attr_accessor :query_commads
 
     def initialize(options = {})
       @host = options.delete(:host) || Opentsdb.host
       @port = options.delete(:port) || Opentsdb.port
       @http = HttpClient.new
-      @query_options = options
+      @query_commads = parse_queries options
     end
 
     def query
-      [].tap do |data|
-        parse_queries.each do |query_commad|
-          data << post(query_uri, query_commad.to_json)
+      [].tap do |results|
+        query_commads.each do |query_commad|
+          res = post(query_uri, query_commad.to_json)
+          status = res.code.to_i == 200 ? 'ok' : 'error'
+          results << { status: status, condition: query_commad, result: res.body }
         end
       end
     end
 
-    def parse_queries
+    def parse_queries(query_options = {})
       [].tap do |qs|
         query_options[:q].split(';').each do |q|
           query = QueryParser.parse(q)

data/lib/opentsdb/http_client.rb

@@ -25,7 +25,7 @@ module Opentsdb
       time = Benchmark.realtime do
         res = yield(http)
       end
-      Opentsdb.logger.info "Response: #{res.code} consume: #{time} s"
+      Opentsdb.logger.info "Response Code: #{res.code} Consume: #{time} s"
       res
     rescue Timeout::Error, Errno::ECONNRESET, Net::HTTPBadResponse,
            Net::HTTPHeaderSyntaxError, Net::ProtocolError => e

data/lib/opentsdb/query_errors.rb

@@ -0,0 +1,5 @@
+module Opentsdb
+  module QueryErrors
+    class InvalidRateOptionError < StandardError; end
+  end
+end

data/lib/opentsdb/query_param.rb

@@ -1,63 +1,70 @@
-# :nodoc:
-class QueryParam
-  attr_accessor :aggregator, :rate, :metric, :tags, :downsample, :interval
-  attr_accessor :start_time, :end_time, :queries
-
-  def initialize(options = {})
-    @aggregator = options[:aggregator]
-    @rate       = options[:rate] || false
-    @metric     = options[:metric]
-    @tags       = options[:tags] || {}
-  end
+module Opentsdb
+  # :nodoc:
+  class QueryParam
+    attr_accessor :aggregator, :rate, :metric, :tags, :interval, :downsample, :rate_options, :group
+    attr_accessor :start_time, :end_time
 
-  def start_time
-    @start_time > 0 ? to_ms(@start_time) : (end_time - 3_600_000) # 1 hour ago
-  end
+    def initialize(options = {})
+      @aggregator   = options[:aggregator]
+      @rate         = options[:rate] || false
+      @metric       = options[:metric]
+      @tags         = options[:tags] || {}
+      @rate_options = options[:rate_options]
+      @group        = options[:group] || []
+    end
 
-  def end_time
-    @end_time > 0 ? to_ms(@end_time) : to_ms(Time.now)
-  end
+    def start_time
+      @start_time > 0 ? to_ms(@start_time) : (end_time - 3_600_000) # 1 hour ago
+    end
 
-  def to_json
-    {}.tap do |h|
-      h[:start]   = start_time
-      h[:end]     = end_time
-      h[:queries] = [queries]
-    end.to_json
-  end
+    def end_time
+      @end_time > 0 ? to_ms(@end_time) : to_ms(Time.now)
+    end
 
-  def tags
-    @tags.each do |tagk, tagv|
-      @tags[tagk] = tagv.to_a.compact.join('|') if tagv.is_a?(Array) || tagv.is_a?(Set)
+    def to_json
+      {}.tap do |h|
+        h[:start]   = start_time
+        h[:end]     = end_time
+        h[:queries] = [queries]
+      end.to_json
     end
-  end
 
-  def downsample
-    "#{interval}s-#{aggregator_for}" if interval
-  end
+    def to_query_tags
+      {}.tap do |qtags|
+        tags.each do |tagk, tagv|
+          qtags[tagk] = tagv.to_a.compact.join('|') if tagv.is_a?(Array) || tagv.is_a?(Set)
+          qtags[tagk] = '*' if tagv.nil? || tagv.empty?
+        end
+      end
+    end
 
-  private
+    def downsample
+      "#{interval}s-#{aggregator_for}" if interval
+    end
 
-  def to_ms(time = Time.now)
-    (time.to_f * 1000).to_i
-  end
+    private
 
-  def queries
-    {}.tap do |qh|
-      qh[:aggregator] = aggregator
-      qh[:rate]       = rate
-      qh[:metric]     = metric
-      qh[:tags]       = tags
-      qh[:downsample] = downsample if downsample
+    def to_ms(time = Time.now)
+      (time.to_f * 1000).to_i
+    end
+
+    def queries
+      {}.tap do |qh|
+        qh[:aggregator] = aggregator
+        qh[:rate]       = rate
+        qh[:metric]     = metric
+        qh[:tags]       = to_query_tags
+        qh[:downsample] = downsample if downsample
+      end
     end
-  end
 
-  def aggregator_for
-    case aggregator
-    when 'sum', 'avg' then 'avg'
-    when 'min'        then 'mimmin'
-    when 'max'        then 'mimmax'
-    else 'avg'
+    def aggregator_for
+      case aggregator
+      when 'sum', 'avg' then 'avg'
+      when 'min'        then 'mimmin'
+      when 'max'        then 'mimmax'
+      else 'avg'
+      end
     end
   end
 end

data/lib/opentsdb/query_parser.rb

@@ -8,18 +8,20 @@ module Opentsdb
         metric_query = {}
         metric_query[:aggregator] = parts[0]
         metric_query[:rate] = false
-        temp = parts[1]
+        metic = parts[1]
         if parts.size == 3
-          metric_query[:rate] = true if temp.start_with?('rate')
-          temp = parts[2]
+          if metic.start_with?('rate')
+            metric_query[:rate] = true
+            metric_query[:rate_options] = parse_rate(metic) if temp.index('{')
+          end
+          metic = parts[2]
         end
-        query_metric = parse_query_metric(temp)
-        QueryParam.new metric_query.merge(query_metric)
+        QueryParam.new metric_query.merge(parse_metric(metic))
       end
 
       private
 
-      def parse_query_metric(metric)
+      def parse_metric(metric)
         start_index = metric.index('{')
         return { metric: metric } unless start_index
         {}.tap do |h|
@@ -34,16 +36,29 @@ module Opentsdb
         end
       end
 
+      def parse_rate(spec)
+        return QueryRateOptions.default if spec.size == 4
+        raise QueryErrors::InvalidRateOptionError, "invalid specification: #{spec}" if spec.size < 6
+        parts = split_for(spec[5..-1], ',')
+        if parts.empty? || parts.size > 3
+          raise QueryErrors::InvalidRateOptionError, "Incrrenct numbers of values: #{spec}"
+        end
+        is_counter = parts[0] == 'counter'
+        max = parts[1].nil? ? 9_999_999_999 : parts[1].to_i
+        reset = parts[2].nil? ? 0 : parts[2].to_i
+        QueryRateOptions.new is_counter, max, reset
+      end
+
       def parse_tags(tags)
         return if tags.nil?
-        rtags = {}
-        split_for(tags, ',').each do |tag|
-          tagk, tagv = split_for(tag, '=')
-          next if tagk.nil? || tagv.nil?
-          rtags[tagk] ||= []
-          rtags[tagk].concat tagv.split('|').uniq
+        Hash.new { |h, k| h[k] = [] }.tap do |rtags|
+          split_for(tags, ',').each do |tag|
+            tagk, tagv = split_for(tag, '=')
+            next if tagk.nil? || tagv.nil?
+            rtags[tagk] ||= []
+            rtags[tagk].concat tagv.split('|').uniq
+          end
         end
-        rtags
       end
 
       def parse_groups(groups_str)
@@ -71,7 +86,7 @@ module Opentsdb
           pos += 1
         end
         result[index] = string[start...pos]
-        result
+        result.map(&:strip)
       end
     end
   end

data/lib/opentsdb/query_rate_options.rb

@@ -0,0 +1,16 @@
+module Opentsdb
+  # :nodoc:
+  class QueryRateOptions
+    attr_accessor :counter, :counter_max, :reset_value
+
+    def initialize(counter, counter_max, reset_value)
+      @counter = counter
+      @counter_max = counter_max
+      @reset_value = reset_value
+    end
+
+    def self.default
+      new(false, 9_999_999_999, 0)
+    end
+  end
+end

data/lib/opentsdb/version.rb

@@ -1,3 +1,3 @@
 module Opentsdb
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentsdb-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - lizhe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -155,8 +155,10 @@ files:
 - lib/opentsdb.rb
 - lib/opentsdb/client.rb
 - lib/opentsdb/http_client.rb
+- lib/opentsdb/query_errors.rb
 - lib/opentsdb/query_param.rb
 - lib/opentsdb/query_parser.rb
+- lib/opentsdb/query_rate_options.rb
 - lib/opentsdb/version.rb
 homepage: https://github.com/cloudinsight/opentsdb-ruby
 licenses: