Support InfluxDB 2.0

Author: ChrisBr

influxdb-rails.gemspec

@@ -24,14 +24,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.0"
 
-  spec.add_runtime_dependency "influxdb", "~> 0.6", ">= 0.6.4"
+  spec.add_runtime_dependency "influxdb-client"
   spec.add_runtime_dependency "railties", ">= 5.0"
 
   spec.add_development_dependency "actionmailer"
   spec.add_development_dependency "activejob"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "bundler", ">= 1.0.0"
-  spec.add_development_dependency "fakeweb"
   spec.add_development_dependency "launchy"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
@@ -43,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "tzinfo"
+  spec.add_development_dependency "webmock"
 end

lib/influxdb-rails.rb

@@ -2,6 +2,7 @@
 require "net/https"
 require "rubygems"
 require "socket"
+require "influxdb-client"
 require "influxdb/rails/middleware/block_instrumentation_subscriber"
 require "influxdb/rails/middleware/render_subscriber"
 require "influxdb/rails/middleware/request_subscriber"
@@ -21,41 +22,48 @@ module InfluxDB
   # InfluxDB and Rails. This is a singleton class.
   module Rails
     class << self
-      attr_writer :configuration, :client
+      attr_writer :configuration, :client, :write_api
 
       def configure
-        return configuration unless block_given?
+        yield configuration if block_given?
 
-        yield configuration
-        self.client = nil # if we change configuration, reload the client
+        # if we change configuration, reload the client
+        self.client = nil
+        self.write_api = nil
+
+        configuration
+      end
+
+      def configuration
+        @configuration ||= InfluxDB::Rails::Configuration.new
       end
 
       # rubocop:disable Metrics/MethodLength
 
       def client
         @client ||= begin
           cfg = configuration.client
-          InfluxDB::Client.new \
-            database:       cfg.database,
-            username:       cfg.username,
-            password:       cfg.password,
-            auth_method:    cfg.auth_method,
-            hosts:          cfg.hosts,
-            port:           cfg.port,
-            async:          cfg.async,
-            use_ssl:        cfg.use_ssl,
-            retry:          cfg.retry,
-            open_timeout:   cfg.open_timeout,
-            read_timeout:   cfg.read_timeout,
-            max_delay:      cfg.max_delay,
-            time_precision: cfg.time_precision
+          InfluxDB2::Client.new(
+            cfg.url,
+            cfg.token,
+            org:           cfg.org,
+            bucket:        cfg.bucket,
+            precision:     cfg.precision,
+            open_timeout:  cfg.open_timeout,
+            write_timeout: cfg.write_timeout,
+            read_timeout:  cfg.read_timeout,
+            use_ssl:       cfg.use_ssl,
+            logger:        ::Rails.logger,
+            async:         cfg.async,
+            retries:       cfg.retries
+          )
         end
       end
 
       # rubocop:enable Metrics/MethodLength
 
-      def configuration
-        @configuration ||= InfluxDB::Rails::Configuration.new
+      def write_api
+        @write_api ||= client.create_write_api(write_options: configuration.client.write_options)
       end
 
       def current

lib/influxdb/rails/configuration.rb

@@ -28,25 +28,37 @@ def load_defaults
     class ClientConfig
       include Configurable
 
+      WRITE_TYPE = {
+        true  => ::InfluxDB2::WriteType::BATCHING,
+        false => ::InfluxDB2::WriteType::SYNCHRONOUS,
+      }.freeze
+      private_constant :WRITE_TYPE
+
       set_defaults(
-        hosts:          ["localhost"].freeze,
-        port:           8086,
-        username:       "root".freeze,
-        password:       "root".freeze,
-        database:       nil,
-        auth_method:    "params".freeze,
-        async:          true,
-        use_ssl:        false,
-        retry:          nil,
-        open_timeout:   5,
-        read_timeout:   300,
-        max_delay:      30,
-        time_precision: "s".freeze
+        url:                "http://localhost:8086".freeze,
+        token:              nil,
+        org:                nil,
+        bucket:             nil,
+        use_ssl:            true,
+        open_timeout:       5.seconds,
+        write_timeout:      5.seconds,
+        read_timeout:       60.seconds,
+        precision:          ::InfluxDB2::WritePrecision::MILLISECOND,
+        retries:            0,
+        async:              true,
+        max_retry_delay_ms: 10.seconds.to_i * 1000
       )
 
       def initialize
         load_defaults
       end
+
+      def write_options
+        InfluxDB2::WriteOptions.new(
+          write_type:  WRITE_TYPE[async],
+          max_retries: retries
+        )
+      end
     end
     private_constant :ClientConfig
 
@@ -69,36 +81,6 @@ class Configuration
       # configuration passed to InfluxDB::Client
       attr_reader :client
 
-      # FIXME: Old configuration options, remove this in 1.0.1
-      attr_writer \
-        :series_name_for_controller_runtimes,
-        :series_name_for_view_runtimes,
-        :series_name_for_db_runtimes,
-        :series_name_for_render_template,
-        :series_name_for_render_partial,
-        :series_name_for_render_collection,
-        :series_name_for_sql,
-        :series_name_for_exceptions,
-        :series_name_for_instrumentation,
-        :ignored_exceptions,
-        :ignored_exception_messages,
-        :ignored_user_agents,
-        :application_root,
-        :environment_variable_filters,
-        :backtrace_filters,
-        :influxdb_database,
-        :influxdb_username,
-        :influxdb_password,
-        :influxdb_hosts,
-        :influxdb_port,
-        :async,
-        :use_ssl,
-        :retry,
-        :open_timeout,
-        :read_timeout,
-        :max_delay,
-        :time_precision
-
       def initialize
         @client = ClientConfig.new
         load_defaults

lib/influxdb/rails/helpers/rspec_matchers.rb

@@ -34,7 +34,7 @@ def metrics
           InfluxDB::Rails.instance_variable_set :@configuration, nil
           InfluxDB::Rails.configure
 
-          allow(InfluxDB::Rails).to receive(:client).and_return(InfluxDB::Rails::TestClient.new)
+          InfluxDB::Rails.client = InfluxDB::Rails::TestClient.new
           allow_any_instance_of(InfluxDB::Rails::Configuration)
             .to receive(:ignored_environments).and_return(%w[development])
 

lib/influxdb/rails/metric.rb

@@ -1,4 +1,3 @@
-require "influxdb/rails/values"
 require "influxdb/rails/tags"
 
 module InfluxDB
@@ -12,27 +11,24 @@ def initialize(configuration:, timestamp:, tags: {}, values: {})
       end
 
       def write
-        client.write_point configuration.measurement_name, options
+        write_api.write(data: data)
       end
 
       private
 
       attr_reader :configuration, :tags, :values, :timestamp
 
-      def options
+      def data
         {
-          values:    Values.new(values: values).to_h,
-          tags:      Tags.new(tags: tags, config: configuration).to_h,
-          timestamp: timestamp_with_precision,
+          fields: values.merge(InfluxDB::Rails.current.values),
+          tags:   Tags.new(tags: tags, config: configuration).to_h,
+          name:   configuration.measurement_name,
+          time:   timestamp.utc,
         }
       end
 
-      def timestamp_with_precision
-        InfluxDB.convert_timestamp(timestamp.utc, configuration.client.time_precision)
-      end
-
-      def client
-        InfluxDB::Rails.client
+      def write_api
+        InfluxDB::Rails.write_api
       end
     end
   end

lib/influxdb/rails/middleware/request_subscriber.rb

@@ -28,7 +28,7 @@ def values
             controller: duration,
             view:       (payload[:view_runtime] || 0).ceil,
             db:         (payload[:db_runtime] || 0).ceil,
-            started:    started,
+            started:    start.utc,
           }
         end
 

lib/influxdb/rails/railtie.rb

@@ -1,4 +1,4 @@
-require "influxdb"
+require "influxdb-client"
 require "rails"
 
 module InfluxDB

lib/influxdb/rails/tags.rb

@@ -8,19 +8,13 @@ def initialize(config:, tags: {}, additional_tags: InfluxDB::Rails.current.tags)
       end
 
       def to_h
-        expanded_tags.reject do |_, value|
-          value.to_s.blank?
-        end
+        config.tags_middleware.call(tags.merge(default_tags))
       end
 
       private
 
       attr_reader :additional_tags, :tags, :config
 
-      def expanded_tags
-        config.tags_middleware.call(tags.merge(default_tags))
-      end
-
       def default_tags
         {
           server:   Socket.gethostname,

lib/influxdb/rails/test_client.rb

@@ -5,8 +5,12 @@ class TestClient
         []
       end
 
-      def write_point(name, options = {})
-        metrics << options.merge(name: name)
+      def write(options = {})
+        metrics << options[:data]
+      end
+
+      def create_write_api(*)
+        self
       end
     end
   end

lib/rails/generators/influxdb/templates/initializer.rb

@@ -1,37 +1,24 @@
 InfluxDB::Rails.configure do |config|
-  ## The only setting you actually need to update is the name of the
-  ## database within the InfluxDB server instance. Don't forget to
-  ## create this database as well.
-  config.client.database = "rails"
-  # config.client.hosts = ["localhost"]
-  # config.client.port = 8086
-
-  ## If you've setup user authentication (and activated it in the server
-  ## config), you need to configure the credentials here.
-  # config.client.username = "root"
-  # config.client.password = "root"
-
-  ## If your InfluxDB service requires an HTTPS connection then you can
-  ## enable it here.
-  # config.client.use_ssl = true
+  ## The only settings you actually need to set are org, bucket and token.
+  config.client.bucket = "bucket"
+  config.client.org = "org"
+  config.client.token = "token"
+  # config.client.url = "localhost:8086",
 
   ## Various other client and connection options. These are used to create
-  ## an `InfluxDB::Client` instance (i.e. `InfluxDB::Rails.client`).
+  ## an `InfluxDB2::Client` instance (i.e. `InfluxDB::Rails.client`).
   ##
-  ## See docs for the influxdb gem for the canonical list of options:
-  ## https://github.com/influxdata/influxdb-ruby#list-of-configuration-options
+  ## See docs for the influxdb-client gem for the canonical list of options:
+  ## https://github.com/influxdata/influxdb-client-ruby#creating-a-client
   ##
-  ## These defaults for the influxdb-rails gem deviate from the default
-  ## for the influxdb gem:
-  # config.client.async = true # false
-  # config.client.read_timeout = 30 # 300
-  # config.client.max_delay = 300 # 30
-  # config.client.time_precision = "ms" # "s"
-
-  ## Prior to 1.0.0, this gem has written all data points in different
-  ## measurements (the config options were named `series_name_for_*`).
-  ## Since 1.0.0.beta3, we're now using a single measurements
-  # config.measurement_name = "rails"
+  # config.client.use_ssql = true
+  # config.client.open_timeout = 5.seconds
+  # config.client.write_timeout = 5.seconds
+  # config.client.read_timeout = 60.seconds
+  # config.client.time_precisions = InfluxDB2::WritePrecision::MILLISECOND
+  # config.client.retries = 0
+  # config.client.max_retry_delay_ms = 10_000
+  # config.client.async = true
 
   ## Disable rails framework hooks.
   # config.ignored_hooks = ['sql.active_record', 'render_template.action_view']

spec/integration/influxdb_rails_sends_metrics_spec.rb

@@ -0,0 +1,36 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+RSpec.describe "InfluxDB Rails sends metrics" do
+  it "does a HTTP request to InfluxDB server with correct tags and fields" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+    configure("bucket", "org")
+    stub_hostname("hostname")
+    request = write_request.with(
+      query: hash_including(bucket: "bucket", org: "org", precision: "ms"),
+      body:  "rails,hook=block_instrumentation,location=raw,name=name,server=hostname value=1i 1514797200000000000"
+    )
+
+    InfluxDB::Rails.instrument "name", values: { value: 1 }
+
+    assert_requested(request, times: 1)
+  end
+
+  private
+
+  def configure(bucket, org)
+    InfluxDB::Rails.configure do |config|
+      config.client.token = "my-token"
+      config.client.bucket = bucket
+      config.client.org = org
+      config.client.async = false
+    end
+  end
+
+  def write_request
+    stub_request(:post, "https://localhost:8086/api/v2/write")
+  end
+
+  def stub_hostname(name)
+    allow(Socket).to receive(:gethostname).and_return(name)
+  end
+end