influxdb-client 1.1.0

data/lib/influxdb2/client/point.rb

@@ -0,0 +1,215 @@
+# The 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.
+
+module InfluxDB2
+  DEFAULT_WRITE_PRECISION = WritePrecision::NANOSECOND
+  ESCAPE_KEY_LIST = ['\\'.freeze, ','.freeze, ' '.freeze, '='.freeze].freeze
+  ESCAPE_VALUE_LIST = ['\\'.freeze, '"'.freeze].freeze
+
+  # Point defines the values that will be written to the database.
+  # Ref: http://bit.ly/influxdata-point
+  class Point
+    # Create DataPoint instance for specified measurement name.
+    #
+    # @example InfluxDB::Point.new(name: "h2o",
+    #   tags: {host: 'aws', region: 'us'},
+    #   fields: {level: 5, saturation: "99%"},
+    #   time: 123)
+    #
+    # @param [String] name the measurement name for the point.
+    # @param [Hash] tags the tag set for the point
+    # @param [Hash] fields the fields for the point
+    # @param [Integer] time the timestamp for the point
+    # @param [WritePrecision] precision the precision for the unix timestamps within the body line-protocol
+    def initialize(name:, tags: nil, fields: nil, time: nil, precision: DEFAULT_WRITE_PRECISION)
+      @name = name
+      @tags = tags || {}
+      @fields = fields || {}
+      @time = time
+      @precision = precision
+    end
+    attr_reader :precision
+
+    # Create DataPoint instance from specified data.
+    #
+    # @example Point.fromHash({
+    #   name: 'cpu',
+    #   tags: { host: 'server_nl', regios: 'us' },
+    #   fields: {internal: 5, external: 6},
+    #   time: 1422568543702900257
+    # })
+    #
+    # @param [Hash] data
+    def self.from_hash(data)
+      obj = new(name: data[:name], tags: data[:tags], fields: data[:fields], time: data[:time])
+      obj
+    end
+
+    # Adds or replaces a tag value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the tag name
+    # @param [Object] value the tag value
+    def add_tag(key, value)
+      @tags[key] = value
+      self
+    end
+
+    # Adds or replaces a field value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the field name
+    # @param [Object] value the field value
+    def add_field(key, value)
+      @fields[key] = value
+      self
+    end
+
+    # Updates the timestamp for the point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(Time.new(2015, 10, 15, 8, 20, 15), InfluxDB::WritePrecision::MILLISECOND)
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(123, InfluxDB::WritePrecision::NANOSECOND)
+    #
+    # @param [Object] time the timestamp
+    # @param [WritePrecision] precision the timestamp precision
+    def time(time, precision)
+      @time = time
+      @precision = precision
+      self
+    end
+
+    # If there is no field then return nil.
+    #
+    # @return a string representation of the point
+    def to_line_protocol
+      line_protocol = ''
+      measurement = _escape_key(@name || '')
+
+      line_protocol << measurement
+
+      tags = _escape_tags
+      line_protocol << ",#{tags}" unless tags.empty?
+      line_protocol << ' '.freeze if line_protocol[-1] == '\\'
+
+      fields = _escape_fields
+      return nil if fields.empty?
+
+      line_protocol << " #{fields}" if fields
+      timestamp = _escape_time
+      line_protocol << " #{timestamp}" if timestamp
+
+      line_protocol
+    end
+
+    private
+
+    def _escape_tags
+      return if @tags.nil?
+
+      @tags.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_key(v.to_s)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_fields
+      return if @fields.nil?
+
+      @fields.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_value(v)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_key(value)
+      result = value.dup
+      ESCAPE_KEY_LIST.each do |ch|
+        result = result.gsub(ch) { "\\#{ch}" }
+      end
+      result
+    end
+
+    def _escape_value(value)
+      if value.nil?
+        ''
+      elsif value.is_a?(String)
+        result = value.dup
+        ESCAPE_VALUE_LIST.each do |ch|
+          result = result.gsub(ch) { "\\#{ch}" }
+        end
+        '"'.freeze + result + '"'.freeze
+      elsif value.is_a?(Integer)
+        "#{value}i"
+      elsif [Float::INFINITY, -Float::INFINITY].include?(value)
+        ''
+      else
+        value.to_s
+      end
+    end
+
+    def _escape_time
+      if @time.nil?
+        nil
+      elsif @time.is_a?(Integer)
+        @time.to_s
+      elsif @time.is_a?(Float)
+        @time.round.to_s
+      elsif @time.is_a?(Time)
+        nano_seconds = @time.to_i * 1e9
+        nano_seconds += @time.tv_nsec
+        case @precision || DEFAULT_WRITE_PRECISION
+        when InfluxDB2::WritePrecision::MILLISECOND then
+          (nano_seconds / 1e6).round
+        when InfluxDB2::WritePrecision::SECOND then
+          (nano_seconds / 1e9).round
+        when InfluxDB2::WritePrecision::MICROSECOND then
+          (nano_seconds / 1e3).round
+        when InfluxDB2::WritePrecision::NANOSECOND then
+          nano_seconds.round
+        end
+      else
+        @time.to_s
+      end
+    end
+  end
+end

data/lib/influxdb2/client/query_api.rb

@@ -0,0 +1,93 @@
+# The 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.
+require_relative 'models/dialect'
+require_relative 'models/query'
+require_relative 'flux_csv_parser'
+require 'json'
+
+module InfluxDB2
+  # The client of the InfluxDB 2.0 that implement Query HTTP API endpoint.
+  #
+  class QueryApi < DefaultApi
+    DEFAULT_DIALECT = InfluxDB2::Dialect.new(header: true, delimiter: ',', comment_prefix: '#',
+                                             annotations: %w[datatype group default])
+
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      super(options: options)
+    end
+
+    # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
+    # @param [String] org specifies the source organization
+    # @return [String] result of query
+    def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      _post_query(query: query, org: org, dialect: dialect).read_body
+    end
+
+    # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
+    # @param [String] org specifies the source organization
+    # @return [Array] list of FluxTables which are matched the query
+    def query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      response = query_raw(query: query, org: org, dialect: dialect)
+      parser = InfluxDB2::FluxCsvParser.new(response)
+
+      parser.parse
+      parser.tables
+    end
+
+    # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
+    # @param [String] org specifies the source organization
+    # @return stream of Flux Records
+    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      response = _post_query(query: query, org: org, dialect: dialect)
+
+      InfluxDB2::FluxCsvParser.new(response, stream: true)
+    end
+
+    private
+
+    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      org_param = org || @options[:org]
+      _check('org', org_param)
+
+      payload = _generate_payload(query, dialect)
+      return nil if payload.nil?
+
+      uri = URI.parse(File.join(@options[:url], '/api/v2/query'))
+      uri.query = URI.encode_www_form(org: org_param)
+
+      _post(payload.to_body.to_json, uri)
+    end
+
+    def _generate_payload(query, dialect)
+      if query.nil?
+        nil
+      elsif query.is_a?(Query)
+        query
+      elsif query.is_a?(String)
+        if query.empty?
+          nil
+        else
+          Query.new(query: query, dialect: dialect, type: nil)
+        end
+      end
+    end
+  end
+end

data/lib/influxdb2/client/version.rb

@@ -0,0 +1,23 @@
+# The 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.
+
+module InfluxDB2
+  VERSION = '1.1.0'.freeze
+end

data/lib/influxdb2/client/worker.rb

@@ -0,0 +1,89 @@
+# The 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.
+
+module InfluxDB2
+  # Worker for handling write batching queue
+  #
+  class Worker
+    def initialize(api_client, write_options)
+      @api_client = api_client
+      @write_options = write_options
+
+      @queue = Queue.new
+      @queue_event = Queue.new
+
+      @queue_event.push(true)
+
+      @thread_flush = Thread.new do
+        until api_client.closed
+          sleep @write_options.flush_interval / 1_000
+          check_background_queue
+        end
+      end
+
+      @thread_size = Thread.new do
+        until api_client.closed
+          check_background_queue(size: true) if @queue.length >= @write_options.batch_size
+          sleep 0.01
+        end
+      end
+    end
+
+    def push(payload)
+      @queue.push(payload)
+    end
+
+    def check_background_queue(size: false, flush_all: false)
+      @queue_event.pop
+      data = {}
+      points = 0
+
+      if size && @queue.length < @write_options.batch_size
+        @queue_event.push(true)
+        return
+      end
+
+      while (flush_all || points < @write_options.batch_size) && !@queue.empty?
+        begin
+          item = @queue.pop(true)
+          key = item.key
+          data[key] = [] unless data.key?(key)
+          data[key] << item.data
+          points += 1
+        rescue ThreadError
+          return
+        end
+      end
+
+      write(data) unless data.values.flatten.empty?
+      @queue_event.push(true)
+    end
+
+    def flush_all
+      check_background_queue(flush_all: true) unless @queue.empty?
+    end
+
+    def write(data)
+      data.each do |key, points|
+        @api_client.write_raw(points.join("\n"), precision: key.precision, bucket: key.bucket, org: key.org)
+      end
+    end
+  end
+end

data/lib/influxdb2/client/write_api.rb

@@ -0,0 +1,219 @@
+# The 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.
+require_relative 'worker'
+
+module InfluxDB2
+  module WriteType
+    SYNCHRONOUS = 1
+    BATCHING = 2
+  end
+
+  # Creates write api configuration.
+  #
+  # @param write_type: methods of write (batching, asynchronous, synchronous)
+  # @param batch_size: the number of data point to collect in batch
+  # @param flush_interval: flush data at least in this interval
+  class WriteOptions
+    def initialize(write_type: WriteType::SYNCHRONOUS, batch_size: 1_000, flush_interval: 1_000)
+      @write_type = write_type
+      @batch_size = batch_size
+      @flush_interval = flush_interval
+    end
+
+    attr_reader :write_type, :batch_size, :flush_interval
+  end
+
+  SYNCHRONOUS = InfluxDB2::WriteOptions.new(write_type: WriteType::SYNCHRONOUS)
+
+  # Precision constants.
+  #
+  class WritePrecision
+    SECOND = 's'.freeze
+    MILLISECOND = 'ms'.freeze
+    MICROSECOND = 'us'.freeze
+    NANOSECOND = 'ns'.freeze
+
+    def get_from_value(value)
+      constants = WritePrecision.constants.select { |c| WritePrecision.const_get(c) == value }
+      raise "The time precision #{value} is not supported." if constants.empty?
+
+      value
+    end
+  end
+
+  # Write time series data into InfluxDB.
+  #
+  class WriteApi < DefaultApi
+    # @param [Hash] options The options to be used by the client.
+    # @param [WriteOptions] write_options Write api configuration.
+    def initialize(options:, write_options: SYNCHRONOUS)
+      super(options: options)
+      @write_options = write_options
+      @closed = false
+    end
+    attr_reader :closed
+
+    # Write data into specified Bucket.
+    #
+    # @example write(data:
+    #   [
+    #     {
+    #       name: 'cpu',
+    #       tags: { host: 'server_nl', region: 'us' },
+    #       fields: {internal: 5, external: 6},
+    #       time: 1422568543702900257
+    #     },
+    #     {name: 'gpu', fields: {value: 0.9999}}
+    #   ],
+    #   precision: InfluxDB::WritePrecision::NANOSECOND,
+    #   bucket: 'my-bucket',
+    #   org: 'my-org'
+    # )
+    #
+    # @example write(data: 'h2o,location=west value=33i 15')
+    #
+    # @example point = InfluxDB::Point.new(name: 'h2o')
+    #   .add_tag('location', 'europe')
+    #   .add_field('level', 2)
+    #
+    # hash = { name: 'h2o', tags: { host: 'aws', region: 'us' }, fields: { level: 5, saturation: '99%' }, time: 123 }
+    #
+    # write(data: ['h2o,location=west value=33i 15', point, hash])
+    #
+    # @param [Object] data DataPoints to write into InfluxDB. The data could be represent by [Hash], [Point], [String]
+    #   or by collection of these types
+    # @param [WritePrecision] precision The precision for the unix timestamps within the body line-protocol
+    # @param [String] bucket specifies the destination bucket for writes
+    # @param [String] org specifies the destination organization for writes
+    def write(data:, precision: nil, bucket: nil, org: nil)
+      precision_param = precision || @options[:precision]
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('precision', precision_param)
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      payload = _generate_payload(data, bucket: bucket_param, org: org_param, precision: precision_param)
+      return nil if payload.nil?
+
+      if WriteType::BATCHING == @write_options.write_type
+        _worker.push(payload)
+      else
+        write_raw(payload, precision: precision_param, bucket: bucket_param, org: org_param)
+      end
+    end
+
+    # @return [ true ] Always true.
+    def close!
+      _worker.flush_all unless _worker.nil?
+      @closed = true
+      true
+    end
+
+    # @param [String] payload data as String
+    # @param [WritePrecision] precision The precision for the unix timestamps within the body line-protocol
+    # @param [String] bucket specifies the destination bucket for writes
+    # @param [String] org specifies the destination organization for writes
+    def write_raw(payload, precision: nil, bucket: nil, org: nil)
+      precision_param = precision || @options[:precision]
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('precision', precision_param)
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      return nil unless payload.instance_of?(String) || payload.empty?
+
+      uri = URI.parse(File.join(@options[:url], '/api/v2/write'))
+      uri.query = URI.encode_www_form(bucket: bucket_param, org: org_param, precision: precision_param.to_s)
+
+      _post(payload, uri)
+    end
+
+    # Item for batching queue
+    class BatchItem
+      def initialize(key, data)
+        @key = key
+        @data = data
+      end
+      attr_reader :key, :data
+    end
+
+    # Key for batch item
+    class BatchItemKey
+      def initialize(bucket, org, precision = DEFAULT_WRITE_PRECISION)
+        @bucket = bucket
+        @org = org
+        @precision = precision
+      end
+      attr_reader :bucket, :org, :precision
+
+      def ==(other)
+        @bucket == other.bucket && @org == other.org && @precision == other.precision
+      end
+
+      alias eql? ==
+
+      def hash
+        @bucket.hash ^ @org.hash ^ @precision.hash # XOR
+      end
+    end
+
+    private
+
+    WORKER_MUTEX = Mutex.new
+    def _worker
+      return nil unless @write_options.write_type == WriteType::BATCHING
+
+      return @worker if @worker
+
+      WORKER_MUTEX.synchronize do
+        # this return is necessary because the previous mutex holder
+        # might have already assigned the @worker
+        return @worker if @worker
+
+        @worker = Worker.new(self, @write_options)
+      end
+    end
+
+    def _generate_payload(data, precision: nil, bucket: nil, org: nil)
+      if data.nil?
+        nil
+      elsif data.is_a?(Point)
+        _generate_payload(data.to_line_protocol, bucket: bucket, org: org, precision: data.precision ||
+            DEFAULT_WRITE_PRECISION)
+      elsif data.is_a?(String)
+        if data.empty?
+          nil
+        elsif @write_options.write_type == WriteType::BATCHING
+          BatchItem.new(BatchItemKey.new(bucket, org, precision), data)
+        else
+          data
+        end
+      elsif data.is_a?(Hash)
+        _generate_payload(Point.from_hash(data), bucket: bucket, org: org, precision: precision)
+      elsif data.respond_to? :map
+        data.map do |item|
+          _generate_payload(item, bucket: bucket, org: org, precision: precision)
+        end.reject(&:nil?).join("\n".freeze)
+      end
+    end
+  end
+end