opentsdb-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ebb5075958cfa76233980e4dae55bd0ad30e28e
+  data.tar.gz: 003174b10051ea7d851344a17ca254a31136d9d3
+SHA512:
+  metadata.gz: 827664beb3f3aaea2c5a2e010940738214bec02afdba5532629eaf9747bd418668a7f6e8655192fa607914320906d1d330315501c8cfa889b907b879befd5a46
+  data.tar.gz: 51b7fd589fa67d8490133476336a3e11070d0798062da5588d3a41fee5a38dabbffb0fca6b93734de1cdcee0f9878fd449ebacb6a6c53ba02a918563b2597ab5

data/README.md

@@ -0,0 +1,62 @@
+# opentsdb-ruby
+
+Ruby client for OpenTSDB HTTP Query API. 
+
+[![Build Status](https://travis-ci.org/cloudinsight/opentsdb-ruby.png)](https://travis-ci.org/cloudinsight/opentsdb-ruby) [![Code Climate](https://codeclimate.com/github/cloudinsight/opentsdb-ruby/badges/gpa.svg)](https://codeclimate.com/github/cloudinsight/opentsdb-ruby) 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'openstd-ruby', github: 'cloudinsight/opentsdb-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openstd-ruby
+
+
+## Quick Start Guide
+
+### Configure openstdb
+
+```ruby
+    #config/initializers/cloudinsight_openstdb.rb
+    
+    if defined?(CloudInsight)
+      CloudInsight::Opentsdb.configure do |config|
+        config.host = 'localhost'  # opentsdb server host default: localhost
+        config.port =  4242        # opentsdb server port default: 4242
+      end 
+    end
+
+```
+
+### Usage
+
+```ruby
+
+   # define simple query params
+  params = { begin: Time.now.ago(1.hour), q: 'avg:system.load.1{host=*}' }
+  # opensted
+  client = CloudInsight::Opentsdb::Client.new(params)
+  result = client.query # opentsdb json result
+
+
+ # 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 = CloudInsight::Opentsdb::Client.new(params)
+  result = client.query # opentsdb json result
+  
+
+# reconfig opentsdb host port
+  params = { host: '192.168.0.100', port: 8000, q: 'avg:system.load.1{host=*}' }
+  client = CloudInsight::Opentsdb::Client.new(params)
+  result = client.query # opentsdb json result
+```
+
+

data/lib/cloudinsight/opentsdb/client.rb

@@ -0,0 +1,46 @@
+require_relative 'http_client'
+module CloudInsight
+  module Opentsdb
+    # ruby client for OpenTsdb HTTP API
+    class Client
+      extend Forwardable
+
+      def_instance_delegators :@http, :post
+
+      attr_reader :host, :port, :query_options
+
+      def initialize(options = {})
+        @host = options.delete(:host) || Opentsdb.host
+        @port = options.delete(:port) || Opentsdb.port
+        @http = HttpClient.new
+        @query_options = options
+      end
+
+      def query
+        [].tap do |data|
+          parse_queries.each do |query_commad|
+            data << post(query_uri, query_commad.to_json)
+          end
+        end
+      end
+
+      def parse_queries
+        [].tap do |qs|
+          query_options[:q].split(';').each do |q|
+            query = QueryParser.parse(q)
+            query.interval   = query_options[:interval]
+            query.start_time = query_options[:begin].to_i
+            query.end_time   = query_options[:end].to_i
+            qs << query
+          end
+        end
+      end
+
+      private
+
+      def query_uri
+        URI("http://#{host}:#{port}/api/query")
+      end
+    end
+  end
+end

data/lib/cloudinsight/opentsdb/http_client.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'benchmark'
+module CloudInsight
+  module Opentsdb
+    # :nodoc:
+    class HttpClient
+      def post(uri, body)
+        send_http(uri) do |http|
+          Opentsdb.logger.debug "Http post body: #{body}"
+          req = Net::HTTP::Post.new(uri, headers)
+          req.body = body
+          http.request(req)
+        end
+      end
+
+      private
+
+      def headers
+        { 'Content-Type' => 'application/json; charset=UTF-8' }
+      end
+
+      def send_http(uri)
+        Opentsdb.logger.info "Http request uri: #{uri}"
+        http = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https')
+        res = nil
+        time = Benchmark.realtime do
+          res = yield(http)
+        end
+        Opentsdb.logger.info "Response: #{res.code} consume: #{time} s"
+        res
+      rescue Timeout::Error, Errno::ECONNRESET, Net::HTTPBadResponse,
+             Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        Opentsdb.logger.error "Http request error: #{e}"
+        false
+      end
+    end
+  end
+end

data/lib/cloudinsight/opentsdb/query_param.rb

@@ -0,0 +1,65 @@
+module CloudInsight
+  # :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
+
+    def start_time
+      @start_time > 0 ? to_ms(@start_time) : (end_time - 3_600_000) # 1 hour ago
+    end
+
+    def end_time
+      @end_time > 0 ? to_ms(@end_time) : to_ms(Time.now)
+    end
+
+    def to_json
+      {}.tap do |h|
+        h[:start]   = start_time
+        h[:end]     = end_time
+        h[:queries] = queries
+      end.to_json
+    end
+
+    def tags
+      @tags.each do |tagk, tagv|
+        @tags[tagk] = tagv.to_a.compact.join('|') if tagv.is_a?(Array) || tagv.is_a?(Set)
+      end
+    end
+
+    def downsample
+      "#{interval}s-#{aggregator_for}" if interval
+    end
+
+    private
+
+    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]       = tags
+        qh[:downsample] = downsample if downsample
+      end]
+    end
+
+    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/cloudinsight/opentsdb/query_parser.rb

@@ -0,0 +1,80 @@
+module CloudInsight
+  module Opentsdb
+    # :nodoc:
+    class QueryParser
+      class << self
+        def parse(q_string)
+          parts = split_for(q_string, ':')
+          return nil if parts.size < 2 || parts.size > 3
+          metric_query = {}
+          metric_query[:aggregator] = parts[0]
+          metric_query[:rate] = false
+          temp = parts[1]
+          if parts.size == 3
+            metric_query[:rate] = true if temp.start_with?('rate')
+            temp = parts[2]
+          end
+          query_metric = parse_query_metric(temp)
+          QueryParam.new metric_query.merge(query_metric)
+        end
+
+        private
+
+        def parse_query_metric(metric)
+          start_index = metric.index('{')
+          return { metric: metric } unless start_index
+          {}.tap do |h|
+            h[:metric] = metric[0...start_index]
+            end_index = metric.index('}')
+            h[:tags] = parse_tags metric[(start_index + 1)...end_index].strip
+            groups_str = metric[(end_index + 1)..-1]
+            if groups_str.size > 5 # length of by{} is 4
+              h[:group] = parse_groups groups_str
+              h[:group].each { |group| h[:tags][group] ||= ['*'] }
+            end
+          end
+        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
+          end
+          rtags
+        end
+
+        def parse_groups(groups_str)
+          start_index = groups_str.index('{')
+          end_index = groups_str.index('}')
+          groups = groups_str[(start_index + 1)...end_index].strip
+          return [] if groups.empty?
+          split_for(groups, ',').map(&:strip)
+        end
+
+        def split_for(string, token = ':')
+          result = []
+          index = start = pos = 0
+          is_in_bracket = false
+          string.each_char do |char|
+            if char == '{'
+              is_in_bracket = true
+            elsif char == '}'
+              is_in_bracket = false
+            elsif char == token && !is_in_bracket
+              result[index] = string[start...pos]
+              index += 1
+              start = pos + 1
+            end
+            pos += 1
+          end
+          result[index] = string[start...pos]
+          result
+        end
+      end
+    end
+  end
+end

data/lib/cloudinsight/opentsdb/version.rb

@@ -0,0 +1,5 @@
+module CloudInsight
+  module Opentsdb
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/cloudinsight/opentsdb.rb

@@ -0,0 +1,39 @@
+module CloudInsight
+  # :nodoc:
+  module Opentsdb
+    #:nodoc:
+    class << self
+      attr_accessor :host, :port
+
+      def configure
+        yield self
+      end
+
+      def host
+        @host || 'localhost'
+      end
+
+      def port
+        @port || 4242
+      end
+
+      def reset
+        @host = nil
+        @port = nil
+      end
+
+      def logger
+        @logger ||= begin
+          Logger.new(STDOUT).tap { |logger| logger.datetime_format = '%Y-%m-%d %H:%M:%S' }
+        end
+      end
+    end
+  end
+end
+require 'logger'
+require 'net/http'
+require 'cloudinsight/opentsdb/version'
+require 'cloudinsight/opentsdb/client'
+require 'cloudinsight/opentsdb/query_parser'
+require 'cloudinsight/opentsdb/query_param'
+require 'forwardable'

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: opentsdb-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lizhe
+- luyingrui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A ruby client library for querying data by OpenTSDB HTTP API.
+email:
+- lnz013@qq.com
+- luyingrui@oneapm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/cloudinsight/opentsdb.rb
+- lib/cloudinsight/opentsdb/client.rb
+- lib/cloudinsight/opentsdb/http_client.rb
+- lib/cloudinsight/opentsdb/query_param.rb
+- lib/cloudinsight/opentsdb/query_parser.rb
+- lib/cloudinsight/opentsdb/version.rb
+homepage: https://github.com/cloudinsight/opentsdb-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Ruby client for OpenTSDB HTTP Query API.
+test_files: []