kairosdb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f9ee9138b5221d86f49c49be02be4658bfb472d
+  data.tar.gz: 32d7f983cda6e4c571773af6a4063850635d2035
+SHA512:
+  metadata.gz: 16723f83fd45856f24b8f69440cd73aacb4cdb9a288eef125ca99984f1308feccb885c2562163bab9255a1438437b3da55aa60f2d1deaed33410d4f0d7934c3a
+  data.tar.gz: 48ae45911a0319a8eafc385959c8b4fb9ddd8a0ac74337e10194293b6b991ad88d4f7dbc689c89f1708172465f0dbd55ab29711d6087b0599a8e005d293fd836

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at andre.leblanc@accelerated.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andre LeBlanc
+
+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,40 @@
+# KairosDB::Ruby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kairosdb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kairosdb-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kairosdb-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kairosdb-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/kairosdb-ruby.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kairosdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kairosdb"
+  spec.version       = KairosDB::VERSION
+  spec.authors       = ["Andre LeBlanc"]
+  spec.email         = ["andre.leblanc88@gmail.com"]
+
+  spec.summary       = %q{An unofficial Ruby library for KairosDB.}
+  spec.description   = %q{This is an unofficial Ruby library for KairosDB.}
+  spec.homepage      = "https://github.com/andremleblanc/kairosdb-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24.2"
+end

data/lib/kairosdb.rb

@@ -0,0 +1,9 @@
+require 'kairosdb/config'
+require 'kairosdb/errors'
+require 'kairosdb/logging'
+require 'kairosdb/version'
+require 'kairosdb/query/core'
+require 'kairosdb/query/metrics'
+
+require 'kairosdb/client/http'
+require 'kairosdb/client'

data/lib/kairosdb/client.rb

@@ -0,0 +1,35 @@
+module KairosDB
+  class Client
+    attr_reader :config, :writer
+
+    include KairosDB::HTTP
+    include KairosDB::Logging
+    include KairosDB::Query::Core
+    include KairosDB::Query::Metrics
+
+    # (see KairosDB::Config#initialize)
+    # @example
+    #   params = {
+    #     host: '172.0.0.1',
+    #     port: 8086
+    #   }
+    #   KairosDB::Client.new(params)
+    def initialize(opts = {})
+      @config = KairosDB::Config.new(opts)
+      @writer = self
+      @stopped = false
+
+      at_exit { stop! } if config.retry > 0
+    end
+
+    protected
+
+    def stop!
+      @stopped = true
+    end
+
+    def stopped?
+      @stopped
+    end
+  end
+end

data/lib/kairosdb/client/http.rb

@@ -0,0 +1,93 @@
+module KairosDB
+  module HTTP
+    def post(url, data)
+      headers = { 'Content-Type' => 'application/json' }
+      connect_with_retry do |http|
+        response = do_request http, Net::HTTP::Post.new(url, headers), JSON.generate(data)
+        if response.is_a? Net::HTTPSuccess
+          handle_successful_response(response)
+        else
+          resolve_error(response)
+        end
+      end
+    end
+
+    def delete(url)
+      connect_with_retry do |http|
+        response = do_request http, Net::HTTP::Delete.new(url)
+        if response.is_a? Net::HTTPSuccess
+          handle_successful_response(response)
+        elsif response.is_a? Net::HTTPNotFound
+          false
+        else
+          resolve_error(response)
+        end
+      end
+    end
+
+    private
+
+    def connect_with_retry(&block)
+      host = config.host
+      delay = config.initial_delay
+      retry_count = 0
+
+      begin
+        http = Net::HTTP.new(host, config.port)
+        http.open_timeout = config.open_timeout
+        http.read_timeout = config.read_timeout
+
+        block.call(http)
+
+      rescue Timeout::Error, *KairosDB::NET_HTTP_EXCEPTIONS => e
+        retry_count += 1
+        if (config.retry == -1 || retry_count <= config.retry) && !stopped?
+          log :error, "Failed to contact host #{host}: #{e.inspect} - retrying in #{delay}s."
+          sleep delay
+          delay = [config.max_delay, delay * 2].min
+          retry
+        else
+          raise KairosDB::ConnectionError, "Tried #{retry_count - 1} times to reconnect but failed."
+        end
+      ensure
+        http.finish if http.started?
+      end
+    end
+
+    def do_request(http, req, data = nil)
+      req.body = data if data
+      http.request(req)
+    end
+
+    def errors_from_response(parsed_response)
+      parsed_response.is_a?(Hash) && parsed_response.fetch('errors', nil)
+    end
+
+    def handle_successful_response(response)
+      parsed_response(response)
+    end
+
+    def parsed_response(response)
+      response.body ? JSON.parse(response.body) : response
+    end
+
+    def resolve_error(response)
+      parsed_response = parsed_response(response)
+      errors = errors_from_response(parsed_response) if parsed_response
+      raise KairosDB::QueryError, errors if errors
+      raise KairosDB::Error, response
+    end
+
+    def config
+      raise NotImplementedError, "This #{self.class} cannot respond to ##{__method__}"
+    end
+
+    def log(level, message)
+      raise NotImplementedError, "This #{self.class} cannot respond to ##{__method__}"
+    end
+
+    def stopped?
+      raise NotImplementedError, "This #{self.class} cannot respond to ##{__method__}"
+    end
+  end
+end

data/lib/kairosdb/config.rb

@@ -0,0 +1,24 @@
+module KairosDB
+  class Config
+    attr_accessor :host, :port, :initial_delay, :max_delay, :open_timeout,
+      :read_timeout, :retry
+
+    # @param [Hash]
+    # @option opts [String] :host the host url of KairosDB.
+    # @option opts [Integer] :port the port KairosDB is accessible on.
+    # @option opts [Float] :initial_delay minimum delay before retrying an HTTP connection.
+    # @option opts [Float] :max_delay maximum delay before retrying an HTTP connection.
+    # @option opts [Float] :write_timeout
+    # @option opts [Float] :read_timeout
+    # @option opts [Boolean] :retry number of times to retry an HTTP connection, setting this to -1 will cause infinite retries
+    def initialize(opts = {})
+      @host = opts.fetch(:host, 'localhost')
+      @port = opts.fetch(:port, 8080)
+      @initial_delay = opts.fetch(:initial_delay, 0.01)
+      @max_delay = opts.fetch(:max_delay, 30)
+      @open_timeout = opts.fetch(:write_timeout, 5)
+      @read_timeout = opts.fetch(:read_timeout, 300)
+      @retry = opts.fetch(:retry, 3)
+    end
+  end
+end

data/lib/kairosdb/errors.rb

@@ -0,0 +1,22 @@
+require "net/http"
+
+module KairosDB
+  class Error < StandardError ; end
+  class ConnectionError < Error ; end
+  class QueryError < Error ; end
+
+  # Adopted from: https://github.com/lostisland/faraday/blob/master/lib/faraday/adapter/net_http.rb
+  NET_HTTP_EXCEPTIONS = [
+    EOFError,
+    Errno::ECONNABORTED,
+    Errno::ECONNREFUSED,
+    Errno::ECONNRESET,
+    Errno::EHOSTUNREACH,
+    Errno::EINVAL,
+    Errno::ENETUNREACH,
+    Net::HTTPBadResponse,
+    Net::HTTPHeaderSyntaxError,
+    Net::ProtocolError,
+    SocketError
+  ]
+end

data/lib/kairosdb/logging.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module KairosDB
+  module Logging
+    PREFIX = "[KairosDB] "
+
+    class << self
+      attr_writer :logger
+    end
+
+    def self.logger
+      return false if @logger == false
+      @logger ||= ::Logger.new(STDERR).tap { |logger| logger.level = Logger::INFO }
+    end
+
+    def log(level, message)
+      KairosDB::Logging.logger.send(level.to_sym, PREFIX + message) if KairosDB::Logging.logger
+    end
+  end
+end

data/lib/kairosdb/query/core.rb

@@ -0,0 +1,59 @@
+require 'json'
+
+module KairosDB
+  module Query
+    module Core
+      KAIROSDB_DELETE_PATH = '/api/v1/metric'
+      KAIROSDB_QUERY_PATH = '/api/v1/datapoints/query'
+      KAIROSDB_WRITE_PATH = '/api/v1/datapoints'
+
+      # @param [Hash] opts
+      def query(opts = {})
+        url = full_path(KAIROSDB_QUERY_PATH)
+        metrics = fetch_metrics(post(url, opts))
+
+        if block_given?
+          metrics.each do |metric|
+            yield metric['name'], metric['tags'], metric['values']
+          end
+        else
+          metrics
+        end
+      end
+
+      # @param [Hash] opts
+      # @option opts [String] :name name of the measurement being recorded
+      # @option opts [Array<Integer, Numeric>] :datapoints one or many points to be recorded
+      # @option opts [Hash] :tags a hash of tags for the data points
+      def write_data(data)
+        writer.write(data)
+      end
+
+      protected
+
+      def write(data)
+        url = full_path(KAIROSDB_WRITE_PATH)
+        post(url, data)
+      end
+
+      private
+
+      def fetch_metrics(response)
+        response.fetch('queries', [])
+      end
+
+      def full_path(path, params = {})
+        query = params.map { |k, v| [CGI.escape(k.to_s), "=", CGI.escape(v.to_s)].join }.join("&")
+        URI::Generic.build(path: path, query: query).to_s
+      end
+
+      def config
+        raise NotImplementedError, "This #{self.class} cannot respond to ##{__method__}"
+      end
+
+      def writer
+        raise NotImplementedError, "This #{self.class} cannot respond to ##{__method__}"
+      end
+    end
+  end
+end

data/lib/kairosdb/query/metrics.rb

@@ -0,0 +1,10 @@
+module KairosDB
+  module Query
+    module Metrics
+      def delete_metric(name)
+        url = KairosDB::Query::Core::KAIROSDB_DELETE_PATH + '/' + name
+        delete(url)
+      end
+    end
+  end
+end

data/lib/kairosdb/version.rb

@@ -0,0 +1,3 @@
+module KairosDB
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: kairosdb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Andre LeBlanc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+description: This is an unofficial Ruby library for KairosDB.
+email:
+- andre.leblanc88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kairosdb-ruby.gemspec
+- lib/kairosdb.rb
+- lib/kairosdb/client.rb
+- lib/kairosdb/client/http.rb
+- lib/kairosdb/config.rb
+- lib/kairosdb/errors.rb
+- lib/kairosdb/logging.rb
+- lib/kairosdb/query/core.rb
+- lib/kairosdb/query/metrics.rb
+- lib/kairosdb/version.rb
+homepage: https://github.com/andremleblanc/kairosdb-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: An unofficial Ruby library for KairosDB.
+test_files: []
+has_rdoc: