influxdb 0.6.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7762707820de5633483a02078dd8d6254fbda6bd412fbf56c67e8517bd51684
-  data.tar.gz: 3ba80a79c409b7768a65616cf2f6b1e7a6097c862799a56cf5a9bc419a5c49e5
+  metadata.gz: 4526b81c8b4e67ca797482a71d10df463feb3c2a6b2750f6038ab6a12d8b6723
+  data.tar.gz: b55ad197088776641d54822d6cada8b57428ddbd00e3441e46ffa841b27a24d6
 SHA512:
-  metadata.gz: 76cf43822faa5426b10160f7bb40cbd48af59a4cd1bfd494cd7978a82484b984e35440e3f714491884f78e6d497163567c162e66164c602bb7eeefe84c7b86a9
-  data.tar.gz: 742e37b48e925a5e0985570cc502a976c41f9059258d6347a9a132d8a4ef452d070f344aa20e4880a1b0bd800a887220816c9c370f2a176a04855a18dc865b98
+  metadata.gz: e18c2cc024f308f89066f552826a2072904071ca3df33bc47cb4b4476712a9d3d744055667a21791d4eb1b3d521c2de7ba6b1c99d3491e4953287cee332a1b39
+  data.tar.gz: af2a5856340cd70147f95917784ae700e7ea68e53d9de38c115c4e8c4552f74cdb5dcdadb278aa569c4f6b367b3a10c56a9e54ab27ac808252617cd22adf6717

data/.github/workflows/tests.yml

@@ -0,0 +1,92 @@
+name: Tests
+
+# workflow_dispatch enables running workflow manually
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-20.04]
+        ruby: [2.7]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake rubocop
+
+  specs:
+    name: ${{ matrix.os }} ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-16.04
+          - ubuntu-18.04
+          - ubuntu-20.04
+        ruby:
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          # YAML gotcha: https://github.com/actions/runner/issues/849
+          - '3.0'
+          - head
+        include:
+          - os: ubuntu-20.04
+            ruby: jruby-9.1
+            jruby_opts: '--client -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-Xss2m -J-Xmx256M'
+            allow-failure: true
+          - os: ubuntu-20.04
+            ruby: jruby-9.2
+            jruby_opts: '--client -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-Xss2m -J-Xmx256M'
+            allow-failure: true
+          - os: ubuntu-20.04
+            ruby: jruby-head
+            jruby_opts: '--client -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-Xss2m -J-Xmx256M'
+            allow-failure: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake
+        continue-on-error: ${{ matrix.allow-failure || false }}
+
+  smoketests:
+    name: smoketest with influx ${{ matrix.influx_version }}
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: 2.7, influx_version: 1.0.2, pkghash: 88f6c30fec2c6e612e802e23b9161fdfc7c5c29f6be036f0376326445aff0037 }
+          - { ruby: 2.7, influx_version: 1.1.5, pkghash: 0ecb9385cc008f6e5094e6e8f8ea70522023a16d4397e401898f3973176d3b21 }
+          - { ruby: 2.7, influx_version: 1.2.4, pkghash: 2fac8391e04aa1bec9151e8f0d8f18df030c866af2b4963ab7d86c6ddc172182 }
+          - { ruby: 2.7, influx_version: 1.3.8, pkghash: 35c9cb2943bbde04aa5e94ad6d8caf5fc9b1480bdbcde7c34078de135cc4f788 }
+          - { ruby: 2.7, influx_version: 1.4.3, pkghash: 0477080f1d1cf8e1242dc7318280b9010c4c45cf6a415a2a5de607ae17fa0359 }
+          - { ruby: 2.7, influx_version: 1.5.4, pkghash: fa6f8d3196d13ffc376d533581b534692c738181ce3427c53484c138d9e6b902 }
+          - { ruby: 2.7, influx_version: 1.6.4, pkghash: dbfa13a0f9e38a8e7b19294c30144903bb681ac0aba0a3a8f4f349c37d5de5f9 }
+          - { ruby: 2.7, influx_version: 1.7.9, pkghash: 02759d70cef670d336768fd38a9cf2f046a1bf40618be78ba215e7ce75b5075f }
+          - { ruby: 2.7, influx_version: nightly, channel: nightlies, allow-failure: true }
+    env:
+      influx_version: ${{ matrix.influx_version }}
+      pkghash: ${{ matrix.pkghash }}
+      channel: ${{ matrix.channel }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bin/provision.sh
+      - run: bundle exec rake spec
+        continue-on-error: ${{ matrix.allow-failure || false }}

data/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   Include:
   - 'Rakefile'

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 For the full commit log, [see here](https://github.com/influxdata/influxdb-ruby/commits/master).
 
+## v0.8.1, release 2021-02-17
+
+- Ensure workers can send data popped off the queue at shutdown (#239,
+  @onlynone)
+- Add support for special characters in password when using url keyword (#242,
+  @swistak35)
+- Add Ruby 3.0 support (#249, @dentarg, @paul and @track8)
+- Support characters that need quoting for usernames and database names (#248, @estheruary)
+
+## v0.8.0, released 2020-02-05
+
+- Allow dropping of specific series from specific DBs (#233, @cantino)
+- Add support for MRI 2.7 (#235, @jeffkowalski)
+- Raise a LineProtocolError if attempting to write empty values as field
+  set is required. This adds descriptive feedback to the error "unable to
+  parse '{series},{tags} ': invalid field format" (#236, @todtb)
+- Add support for configuring HTTP Proxy (#238, @epchris)
+
+## v0.7.0, released 2019-01-11
+
+- Drop support for Ruby 2.2, since Bundler dropped it and we want to use
+  Bundler in the development cycle as well.
+- Fix issue with tag values ending in a backslash.
+
+## v0.6.4, releases 2018-12-02
+
+- Fix newly introduced `InfluxDB.now(precision)` for precisions larger
+  than "s".
+
+## v0.6.3, released 2018-11-30
+
+- Added `InfluxDB.now(precision)` and `InfluxDB::Client#now` as companions
+  to `InfluxDB.convert_timestamp`.
+
 ## v0.6.2, released 2018-11-30
 
 - Added `InfluxDB.convert_timestamp` utility to convert a `Time` to a

data/README.md

@@ -1,11 +1,13 @@
 # influxdb-ruby
 
 [![Gem Version](https://badge.fury.io/rb/influxdb.svg)](https://badge.fury.io/rb/influxdb)
-[![Build Status](https://travis-ci.org/influxdata/influxdb-ruby.svg?branch=master)](https://travis-ci.org/influxdata/influxdb-ruby)
+[![Build Status](https://github.com/influxdata/influxdb-ruby/workflows/Tests/badge.svg)](https://github.com/influxdata/influxdb-ruby/actions)
 
 The official Ruby client library for [InfluxDB](https://influxdata.com/time-series-platform/influxdb/).
 Maintained by [@toddboom](https://github.com/toddboom) and [@dmke](https://github.com/dmke).
 
+#### Note: This library is for use with InfluxDB 1.x. For connecting to InfluxDB 2.x instances, please use the [influxdb-client-ruby](https://github.com/influxdata/influxdb-client-ruby) client.
+
 ## Contents
 
 - [Platform support](#platform-support)
@@ -14,7 +16,7 @@ Maintained by [@toddboom](https://github.com/toddboom) and [@dmke](https://githu
 - [Usage](#usage)
   - [Creating a client](#creating-a-client)
   - [Writing data](#writing-data)
-    - [A Note About Time Precision](#a-note-about-time-precision)
+  - [A Note About Time Precision](#a-note-about-time-precision)
   - [Querying](#querying)
 - [Advanced Topics](#advanced-topics)
   - [Administrative tasks](#administrative-tasks)
@@ -39,8 +41,10 @@ Maintained by [@toddboom](https://github.com/toddboom) and [@dmke](https://githu
 
 ## Ruby support
 
-Since v0.4.0, this gem requires Ruby >= 2.2.0. Support for MRI < 2.2 is
-still available in the v0.3.x series, see [stable-03 branch](https://github.com/influxdata/influxdb-ruby/tree/stable-03)
+Since v0.7.0, this gem requires Ruby >= 2.3.0. MRI 2.2 *should* still work,
+however we are unable to test this properly, since our toolchain (Bundler)
+has dropped support for it. Support for MRI < 2.2 is still available in the
+v0.3.x series, see [stable-03 branch](https://github.com/influxdata/influxdb-ruby/tree/stable-03)
 for documentation.
 
 ## Installation
@@ -92,6 +96,21 @@ url = "https://influxdb.example.com:8086/database_name?open_timeout=3"
 influxdb = InfluxDB::Client.new url: url, open_timeout: 10
 ```
 
+#### Using a custom HTTP Proxy
+
+By default, the `Net::HTTP` proxy behavior is used (see [Net::HTTP Proxy][proxy])
+You can optionally set a proxy address and port via the `proxy_addr` and
+`proxy_port` options:
+
+``` ruby
+influxdb = InfluxDB::Client.new database,
+  host:       "influxdb.domain.com",
+  proxy_addr: "your.proxy.addr",
+  proxy_port: 8080
+```
+
+[proxy]: https://docs.ruby-lang.org/en/2.7.0/Net/HTTP.html#class-Net::HTTP-label-Proxies
+
 ### Writing data
 
 Write some data:
@@ -145,34 +164,8 @@ influxdb.write_point(name, data)
 influxdb.write_point(name, data, time_precision)
 ```
 
-### A Note About Time Precision
-
-The default precision in this gem is `"s"` (second), as Ruby's `Time#to_i`
-operates on this resolution.
-
-If you write data points with sub-second resolution, you _have_ to configure
-your client instance with a more granular `time_precision` option **and** you
-need to provide timestamp values which reflect this precision. **If you don't do
-this, your points will be squashed!**
-
-> A point is uniquely identified by the measurement name, tag set, and
-> timestamp. If you submit a new point with the same measurement, tag set, and
-> timestamp as an existing point, the field set becomes the union of the old
-> field set and the new field set, where any ties go to the new field set. This
-> is the intended behavior.
-
-See [How does InfluxDB handle duplicate points?][docs-faq] for details.
-
-For example, this is how to specify millisecond precision (which moves the
-pitfall from the second- to the millisecond barrier):
-
-```ruby
-influxdb = InfluxDB::Client.new(time_precision: "ms")
-time = (Time.now.to_r * 1000).to_i
-# A faster, albeit less readable alternative:
-# time = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
-influxdb.write_point("foobar", { values: { n: 42 }, timestamp: time })
-```
+> **Attention:** Please also read the
+> [note about time precision](#a-note-about-time-precision) below.
 
 Allowed values for `time_precision` are:
 
@@ -219,7 +212,7 @@ influxdb = InfluxDB::Client.new {
 
 data = {
   values:    { value: 0 },
-  tags:      { foo: 'bar', bar: 'baz' }
+  tags:      { foo: 'bar', bar: 'baz' },
   timestamp: Time.now.to_i
 }
 
@@ -304,7 +297,10 @@ async_options = {
   # checking if there are new jobs in the queue
   sleep_interval:      5,
   # whether client will block if queue is full
-  block_on_full_queue: false
+  block_on_full_queue: false,
+  # Max time (in seconds) the main thread will wait for worker threads to stop
+  # on shutdown. Defaults to 2x sleep_interval.
+  shutdown_timeout: 10
 }
 
 influxdb = InfluxDB::Client.new database, async: async_options
@@ -337,6 +333,56 @@ influxdb = InfluxDB::Client.new(
 influxdb.write_point('hitchhiker', { values: { value: 666 } })
 ```
 
+### A Note About Time Precision
+
+The default precision in this gem is `"s"` (second), as Ruby's `Time#to_i`
+operates on this resolution.
+
+If you write data points with sub-second resolution, you _have_ to configure
+your client instance with a more granular `time_precision` option **and** you
+need to provide timestamp values which reflect this precision. **If you don't do
+this, your points will be squashed!**
+
+> A point is uniquely identified by the measurement name, tag set, and
+> timestamp. If you submit a new point with the same measurement, tag set, and
+> timestamp as an existing point, the field set becomes the union of the old
+> field set and the new field set, where any ties go to the new field set. This
+> is the intended behavior.
+
+See [How does InfluxDB handle duplicate points?][docs-faq] for details.
+
+For example, this is how to specify millisecond precision (which moves the
+pitfall from the second- to the millisecond barrier):
+
+```ruby
+client = InfluxDB::Client.new(time_precision: "ms")
+time = (Time.now.to_r * 1000).to_i
+client.write_point("foobar", { values: { n: 42 }, timestamp: time })
+```
+
+For convenience, InfluxDB provides a few helper methods:
+
+```ruby
+# to get a timestamp with the precision configured in the client:
+client.now
+
+# to get a timestamp with the given precision:
+InfluxDB.now(time_precision)
+
+# to convert a Time into a timestamp with the given precision:
+InfluxDB.convert_timestamp(Time.now, time_precision)
+```
+
+As with `client.write_point`, allowed values for `time_precision` are:
+
+- `"ns"` or `nil` for nanosecond
+- `"u"` for microsecond
+- `"ms"` for millisecond
+- `"s"` for second
+- `"m"` for minute
+- `"h"` for hour
+
+[docs-faq]: http://docs.influxdata.com/influxdb/v1.7/troubleshooting/frequently-asked-questions/#how-does-influxdb-handle-duplicate-points
 
 ### Querying
 

data/Rakefile

@@ -14,7 +14,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = FileList[file_pattern]
 end
 
-if ENV.key?("TRAVIS")
+if ENV.key?("CI")
   task default: %i[spec]
 else
   task default: %i[spec rubocop]

data/bin/provision.sh

@@ -36,7 +36,7 @@ echo "-- Download has SHA256 hash: ${sha2_sum}"
 echo "== Installing"
 
 sudo dpkg -i "${HOME}/${package_name}"
-sudo /etc/init.d/influxdb start
+sudo service influxdb start || true
 
 echo "-- waiting for daemon to start"
 while ! curl --head --fail --silent http://localhost:8086/ping; do
@@ -63,7 +63,7 @@ echo "-- grant access"
 
 echo "== Download and import NOAA sample data"
 
-curl https://s3-us-west-1.amazonaws.com/noaa.water.database.0.9/NOAA_data.txt > noaa.txt
+curl https://s3.amazonaws.com/noaa.water-database/NOAA_data.txt > noaa.txt
 /usr/bin/influx -import -path noaa.txt -precision s
 
 echo "-- grant access"
@@ -78,7 +78,7 @@ if [ ! -f /etc/influxdb/influxdb.conf ]; then
 fi
 
 sudo sed -i 's/auth-enabled = false/auth-enabled = true/' /etc/influxdb/influxdb.conf
-sudo /etc/init.d/influxdb restart
+sudo service influxdb restart || true
 
 echo "-- waiting for daemon to restart"
 while ! curl --head --fail --silent http://localhost:8086/ping; do

data/influxdb.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 0.60.0"
+  spec.add_development_dependency "rubocop", "~> 0.61.1"
   spec.add_development_dependency "webmock", "~> 3.0"
 end

data/lib/influxdb/client.rb

@@ -48,10 +48,10 @@ module InfluxDB
     # +:verify_ssl+:: verify ssl server certificate?
     # +:ssl_ca_cert+:: ssl CA certificate, chainfile or CA path.
     #                  The system CA path is automatically included
-    # +:retry:: number of times a failed request should be retried. Defaults to infinite.
+    # +:retry+:: number of times a failed request should be retried. Defaults to infinite.
     def initialize(database = nil, **opts)
       opts[:database] = database if database.is_a? String
-      @config = InfluxDB::Config.new(opts)
+      @config = InfluxDB::Config.new(**opts)
       @stopped = false
       @writer = find_writer
 
@@ -59,17 +59,23 @@ module InfluxDB
     end
 
     def stop!
-      if config.async?
-        # If retry was infinite (-1), set it to zero to give the main thread one
-        # last chance to flush the queue
-        config.retry = 0 if config.retry < 0
-        writer.worker.stop!
+      if @writer == self
+        @stopped = true
+      else
+        @writer.stop!
       end
-      @stopped = true
     end
 
     def stopped?
-      @stopped
+      if @writer == self
+        @stopped
+      else
+        @writer.stopped?
+      end
+    end
+
+    def now
+      InfluxDB.now(config.time_precision)
     end
 
     private

data/lib/influxdb/client/http.rb

@@ -45,7 +45,7 @@ module InfluxDB
       retry_count = 0
 
       begin
-        http = Net::HTTP.new(host, config.port)
+        http = build_http(host, config.port)
         http.open_timeout = config.open_timeout
         http.read_timeout = config.read_timeout
 
@@ -133,6 +133,16 @@ module InfluxDB
       end
       store
     end
+
+    # Builds an http instance, taking into account any configured
+    # proxy configuration
+    def build_http(host, port)
+      if config.proxy_addr
+        Net::HTTP.new(host, port, config.proxy_addr, config.proxy_port)
+      else
+        Net::HTTP.new(host, port)
+      end
+    end
   end
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize