influxdb 0.6.2 → 0.8.1

data/lib/influxdb/config.rb

@@ -16,6 +16,8 @@ module InfluxDB
     open_timeout:         5,
     read_timeout:         300,
     auth_method:          nil,
+    proxy_addr:           nil,
+    proxy_port:           nil,
 
     # SSL options
     use_ssl:              false,
@@ -144,11 +146,11 @@ module InfluxDB
 
     def opts_from_non_params(url)
       {}.tap do |o|
-        o[:host]     = url.host        if url.host
-        o[:port]     = url.port        if url.port
-        o[:username] = url.user        if url.user
-        o[:password] = url.password    if url.password
-        o[:database] = url.path[1..-1] if url.path.length > 1
+        o[:host]     = url.host                                    if url.host
+        o[:port]     = url.port                                    if url.port
+        o[:username] = URI.decode_www_form_component(url.user)     if url.user
+        o[:password] = URI.decode_www_form_component(url.password) if url.password
+        o[:database] = url.path[1..-1]                             if url.path.length > 1
         o[:use_ssl]  = url.scheme == "https".freeze
 
         o[:udp] = { host: o[:host], port: o[:port] } if url.scheme == "udp"

data/lib/influxdb/errors.rb

@@ -5,6 +5,7 @@ module InfluxDB # :nodoc:
   Error               = Class.new StandardError
   AuthenticationError = Class.new Error
   ConnectionError     = Class.new Error
+  LineProtocolError   = Class.new Error
   SeriesNotFound      = Class.new Error
   JSONParserError     = Class.new Error
   QueryError          = Class.new Error

data/lib/influxdb/point_value.rb

@@ -13,6 +13,7 @@ module InfluxDB
     def dump
       dump =  @series.dup
       dump << ",#{@tags}" if @tags
+      dump << " ".freeze if dump[-1] == "\\"
       dump << " #{@values}"
       dump << " #{@timestamp}" if @timestamp
       dump
@@ -45,7 +46,9 @@ module InfluxDB
     end
 
     def escape_values(values)
-      return if values.nil?
+      if values.nil? || values.empty?
+        raise InfluxDB::LineProtocolError, "Cannot create point with empty values".freeze
+      end
 
       values.map do |k, v|
         key = escape(k.to_s, :field_key)

data/lib/influxdb/query/batch.rb

@@ -27,7 +27,7 @@ module InfluxDB
       )
         return [] if statements.empty?
 
-        url = full_url "/query".freeze, query_params(statements.join(";"), opts)
+        url = full_url "/query".freeze, **query_params(statements.join(";"), **opts)
         series = fetch_series get(url, parse: true, json_streaming: !chunk_size.nil?)
 
         if denormalize
@@ -82,8 +82,14 @@ module InfluxDB
         denormalize_series
         denormalized_series_list
       ].each do |method_name|
-        define_method(method_name) do |*args|
-          client.send method_name, *args
+        if RUBY_VERSION < "2.7"
+          define_method(method_name) do |*args|
+            client.send method_name, *args
+          end
+        else
+          define_method(method_name) do |*args, **kwargs|
+            client.send method_name, *args, **kwargs
+          end
         end
       end
     end

data/lib/influxdb/query/cluster.rb

@@ -2,7 +2,7 @@ module InfluxDB
   module Query
     module Cluster # :nodoc:
       def create_cluster_admin(username, password)
-        execute("CREATE USER #{username} WITH PASSWORD '#{password}' WITH ALL PRIVILEGES")
+        execute("CREATE USER \"#{username}\" WITH PASSWORD '#{password}' WITH ALL PRIVILEGES")
       end
 
       def list_cluster_admins
@@ -10,7 +10,7 @@ module InfluxDB
       end
 
       def revoke_cluster_admin_privileges(username)
-        execute("REVOKE ALL PRIVILEGES FROM #{username}")
+        execute("REVOKE ALL PRIVILEGES FROM \"#{username}\"")
       end
     end
   end

data/lib/influxdb/query/continuous_query.rb

@@ -24,7 +24,7 @@ module InfluxDB
       end
 
       def delete_continuous_query(name, database)
-        execute("DROP CONTINUOUS QUERY #{name} ON #{database}")
+        execute("DROP CONTINUOUS QUERY \"#{name}\" ON \"#{database}\"")
       end
     end
   end

data/lib/influxdb/query/core.rb

@@ -26,7 +26,7 @@ module InfluxDB
       )
         query = builder.build(query, params)
 
-        url = full_url("/query".freeze, query_params(query, opts))
+        url = full_url("/query".freeze, **query_params(query, **opts))
         series = fetch_series(get(url, parse: true, json_streaming: !chunk_size.nil?))
 
         if block_given?
@@ -79,7 +79,7 @@ module InfluxDB
         }
 
         params[:rp] = retention_policy if retention_policy
-        url = full_url("/write", params)
+        url = full_url("/write", **params)
         post(url, data)
       end
 
@@ -121,15 +121,19 @@ module InfluxDB
       end
 
       def generate_payload(data)
-        data.map do |point|
-          InfluxDB::PointValue.new(point).dump
-        end.join("\n".freeze)
+        data.map { |point| generate_point(point) }.join("\n".freeze)
+      end
+
+      def generate_point(point)
+        InfluxDB::PointValue.new(point).dump
+      rescue InfluxDB::LineProtocolError => e
+        (log :error, "Cannot write data: #{e.inspect}") && nil
       end
 
       def execute(query, db: nil, **options)
         params = { q: query }
         params[:db] = db if db
-        url = full_url("/query".freeze, params)
+        url = full_url("/query".freeze, **params)
         get(url, options)
       end
 
@@ -143,7 +147,7 @@ module InfluxDB
         series.select { |k, _| %w[columns values].include?(k) }
       end
 
-      def full_url(path, params = {})
+      def full_url(path, **params)
         if config.auth_method == "params".freeze
           params[:u] = config.username
           params[:p] = config.password

data/lib/influxdb/query/database.rb

@@ -2,11 +2,11 @@ module InfluxDB
   module Query
     module Database # :nodoc:
       def create_database(name = nil)
-        execute("CREATE DATABASE #{name || config.database}")
+        execute("CREATE DATABASE \"#{name || config.database}\"")
       end
 
       def delete_database(name = nil)
-        execute("DROP DATABASE #{name || config.database}")
+        execute("DROP DATABASE \"#{name || config.database}\"")
       end
 
       def list_databases

data/lib/influxdb/query/series.rb

@@ -1,8 +1,12 @@
 module InfluxDB
   module Query
     module Series # :nodoc:
-      def delete_series(name)
-        execute("DROP SERIES FROM #{name}", db: config.database)
+      def delete_series(name, where: nil, db: config.database)
+        if where
+          execute("DROP SERIES FROM \"#{name}\" WHERE #{where}", db: db)
+        else
+          execute("DROP SERIES FROM \"#{name}\"", db: db)
+        end
       end
 
       def list_series

data/lib/influxdb/query/user.rb

@@ -6,36 +6,36 @@ module InfluxDB
       def create_database_user(database, username, password, options = {})
         permissions = options.fetch(:permissions, :all)
         execute(
-          "CREATE user #{username} WITH PASSWORD '#{password}'; "\
-          "GRANT #{permissions.to_s.upcase} ON #{database} TO #{username}"
+          "CREATE user \"#{username}\" WITH PASSWORD '#{password}'; "\
+          "GRANT #{permissions.to_s.upcase} ON \"#{database}\" TO \"#{username}\""
         )
       end
 
       def update_user_password(username, password)
-        execute("SET PASSWORD FOR #{username} = '#{password}'")
+        execute("SET PASSWORD FOR \"#{username}\" = '#{password}'")
       end
 
       # permission => [:all]
       def grant_user_admin_privileges(username)
-        execute("GRANT ALL PRIVILEGES TO #{username}")
+        execute("GRANT ALL PRIVILEGES TO \"#{username}\"")
       end
 
       # permission => [:read|:write|:all]
       def grant_user_privileges(username, database, permission)
-        execute("GRANT #{permission.to_s.upcase} ON #{database} TO #{username}")
+        execute("GRANT #{permission.to_s.upcase} ON \"#{database}\" TO \"#{username}\"")
       end
 
       def list_user_grants(username)
-        execute("SHOW GRANTS FOR #{username}")
+        execute("SHOW GRANTS FOR \"#{username}\"")
       end
 
       # permission => [:read|:write|:all]
       def revoke_user_privileges(username, database, permission)
-        execute("REVOKE #{permission.to_s.upcase} ON #{database} FROM #{username}")
+        execute("REVOKE #{permission.to_s.upcase} ON \"#{database}\" FROM \"#{username}\"")
       end
 
       def delete_user(username)
-        execute("DROP USER #{username}")
+        execute("DROP USER \"#{username}\"")
       end
 
       # => [{"username"=>"usr", "admin"=>true}, {"username"=>"justauser", "admin"=>false}]

data/lib/influxdb/timestamp_conversion.rb

@@ -1,5 +1,45 @@
 module InfluxDB #:nodoc:
-  TIMESTAMP_CONVERSIONS = {
+  # Converts a Time to a timestamp with the given precision.
+  #
+  # === Example
+  #
+  #  InfluxDB.convert_timestamp(Time.now, "ms")
+  #  #=> 1543533308243
+  def self.convert_timestamp(time, precision = "s")
+    factor = TIME_PRECISION_FACTORS.fetch(precision) do
+      raise ArgumentError, "invalid time precision: #{precision}"
+    end
+
+    (time.to_r * factor).to_i
+  end
+
+  # Returns the current timestamp with the given precision.
+  #
+  # Implementation detail: This does not create an intermediate Time
+  # object with `Time.now`, but directly requests the CLOCK_REALTIME,
+  # which in general is a bit faster.
+  #
+  # This is useful, if you want or need to shave off a few microseconds
+  # from your measurement.
+  #
+  # === Examples
+  #
+  #  InfluxDB.now("ns")   #=> 1543612126401392625
+  #  InfluxDB.now("u")    #=> 1543612126401392
+  #  InfluxDB.now("ms")   #=> 1543612126401
+  #  InfluxDB.now("s")    #=> 1543612126
+  #  InfluxDB.now("m")    #=> 25726868
+  #  InfluxDB.now("h")    #=> 428781
+  def self.now(precision = "s")
+    name, divisor = CLOCK_NAMES.fetch(precision) do
+      raise ArgumentError, "invalid time precision: #{precision}"
+    end
+
+    time = Process.clock_gettime Process::CLOCK_REALTIME, name
+    (time / divisor).to_i
+  end
+
+  TIME_PRECISION_FACTORS = {
     "ns" => 1e9.to_r,
     nil  => 1e9.to_r,
     "u"  => 1e6.to_r,
@@ -8,16 +48,16 @@ module InfluxDB #:nodoc:
     "m"  => 1.to_r / 60,
     "h"  => 1.to_r / 60 / 60,
   }.freeze
-  private_constant :TIMESTAMP_CONVERSIONS
+  private_constant :TIME_PRECISION_FACTORS
 
-  # Converts a Time to a timestamp with the given precision.
-  #
-  # `convert_timestamp(Time.now, "ms")` might return `1543533308243`.
-  def self.convert_timestamp(time, time_precision)
-    factor = TIMESTAMP_CONVERSIONS.fetch(time_precision) do
-      raise "Invalid time precision: #{time_precision}"
-    end
-
-    (time.to_r * factor).to_i
-  end
+  CLOCK_NAMES = {
+    "ns" => [:nanosecond, 1],
+    nil  => [:nanosecond, 1],
+    "u"  => [:microsecond, 1],
+    "ms" => [:millisecond, 1],
+    "s"  => [:second, 1],
+    "m"  => [:second, 60.to_r],
+    "h"  => [:second, (60 * 60).to_r],
+  }.freeze
+  private_constant :CLOCK_NAMES
 end

data/lib/influxdb/version.rb

@@ -1,3 +1,3 @@
 module InfluxDB # :nodoc:
-  VERSION = "0.6.2".freeze
+  VERSION = "0.8.1".freeze
 end

data/lib/influxdb/writer/async.rb

@@ -9,6 +9,16 @@ module InfluxDB
       def initialize(client, config)
         @client = client
         @config = config
+        @stopped = false
+      end
+
+      def stopped?
+        @stopped
+      end
+
+      def stop!
+        worker.stop!
+        @stopped = true
       end
 
       def write(data, precision = nil, retention_policy = nil, database = nil)
@@ -29,7 +39,7 @@ module InfluxDB
         end
       end
 
-      class Worker
+      class Worker # rubocop:disable Metrics/ClassLength
         attr_reader :client,
                     :queue,
                     :threads,
@@ -37,7 +47,8 @@ module InfluxDB
                     :max_queue_size,
                     :num_worker_threads,
                     :sleep_interval,
-                    :block_on_full_queue
+                    :block_on_full_queue,
+                    :shutdown_timeout
 
         include InfluxDB::Logging
 
@@ -47,7 +58,7 @@ module InfluxDB
         SLEEP_INTERVAL      = 5
         BLOCK_ON_FULL_QUEUE = false
 
-        def initialize(client, config)
+        def initialize(client, config) # rubocop:disable Metrics/MethodLength
           @client = client
           config = config.is_a?(Hash) ? config : {}
 
@@ -56,10 +67,11 @@ module InfluxDB
           @num_worker_threads  = config.fetch(:num_worker_threads,  NUM_WORKER_THREADS)
           @sleep_interval      = config.fetch(:sleep_interval,      SLEEP_INTERVAL)
           @block_on_full_queue = config.fetch(:block_on_full_queue, BLOCK_ON_FULL_QUEUE)
+          @shutdown_timeout    = config.fetch(:shutdown_timeout,    2 * @sleep_interval)
 
           queue_class = @block_on_full_queue ? SizedQueue : InfluxDB::MaxQueue
           @queue = queue_class.new max_queue_size
-
+          @should_stop = false
           spawn_threads!
         end
 
@@ -68,11 +80,11 @@ module InfluxDB
         end
 
         def current_threads
-          Thread.list.select { |t| t[:influxdb] == object_id }
+          @threads
         end
 
         def current_thread_count
-          Thread.list.count { |t| t[:influxdb] == object_id }
+          @threads.count
         end
 
         # rubocop:disable Metrics/CyclomaticComplexity
@@ -87,7 +99,7 @@ module InfluxDB
             @threads << Thread.new do
               Thread.current[:influxdb] = object_id
 
-              until client.stopped?
+              until @should_stop
                 check_background_queue(thread_num)
                 sleep rand(sleep_interval)
               end
@@ -97,7 +109,7 @@ module InfluxDB
           end
         end
 
-        def check_background_queue(thread_num = 0)
+        def check_background_queue(thread_num = -1)
           log(:debug) do
             "Checking background queue on thread #{thread_num} (#{current_thread_count} active)"
           end
@@ -123,10 +135,10 @@ module InfluxDB
             return if data.values.flatten.empty?
 
             begin
-              log(:debug) { "Found data in the queue! (#{sizes(data)})" }
+              log(:debug) { "Found data in the queue! (#{sizes(data)}) on thread #{thread_num}" }
               write(data)
             rescue StandardError => e
-              log :error, "Cannot write data: #{e.inspect}"
+              log :error, "Cannot write data: #{e.inspect} on thread #{thread_num}"
             end
 
             break if queue.length > max_post_points
@@ -138,7 +150,22 @@ module InfluxDB
         # rubocop:enable Metrics/AbcSize
 
         def stop!
-          log(:debug) { "Thread exiting, flushing queue." }
+          log(:debug) { "Worker is being stopped, flushing queue." }
+
+          # If retry was infinite (-1), set it to zero to give the threads one
+          # last chance to write their data
+          client.config.retry = 0 if client.config.retry < 0
+
+          # Signal the background threads that they should exit.
+          @should_stop = true
+
+          # Wait for the threads to exit and then kill them
+          @threads.each do |t|
+            r = t.join(shutdown_timeout)
+            t.kill if r.nil?
+          end
+
+          # Flush any remaining items in the queue on the main thread
           check_background_queue until queue.empty?
         end
 

data/lib/influxdb/writer/udp.rb

@@ -11,6 +11,9 @@ module InfluxDB
         @port = port
       end
 
+      # No-op for UDP writers
+      def stop!; end
+
       def write(payload, _precision = nil, _retention_policy = nil, _database = nil)
         with_socket { |sock| sock.send(payload, 0) }
       end