efigence-influxdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b529434d3ed5510a7f29735a457bf34c05b5b4bd
+  data.tar.gz: 4858891f7501ee7fd7cf41f5d85ab4ac6a6b2296
+SHA512:
+  metadata.gz: 85eda83459f2a4f221994bd48d9b4f8d24edb24c5421322195765f48190ee6de07c75e9047576e1628782a4a1bc50681cce74b4c6498c7a9d94eb36ba7d75ed4
+  data.tar.gz: ec9a6468caf2e85825137da33311288c0b319c6a86b80c23aac5e03c49934165473d3462a4257c4b000edcb3c43eaa2819a82600b24e22d925f87fe6e2c9c71f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+.rvmrc
+.ruby-version
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+*.local

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+  RunRailsCops: false
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/RescueModifier:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/Void:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install:
+  - gem update bundler
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - ruby-head
+  - jruby-20mode
+  - jruby-21mode
+  - jruby-head

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "webmock", git: "https://github.com/influxdb/webmock.git"
+
+local_gemfile = 'Gemfile.local'
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Todd Persen
+
+MIT License
+
+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,362 @@
+influxdb-ruby
+=============
+
+[![Build Status](https://travis-ci.org/influxdb/influxdb-ruby.png?branch=master)](https://travis-ci.org/influxdb/influxdb-ruby)
+
+The official ruby client library for [InfluxDB](https://influxdb.com/).
+
+Install
+-------
+
+```
+$ [sudo] gem install influxdb
+```
+
+Or add it to your `Gemfile`, etc.
+
+Usage
+-----
+
+Connecting to a single host:
+
+``` ruby
+require 'influxdb'
+
+influxdb = InfluxDB::Client.new host: "influxdb.domain.com"
+# or
+influxdb = InfluxDB::Client.new  # no host given defaults connecting to localhost
+```
+
+Connecting to multiple hosts (with built-in load balancing and failover):
+
+``` ruby
+require 'influxdb'
+
+influxdb = InfluxDB::Client.new hosts: ["influxdb1.domain.com", "influxdb2.domain.com"]
+```
+
+Create a database:
+
+``` ruby
+database = 'site_development'
+
+influxdb.create_database(database)
+```
+
+Delete a database:
+
+``` ruby
+database = 'site_development'
+
+influxdb.delete_database(database)
+```
+
+List databases:
+
+``` ruby
+influxdb.list_databases
+```
+
+Create a user for a database:
+
+``` ruby
+database = 'site_development'
+new_username = 'foo'
+new_password = 'bar'
+permission = :write
+
+# with all permissions
+influxdb.create_database_user(database, new_username, new_password)
+
+# with specified permission - options are: :read, :write, :all
+influxdb.create_database_user(database, new_username, new_password, permissions: permission)
+```
+
+Update a user password:
+
+``` ruby
+username = 'foo'
+new_password = 'bar'
+
+influxdb.update_user_password(username, new_password)
+```
+
+Grant user privileges on database:
+
+``` ruby
+username = 'foobar'
+database = 'foo'
+permission = :read # options are :read, :write, :all
+
+influxdb.grant_user_privileges(username, database, permission)
+```
+
+Revoke user privileges from database:
+
+``` ruby
+username = 'foobar'
+database = 'foo'
+permission = :write # options are :read, :write, :all
+
+influxdb.revoke_user_privileges(username, database, permission)
+```
+Delete a user:
+
+``` ruby
+username = 'foobar'
+
+influxdb.delete_user(username)
+```
+
+List users:
+
+``` ruby
+influxdb.list_users
+```
+
+Create cluster admin:
+
+``` ruby
+username = 'foobar'
+password = 'pwd'
+
+influxdb.create_cluster_admin(username, password)
+```
+
+List cluster admins:
+
+``` ruby
+influxdb.list_cluster_admins
+```
+
+Revoke cluster admin privileges from user:
+
+``` ruby
+username = 'foobar'
+
+influxdb.revoke_cluster_admin_privileges(username)
+```
+
+List continuous queries of a database:
+
+``` ruby
+database = 'foo'
+
+influxdb.continuous_queries(database)
+```
+
+Write some data:
+
+``` ruby
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+name     = 'foobar'
+
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password
+
+# Enumerator that emits a sine wave
+Value = (0..360).to_a.map {|i| Math.send(:sin, i / 10.0) * 10 }.each
+
+loop do
+  data = {
+    values: { value: Value.next },
+    tags: { wave: 'sine' } # tags are optional
+  }
+
+  influxdb.write_point(name, data)
+
+  sleep 1
+end
+```
+
+Write data with time precision (precision can be set in 2 ways):
+
+``` ruby
+require 'influxdb'
+
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+name     = 'foobar'
+time_precision = 's'
+
+# either in the client initialization:
+influxdb = InfluxDB::Client.new database, username: username,
+                                          password: password,
+                                          time_precision: time_precision
+
+data = {
+  values: { value: 0 },
+  timestamp: Time.now.to_i # timestamp is optional, if not provided point will be saved with current time
+}
+
+influxdb.write_point(name, data)
+
+# or in a method call:
+influxdb.write_point(name, data, time_precision)
+
+```
+
+Write multiple points in a batch (performance boost):
+
+``` ruby
+
+data = [
+  {
+    series: 'cpu',
+    tags: { host: 'server_1', regios: 'us' },
+    values: {internal: 5, external: 0.453345}
+  },
+  {
+    series: 'gpu',
+    values: {value: 0.9999},
+  }
+]
+
+influxdb.write_points(data)
+
+# you can also specify precision in method call
+
+precision = 'm'
+influxdb.write_points(data, precision)
+
+```
+
+Write asynchronously:
+
+``` ruby
+require 'influxdb'
+
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+name     = 'foobar'
+time_precision = 's'
+
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password,
+                                async: true
+
+data = {
+  values: { value: 0 },
+  tags: { foo: 'bar', bar: 'baz' }
+  timestamp: Time.now.to_i
+}
+
+influxdb.write_point(name, data)
+```
+
+Write data via UDP:
+
+``` ruby
+require 'influxdb'
+host = '127.0.0.1'
+port = 4444
+
+influxdb = InfluxDB::Client.new udp: { host: host, port: port }
+
+name = 'hitchhiker'
+
+data = {
+  values: { value: 666 },
+  tags: { foo: 'bar', bar: 'baz' }
+}
+
+influxdb.write_point(name, data)
+```
+
+Querying:
+
+``` ruby
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password
+
+# without a block:
+influxdb.query 'select * from time_series_1' # results are grouped by name, but also their tags
+
+# result:
+[{"name"=>"time_series_1", "tags"=>{"region"=>"uk"}, "values"=>[{"time"=>"2015-07-09T09:03:31Z", "count"=>32, "value"=>0.9673}, {"time"=>"2015-07-09T09:03:49Z", "count"=>122, "value"=>0.4444}]},
+ {"name"=>"time_series_1", "tags"=>{"region"=>"us"}, "values"=>[{"time"=>"2015-07-09T09:02:54Z", "count"=>55, "value"=>0.4343}]}]
+
+# with a block:
+influxdb.query 'select * from time_series_1' do |name, tags, points|
+  puts "#{name} [ #{tags} ] => #{points}"
+end
+
+# result:
+# time_series_1 [ {"region"=>"uk"} ] => [{"time"=>"2015-07-09T09:03:31Z", "count"=>32, "value"=>0.9673}, {"time"=>"2015-07-09T09:03:49Z", "count"=>122, "value"=>0.4444}]
+# time_series_1 [ {"region"=>"us"} ] => [{"time"=>"2015-07-09T09:02:54Z", "count"=>55, "value"=>0.4343}]
+```
+
+By default, InfluxDB::Client will denormalize points (received from InfluxDB as columns and rows), if you want to get _raw_ data add `denormalize: false` to initialization options or to query itself:
+
+``` ruby
+influxdb.query 'select * from time_series_1', denormalize: false
+
+# result
+[{"name"=>"time_series_1", "tags"=>{"region"=>"uk"}, "columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:03:31Z", 32, 0.9673], ["2015-07-09T09:03:49Z", 122, 0.4444]]},
+ {"name"=>"time_series_1", "tags"=>{"region"=>"us"}, "columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:02:54Z", 55, 0.4343]]}]
+
+
+influxdb.query 'select * from time_series_1', denormalize: false do |name, tags, points|
+  puts "#{name} [ #{tags} ] => #{points}"
+end
+
+# result:
+# time_series_1 [ {"region"=>"uk"} ] => {"columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:03:31Z", 32, 0.9673], ["2015-07-09T09:03:49Z", 122, 0.4444]]}
+# time_series_1 [ {"region"=>"us"} ] => {"columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:02:54Z", 55, 0.4343]]}
+```
+
+By default, InfluxDB::Client will keep trying to connect to the database when it gets connection denied, if you want to retry a finite number of times
+(or disable retries altogether), you should pass the `:retry`
+value. `:retry` can be either `true`, `false` or an `Integer` to retry
+infinite times, disable retries or retry a finite number of times,
+respectively. `0` is equivalent to `false`
+
+```
+> require 'influxdb'
+=> true
+
+> influxdb = InfluxDB::Client.new 'database', :retry => 4
+=> #<InfluxDB::Client:0x00000002bb5ce0 @database="database", @hosts=["localhost"],
+@port=8086, @username="root", @password="root", @use_ssl=false,
+@time_precision="s", @initial_delay=0.01, @max_delay=30,
+@open_timeout=5, @read_timeout=300, @async=false, @retry=4>
+
+> influxdb.query 'select * from serie limit 1'
+E, [2014-06-02T11:04:13.416209 #22825] ERROR -- : [InfluxDB] Failed to
+contact host localhost: #<SocketError: getaddrinfo: Name or service not known> -
+retrying in 0.01s.
+E, [2014-06-02T11:04:13.433646 #22825] ERROR -- : [InfluxDB] Failed to
+contact host localhost: #<SocketError: getaddrinfo: Name or service not known> -
+retrying in 0.02s.
+E, [2014-06-02T11:04:13.462566 #22825] ERROR -- : [InfluxDB] Failed to
+contact host localhost: #<SocketError: getaddrinfo: Name or service not known> -
+retrying in 0.04s.
+E, [2014-06-02T11:04:13.510853 #22825] ERROR -- : [InfluxDB] Failed to
+contact host localhost: #<SocketError: getaddrinfo: Name or service not known> -
+retrying in 0.08s.
+SocketError: Tried 4 times to reconnect but failed.
+
+```
+If you pass `:retry => -1` it will keep trying forever
+until it gets the connection.
+
+Testing
+-------
+
+```
+git clone git@github.com:influxdb/influxdb-ruby.git
+cd influxdb-ruby
+bundle
+bundle exec rake
+```