influxdb-rails 1.0.0.beta3 → 1.0.0.beta4

data/lib/influxdb/rails/version.rb

@@ -1,5 +1,5 @@
 module InfluxDB
   module Rails
-    VERSION = "1.0.0.beta3".freeze
+    VERSION = "1.0.0.beta4".freeze
   end
 end

data/lib/influxdb-rails.rb

@@ -7,12 +7,8 @@ require "influxdb/rails/middleware/request_subscriber"
 require "influxdb/rails/middleware/sql_subscriber"
 require "influxdb/rails/sql/query"
 require "influxdb/rails/version"
-require "influxdb/rails/logger"
-require "influxdb/rails/exception_presenter"
 require "influxdb/rails/configuration"
-require "influxdb/rails/backtrace"
 require "influxdb/rails/context"
-require "influxdb/rails/rack"
 
 require "influxdb/rails/railtie" if defined?(Rails::Railtie)
 
@@ -21,41 +17,38 @@ module InfluxDB
   # InfluxDB and Rails. This is a singleton class.
   module Rails
     class << self
-      include InfluxDB::Rails::Logger
-
       attr_writer :configuration
       attr_writer :client
 
-      def configure(_silent = false)
-        yield(configuration)
-
-        # if we change configuration, reload the client
-        self.client = nil
+      def configure
+        return configuration unless block_given?
 
-        InfluxDB::Logging.logger = configuration.logger unless configuration.logger.nil?
+        yield configuration
+        self.client = nil # if we change configuration, reload the client
       end
 
       # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
 
       def client
-        @client ||= InfluxDB::Client.new \
-          database:       configuration.influxdb_database,
-          username:       configuration.influxdb_username,
-          password:       configuration.influxdb_password,
-          hosts:          configuration.influxdb_hosts,
-          port:           configuration.influxdb_port,
-          async:          configuration.async,
-          use_ssl:        configuration.use_ssl,
-          retry:          configuration.retry,
-          open_timeout:   configuration.open_timeout,
-          read_timeout:   configuration.read_timeout,
-          max_delay:      configuration.max_delay,
-          time_precision: configuration.time_precision
+        @client ||= begin
+          cfg = configuration.client
+          InfluxDB::Client.new \
+            database:       cfg.database,
+            username:       cfg.username,
+            password:       cfg.password,
+            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
+        end
       end
 
       # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       def configuration
         @configuration ||= InfluxDB::Rails::Configuration.new
@@ -64,60 +57,6 @@ module InfluxDB
       def current
         @current ||= InfluxDB::Rails::Context.new
       end
-
-      def report_exception_unless_ignorable(ex, env = {})
-        report_exception(ex, env) unless ignorable_exception?(ex)
-      end
-      alias transmit_unless_ignorable report_exception_unless_ignorable
-
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
-
-      def report_exception(ex, env = {})
-        timestamp = InfluxDB::Rails.current_timestamp
-        env = influxdb_request_data if env.empty? && defined? influxdb_request_data
-        exception_presenter = ExceptionPresenter.new(ex, env)
-        log :info, "Exception: #{exception_presenter.to_json[0..512]}..."
-        tags = configuration.tags_middleware.call(
-          exception_presenter.context.merge(exception_presenter.dimensions)
-        )
-
-        client.write_point \
-          configuration.series_name_for_exceptions,
-          values:    exception_presenter.values.merge(ts: timestamp),
-          tags:      tags,
-          timestamp: timestamp
-      rescue StandardError => ex
-        log :info, "[InfluxDB::Rails] Something went terribly wrong." \
-          " Exception failed to take off! #{ex.class}: #{ex.message}"
-      end
-      alias transmit report_exception
-
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-
-      def current_timestamp
-        InfluxDB.now(configuration.time_precision)
-      end
-
-      def ignorable_exception?(ex)
-        configuration.ignore_current_environment? || configuration.ignore_exception?(ex)
-      end
-
-      def rescue
-        yield
-      rescue StandardError => ex
-        raise ex if configuration.ignore_current_environment?
-
-        transmit_unless_ignorable(ex)
-      end
-
-      def rescue_and_reraise
-        yield
-      rescue StandardError => ex
-        transmit_unless_ignorable(ex)
-        raise ex
-      end
     end
   end
 end

data/lib/rails/generators/influxdb/influxdb_generator.rb

@@ -1,6 +1,6 @@
 require "rails/generators"
 
-class InfluxdbGenerator < Rails::Generators::Base # rubocop:disable Style/Documentation
+class InfluxdbGenerator < Rails::Generators::Base
   desc "Description:\n  This creates a Rails initializer for InfluxDB::Rails."
 
   source_root File.expand_path("templates", __dir__)

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

@@ -1,11 +1,41 @@
 InfluxDB::Rails.configure do |config|
-  config.influxdb_database = "rails"
-  config.influxdb_username = "root"
-  config.influxdb_password = "root"
-  config.influxdb_hosts    = ["localhost"]
-  config.influxdb_port     = 8086
-
-  # config.series_name_for_controller_runtimes = "rails.controller"
-  # config.series_name_for_view_runtimes       = "rails.view"
-  # config.series_name_for_db_runtimes         = "rails.db"
+  ## 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"
+
+  ## Various other client and connection options. These are used to create
+  ## an `InfluxDB::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
+  ##
+  ## 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"
+
+  ## Disable rails framework hooks.
+  # config.ignored_hooks = ['sql.active_record', 'render_template.action_view']
+
+  # Modify tags on the fly.
+  # config.tags_middleware = ->(tags) { tags }
+
+  ## Set the application name to something meaningful, by default we
+  ## infer the app name from the Rails.application class name.
+  # config.application_name = Rails.application.class.parent_name
 end

data/sample-dashboard/Dockerfile

@@ -0,0 +1,25 @@
+FROM opensuse/leap:15.1
+
+ENV NOKOGIRI_USE_SYSTEM_LIBRARIES 1
+RUN useradd -g users -p rails -d /home/rails -m rails
+RUN echo 'rails ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+RUN zypper -n addrepo -f https://dl.yarnpkg.com/rpm/yarn.repo; zypper --gpg-auto-import-keys refresh
+RUN zypper -n install --no-recommends ruby2.5-devel nodejs10 make gcc timezone sudo pkg-config sqlite3-devel libxml2-devel libxslt-devel yarn git-core curl
+RUN zypper -n clean -a
+RUN gem install --no-format-executable --no-document rails -v '~> 6'
+
+USER rails
+WORKDIR /home/rails
+
+RUN rails new thingiverse;
+
+WORKDIR /home/rails/thingiverse
+RUN rails g scaffold thing name:string amount:integer
+RUN echo 'gem "influxdb-rails", :git => "https://github.com/influxdata/influxdb-rails/", :branch => "master"' >> Gemfile
+RUN bundle install; rails webpacker:install; rake db:migrate
+RUN sed -i '2i \  root to: "things#index"' config/routes.rb
+RUN bundle exec rails generate influxdb
+RUN curl -o app/controllers/application_controller.rb https://gist.githubusercontent.com/hennevogel/296e93b9db620e9cf48eeb30cef6a145/raw/8c6d4635ded3bef2ca9cfdf65c5863cf6f03a984/application_controller.rb
+RUN sed -i '2i \  config.client.hosts = "influx"' config/initializers/influxdb_rails.rb
+CMD bundle exec rails server -b 0.0.0.0 -p 4000

data/sample-dashboard/README.md

@@ -0,0 +1,74 @@
+# Ruby On Rails Performance Dashboard
+
+A dashboard providing Ruby on Rails performance insights based on
+[Free Software](https://www.fsf.org/about/what-is-free-software), ready to
+run inside your data-center.
+
+![Screenshot of the dashboard](https://grafana.com/api/dashboards/10428/images/6557/image)
+
+By default it measures (in various forms):
+
+- Controller Action Runtime
+- View/Partial Render Runtime
+- Database Query Runtime
+
+It provides an overview and you can also drill down into numbers on a per request basis. Of course you can use all the awesome features that Influx (Downsampling/Data Retention), Grafana (Alerts, Annotations) and influxdb-rails (custom tags) provide and extend this to your needs. Use your freedom and run, copy, distribute, study, change and improve this software!
+
+## Requirements
+
+To be able to measure performance you need the following things available:
+
+- [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)
+- [Grafana](https://grafana.com/docs/)
+- A [Ruby On Rails](https://rubyonrails.org/) application with [influxdb-rails](https://github.com/influxdata/influxdb-rails) enabled
+
+## Installation
+
+Once you have influx/grafana instances running in your infrastructure just [import both
+dashboards from grafana](https://grafana.com/docs/reference/export_import/#importing-a-dashboard).
+
+- [Overview Dashboard](https://grafana.com/dashboards/10428)
+- [Request Dashboard](https://grafana.com/dashboards/10429)
+
+You can also paste the `.json` files from this repository.
+
+In the unlikely case that you need to change the dashboard *UID*s during import you can configure the *UID* the `Overview` dashboard uses to link to the `Request` dashboard in the [variables](https://grafana.com/docs/reference/templating/#adding-a-variable). Just paste whatever *UID* you've set up for the `Request` dashboard.
+
+## Demo
+
+This repository includes a [docker-compose](https://docs.docker.com/compose/) demo setup that brings a simple rails app, influxdb and grafana.
+
+### Starting the demo services
+
+Clone this repository and run
+
+```shell
+docker-compose up
+```
+
+### Browse the sample app...
+
+Go to http://0.0.0.0:4000 and do some things. Every request to the rails app will generate performance data in the demo.
+
+### ...or Configure your own Rails app...
+
+You can also use the dashboard with any other rails app you already have. Follow our [install instructions](https://github.com/influxdata/influxdb-rails/#installation), the default configuration works with the demo InfluxDB running on localhost:8086.
+
+To be able to view individual requests you have to enable request ID tags in your application. Something like:
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  before_action :set_influx_data
+
+  def set_influx_data
+    InfluxDB::Rails.current.values = { request: request.request_id }
+  end
+end
+```
+
+### ...then see the dashboards in action
+
+Just go to http://0.0.0.0:3000 and log in with admin/admin.
+
+Enjoy! ❤️

data/sample-dashboard/Rakefile

@@ -0,0 +1,8 @@
+task default: %w[prepare]
+
+# rubocop:disable Metrics/LineLength
+task :prepare do
+  sh "cat 'Ruby On Rails Performance.json' | sed 's/${DS_INFLUXDB}/InfluxDB/g' > provisioning/performance.json"
+  sh "cat 'Ruby On Rails Performance (per Request).json' | sed 's/${DS_INFLUXDB}/InfluxDB/g' > provisioning/performance-request.json"
+end
+# rubocop:enable Metrics/LineLength