influxdb-rails 1.0.0.beta3 → 1.0.0.beta4

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
 platform: ruby
 authors:
-- Dominik Menke
-- Todd Persen
+- Christian Bruckmayer
+- Henne Vogelsang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -87,6 +87,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -161,16 +175,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -185,11 +199,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem automatically instruments your Ruby on Rails 4.2/5.x applications
-  using InfluxDB for storage.
+description: This gem instruments your Ruby on Rails application using InfluxDB.
 email:
-- dominik.menke@gmail.com
-- todd@influxdb.com
+- christian@bruckmayer.net
+- hvogel@hennevogel.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -210,42 +223,41 @@ files:
 - gemfiles/Gemfile.rails-5.2.x
 - influxdb-rails.gemspec
 - lib/influxdb-rails.rb
-- lib/influxdb/rails/air_traffic_controller.rb
-- lib/influxdb/rails/backtrace.rb
 - lib/influxdb/rails/configuration.rb
 - lib/influxdb/rails/context.rb
-- lib/influxdb/rails/exception_presenter.rb
 - lib/influxdb/rails/instrumentation.rb
-- lib/influxdb/rails/logger.rb
-- lib/influxdb/rails/middleware/hijack_render_exception.rb
-- lib/influxdb/rails/middleware/hijack_rescue_action_everywhere.rb
 - lib/influxdb/rails/middleware/render_subscriber.rb
 - lib/influxdb/rails/middleware/request_subscriber.rb
 - lib/influxdb/rails/middleware/simple_subscriber.rb
 - lib/influxdb/rails/middleware/sql_subscriber.rb
 - lib/influxdb/rails/middleware/subscriber.rb
-- lib/influxdb/rails/rack.rb
 - lib/influxdb/rails/railtie.rb
 - lib/influxdb/rails/sql/normalizer.rb
 - lib/influxdb/rails/sql/query.rb
 - lib/influxdb/rails/version.rb
 - lib/rails/generators/influxdb/influxdb_generator.rb
 - lib/rails/generators/influxdb/templates/initializer.rb
+- sample-dashboard/Dockerfile
+- sample-dashboard/README.md
+- sample-dashboard/Rakefile
+- sample-dashboard/Ruby On Rails Performance (per Request).json
+- sample-dashboard/Ruby On Rails Performance.json
+- sample-dashboard/docker-compose.yml
+- sample-dashboard/provisioning/grafana-dashboards.yml
+- sample-dashboard/provisioning/grafana-datasource.yml
+- sample-dashboard/provisioning/performance-request.json
+- sample-dashboard/provisioning/performance.json
 - spec/controllers/widgets_controller_spec.rb
-- spec/integration/exceptions_spec.rb
 - spec/integration/integration_helper.rb
 - spec/integration/metrics_spec.rb
-- spec/shared_examples/tags.rb
+- spec/shared_examples/data.rb
 - spec/spec_helper.rb
 - spec/support/rails4/app.rb
 - spec/support/rails5/app.rb
 - spec/support/views/widgets/_item.html.erb
 - spec/support/views/widgets/index.html.erb
-- spec/unit/backtrace_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/context_spec.rb
-- spec/unit/exception_presenter_spec.rb
-- spec/unit/influxdb_rails_spec.rb
 - spec/unit/middleware/render_subscriber_spec.rb
 - spec/unit/middleware/request_subscriber_spec.rb
 - spec/unit/middleware/sql_subscriber_spec.rb
@@ -254,7 +266,11 @@ files:
 homepage: https://influxdata.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/influxdata/influxdb-rails/issues
+  changelog_uri: https://github.com/influxdata/influxdb-rails/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/influxdata/influxdb-rails/blob/master/README.md
+  source_code_uri: https://github.com/influxdata/influxdb-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -276,20 +292,16 @@ specification_version: 4
 summary: InfluxDB bindings for Ruby on Rails.
 test_files:
 - spec/controllers/widgets_controller_spec.rb
-- spec/integration/exceptions_spec.rb
 - spec/integration/integration_helper.rb
 - spec/integration/metrics_spec.rb
-- spec/shared_examples/tags.rb
+- spec/shared_examples/data.rb
 - spec/spec_helper.rb
 - spec/support/rails4/app.rb
 - spec/support/rails5/app.rb
 - spec/support/views/widgets/_item.html.erb
 - spec/support/views/widgets/index.html.erb
-- spec/unit/backtrace_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/context_spec.rb
-- spec/unit/exception_presenter_spec.rb
-- spec/unit/influxdb_rails_spec.rb
 - spec/unit/middleware/render_subscriber_spec.rb
 - spec/unit/middleware/request_subscriber_spec.rb
 - spec/unit/middleware/sql_subscriber_spec.rb

data/lib/influxdb/rails/air_traffic_controller.rb

@@ -1,41 +0,0 @@
-module InfluxDB
-  module Rails
-    module AirTrafficController # :nodoc:
-      def influxdb_request_data # rubocop:disable Metrics/MethodLength
-        {
-          params:       influxdb_filtered_params,
-          session_data: influxdb_session_data,
-          controller:   params[:controller],
-          action:       params[:action],
-          request_url:  influxdb_request_url,
-          user_agent:   request.env["HTTP_USER_AGENT"],
-          remote_ip:    request.remote_ip,
-          referer:      request.referer,
-          current_user: (current_user rescue nil),
-        }
-      end
-
-      private
-
-      def influxdb_session_data
-        session.respond_to?(:to_hash) ? session.to_hash : session.data
-      end
-
-      def influxdb_request_url
-        url = "#{request.protocol}#{request.host}"
-        url << ":#{request.port}" unless [80, 443].include?(request.port)
-        url << request.fullpath
-      end
-
-      def influxdb_filtered_params
-        if respond_to?(:filter_parameters)
-          filter_parameters(unfiltered_params)
-        elsif defined?(request.filtered_parameters)
-          request.filtered_parameters
-        else
-          params.to_hash.except(:password, :password_confirmation)
-        end
-      end
-    end
-  end
-end

data/lib/influxdb/rails/backtrace.rb

@@ -1,44 +0,0 @@
-module InfluxDB
-  module Rails
-    class Backtrace # rubocop:disable Style/Documentation
-      class Line # rubocop:disable Style/Documentation
-        FORMAT = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/.freeze
-
-        attr_reader :file
-        attr_reader :number
-        attr_reader :method
-
-        def initialize(line)
-          _, @file, @number, @method = line.match(FORMAT).to_a
-        end
-
-        def to_s
-          "#{file}:#{number} in `#{method}'"
-        end
-
-        def inspect
-          "<Line: #{to_s}>" # rubocop:disable Lint/StringConversionInInterpolation
-        end
-      end
-
-      attr_reader :lines
-
-      def initialize(backtrace)
-        @lines = Array(backtrace).each.collect do |line|
-          InfluxDB::Rails.configuration.backtrace_filters.each do |filter|
-            line = filter.call(line)
-          end
-          Line.new(line)
-        end
-      end
-
-      def to_a
-        lines.map(&:to_s)
-      end
-
-      def inspect
-        "<Backtrace: " + lines.collect(&:to_s).join(", ") + ">"
-      end
-    end
-  end
-end

data/lib/influxdb/rails/exception_presenter.rb

@@ -1,94 +0,0 @@
-require "base64"
-require "socket"
-require "json"
-
-module InfluxDB
-  module Rails
-    class ExceptionPresenter # rubocop:disable Style/Documentation
-      attr_reader :exception
-      attr_reader :backtrace
-      attr_reader :params
-      attr_reader :session_data
-      attr_reader :current_user
-      attr_reader :controller
-      attr_reader :action
-      attr_reader :request_url
-      attr_reader :referer
-      attr_reader :remote_ip
-      attr_reader :user_agent
-      attr_reader :custom_data
-
-      def initialize(ex, params = {})
-        ex = ex.continued_exception if ex.respond_to?(:continued_exception)
-        ex = ex.original_exception if ex.respond_to?(:original_exception)
-
-        @exception    = ex.is_a?(String) ? Exception.new(ex) : ex
-        @backtrace    = InfluxDB::Rails::Backtrace.new(@exception.backtrace)
-        @dimensions   = {}
-        configure_from_params(params)
-
-        @environment_variables = ENV.to_hash || {}
-      end
-
-      def context # rubocop:disable Metrics/MethodLength
-        c = {
-          application_name:  InfluxDB::Rails.configuration.application_name,
-          application_root:  InfluxDB::Rails.configuration.application_root,
-          framework:         InfluxDB::Rails.configuration.framework,
-          framework_version: InfluxDB::Rails.configuration.framework_version,
-          language:          "Ruby",
-          language_version:  "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
-          custom_data:       @custom_data,
-        }
-
-        InfluxDB::Rails.configuration.add_custom_exception_data(self)
-        c
-      end
-
-      def dimensions
-        {
-          class:    @exception.class.to_s,
-          method:   "#{@controller}##{@action}",
-          filename: File.basename(@backtrace.lines.first.try(:file)),
-          server:   Socket.gethostname,
-          status:   "open",
-        }.merge(@dimensions)
-      end
-
-      def values
-        {
-          exception_message:   @exception.message,
-          exception_backtrace: JSON.generate(@backtrace.to_a),
-        }
-      end
-
-      def request_data
-        {
-          params:       @params,
-          session_data: @session_data,
-          controller:   @controller,
-          action:       @action,
-          request_url:  @request_url,
-          referer:      @referer,
-          remote_ip:    @remote_ip,
-          user_agent:   @user_agent,
-        }
-      end
-
-      private
-
-      def configure_from_params(params)
-        @params       = params[:params]
-        @session_data = params[:session_data] || {}
-        @current_user = params[:current_user]
-        @controller   = params[:controller]
-        @action       = params[:action]
-        @request_url  = params[:request_url]
-        @user_agent   = params[:user_agent]
-        @referer      = params[:referer]
-        @remote_ip    = params[:remote_ip]
-        @custom_data  = params[:custom_data] || {}
-      end
-    end
-  end
-end

data/lib/influxdb/rails/logger.rb

@@ -1,16 +0,0 @@
-module InfluxDB
-  module Rails
-    module Logger # rubocop:disable Style/Documentation
-      PREFIX = "[InfluxDB::Rails] ".freeze
-
-      private
-
-      def log(level, message)
-        c = InfluxDB::Rails.configuration
-        return if level != :error && !c.debug?
-
-        c.logger&.send(level, PREFIX + message)
-      end
-    end
-  end
-end

data/lib/influxdb/rails/middleware/hijack_render_exception.rb

@@ -1,16 +0,0 @@
-module InfluxDB
-  module Rails
-    module Middleware
-      module HijackRenderException # rubocop:disable Style/Documentation
-        def render_exception(env, ex)
-          controller = env["action_controller.instance"] || env.controller_instance
-          request_data = controller.try(:influxdb_request_data) || {}
-          unless InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
-            InfluxDB::Rails.report_exception_unless_ignorable(ex, request_data)
-          end
-          super
-        end
-      end
-    end
-  end
-end

data/lib/influxdb/rails/middleware/hijack_rescue_action_everywhere.rb

@@ -1,31 +0,0 @@
-module InfluxDB
-  module Rails
-    module Middleware
-      module HijackRescueActionEverywhere # rubocop:disable Style/Documentation
-        def self.included(base)
-          base.send(:alias_method_chain, :rescue_action_in_public, :influxdb)
-          base.send(:alias_method_chain, :rescue_action_locally, :influxdb)
-        end
-
-        private
-
-        def rescue_action_in_public_with_influxdb(ex)
-          handle_exception(ex)
-          rescue_action_in_public_without_influxdb(ex)
-        end
-
-        def rescue_action_locally_with_influxdb(ex)
-          handle_exception(ex)
-          rescue_action_locally_without_influxdb(ex)
-        end
-
-        def handle_exception(ex)
-          request_data = influxdb_request_data || {}
-          return if InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
-
-          InfluxDB::Rails.report_exception_unless_ignorable(ex, request_data)
-        end
-      end
-    end
-  end
-end

data/lib/influxdb/rails/rack.rb

@@ -1,24 +0,0 @@
-module InfluxDB
-  module Rails
-    class Rack # rubocop:disable Style/Documentation
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        dup._call(env)
-      end
-
-      def _call(env)
-        begin
-          response = @app.call(env)
-        rescue StandardError => e
-          InfluxDB::Rails.transmit_unless_ignorable(e, env)
-          raise(e)
-        end
-
-        response
-      end
-    end
-  end
-end

data/spec/integration/exceptions_spec.rb

@@ -1,37 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
-
-RSpec.describe "exception handling", type: :request do
-  before do
-    InfluxDB::Rails.configure do |config|
-      config.ignored_environments = %w[development]
-      config.instrumentation_enabled = false
-    end
-  end
-
-  describe "in an action that raises an exception" do
-    it "should add an exception to the queue" do
-      expect(InfluxDB::Rails.client).to receive(:write_point)
-      get "/widgets/new"
-    end
-  end
-
-  describe "in an action that does not raise an exception" do
-    it "should not add anything to the queue" do
-      expect(InfluxDB::Rails.client).not_to receive(:write_point)
-      get "/widgets"
-    end
-  end
-
-  describe "for an ignored user agent" do
-    it "should not make an HTTP call to the API" do
-      expect(InfluxDB::Rails.client).not_to receive(:write_point)
-
-      # note: GoogleBot is ignored by default
-      if Rails::VERSION::MAJOR >= 5
-        get "/widgets/new", headers: { "HTTP_USER_AGENT" => "GoogleBot/2.1" }
-      else
-        get "/widgets/new", {}, "HTTP_USER_AGENT" => "GoogleBot/2.1"
-      end
-    end
-  end
-end

data/spec/shared_examples/tags.rb

@@ -1,42 +0,0 @@
-require "spec_helper"
-
-RSpec.shared_examples_for "with additional tags" do |series_names|
-  context "when tags_middleware is overwritten" do
-    before do
-      allow(config).to receive(:tags_middleware).and_return(tags_middleware)
-    end
-
-    let(:tags_middleware) { ->(tags) { tags.merge(static: "value") } }
-
-    it "processes tags throught the middleware" do
-      tags = data[:tags].merge(static: "value")
-
-      series_names.each do |series_name|
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(series_name, include(tags: tags))
-      end
-
-      subject.call("unused", start, finish, "unused", payload)
-    end
-  end
-
-  context "when tags are set in the current context" do
-    let(:additional_tags) do
-      { another: :value }
-    end
-
-    after do
-      InfluxDB::Rails.current.reset
-    end
-
-    it "does include the tags" do
-      InfluxDB::Rails.current.tags = additional_tags
-      tags = data[:tags].merge(additional_tags)
-
-      series_names.each do |series_name|
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(series_name, include(tags: tags))
-      end
-
-      subject.call("unused", start, finish, "unused", payload)
-    end
-  end
-end

data/spec/unit/backtrace_spec.rb

@@ -1,85 +0,0 @@
-require "spec_helper"
-
-RSpec.describe InfluxDB::Rails::Backtrace do
-  before do
-    @raw_backtrace = [
-      "/var/www/current/app/models/foo.rb:10:in `bar'",
-      "/var/www/current/app/models/foo.rb:19:in `baz'",
-      "/var/www/current/app/models/foo.rb:32:in `<main>'"
-    ]
-
-    @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
-  end
-
-  it "should accept an exception into the initializer" do
-    expect(@backtrace.lines).not_to be_empty
-    expect(@backtrace.lines.count).to eq(3)
-  end
-
-  it "should correctly parse lines into their elements" do
-    line = @backtrace.lines.first
-
-    expect(line.file).to eq("/var/www/current/app/models/foo.rb")
-    expect(line.number).to eq("10")
-    expect(line.method).to eq("bar")
-  end
-
-  describe "#to_a" do
-    it "should return an array of lines" do
-      expect(@backtrace.to_a.is_a?(Array)).to be_truthy
-    end
-  end
-
-  context "nil backtrace" do
-    before do
-      @raw_backtrace = nil
-      @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
-    end
-
-    it "should accept an exception into the initializer" do
-      expect(@backtrace.lines).to be_empty
-      expect(@backtrace.lines.count).to eq(0)
-    end
-
-    describe "#to_a" do
-      it "should return an array of lines" do
-        expect(@backtrace.to_a.is_a?(Array)).to be_truthy
-      end
-    end
-  end
-
-  describe "backtrace filters" do
-    before do
-      InfluxDB::Rails.configure do |config|
-        config.application_root = "/var/www/current"
-      end
-    end
-
-    it "should apply a single default backtrace filter correctly" do
-      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
-
-      line = filtered_backtrace.lines.first
-      expect(line.file).to eq("[APP_ROOT]/app/models/foo.rb")
-    end
-
-    it "should all default backtrace filters correctly" do
-      extended_backtrace = @raw_backtrace.dup
-      extended_backtrace << "#{Gem.path.first}/lib/foo_gem.rb:1:in `blah'"
-
-      filtered_backtrace = InfluxDB::Rails::Backtrace.new(extended_backtrace)
-      expect(filtered_backtrace.lines.first.file).to eq("[APP_ROOT]/app/models/foo.rb")
-      expect(filtered_backtrace.lines.last.file).to eq("[GEM_ROOT]/lib/foo_gem.rb")
-    end
-
-    it "should allow the addition of custom backtrace filters" do
-      InfluxDB::Rails.configure do |config|
-        config.backtrace_filters << ->(line) { line.gsub(/foo/, "F00") }
-      end
-
-      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
-
-      line = filtered_backtrace.lines.first
-      expect(line.file).to eq("[APP_ROOT]/app/models/F00.rb")
-    end
-  end
-end

data/spec/unit/exception_presenter_spec.rb

@@ -1,23 +0,0 @@
-require "spec_helper"
-
-RSpec.describe InfluxDB::Rails::ExceptionPresenter do
-  before do
-    begin
-      1 / 0
-    rescue ZeroDivisionError => e
-      @exception = e
-    end
-  end
-
-  describe ".new" do
-    it "should create a new ExceptionPresenter" do
-      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
-      expect(exception_presenter).to be_a(InfluxDB::Rails::ExceptionPresenter)
-    end
-
-    it "should accept an exception as a parameter" do
-      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
-      expect(exception_presenter).not_to be_nil
-    end
-  end
-end