rorvswild 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa8ad571e7bfbc2e32974d05a6a59b2b5c97d78
-  data.tar.gz: 2e776641780937e3f20905ca04f512ff8975e2cb
+  metadata.gz: 866713e4d2ad9b6e923ad8c3f79956191003b5b3
+  data.tar.gz: 4e9cc4c5fb4aab0b795775ecf169263f5ceec711
 SHA512:
-  metadata.gz: 69731604ed10210a7fcc55f1d8e1e87743038065567ab4bb65dc2b17be7657be9dc8fda8758e90988788c76a3cd07ad60b45cdc6d98b6a912bb8f8466d0d1605
-  data.tar.gz: 87a73a718cfa90314e797b77d30e40c7eb4a8a2cf6e1a03826874e6ccc1c401849e8592d7856e6c8e89cd91892b4954188343ebde66cb6b9fd2f68684c4e621e
+  metadata.gz: 6d4b4e2f4e07bb9a60e57a5761ee3bc0673131a259b6feec00df78291eb06d2279da5badced799861eb7c40188daa91c6a3a97a3de0bde3777fbcd0aaa4cc74e
+  data.tar.gz: d6a7be8a7e745141cd7681455aadfe695c290bedb73ef1644552684a3f6845037ad66b18932fdf042444802bda498f2f85c247bdd476971f452a478f02e91420

data/README.md

@@ -120,15 +120,17 @@ RorVsWild.record_error(exception, {something: "important"})
 RorVsWild.catch_error(something: "important") { 1 / 0 }
 ```
 
-#### Ignore exceptions
+#### Ignore endpoints and exceptions
 
-By using the ignored_exceptions parameter you can prevent *RoRvsWild* from recording specific exceptions.
+By using `ignore_actions` you can prevent from tracking specific endpoints. In the same idea you can prevent from recording specific exceptions with the `ignore_exceptions` config.
 
 ```yaml
 # config/rorvswild.yml
 production:
   api_key: API_KEY
-  ignored_exceptions:
+  ignore_actions:
+    - SecretController#index
+  ignore_exceptions:
     - ActionController::RoutingError
     - ZeroDivisionError
 ```
@@ -137,7 +139,8 @@ production:
 # config/initializers/rorvswild.rb
 RorVsWild.start(
   api_key: "API_KEY",
-  ignored_exceptions: ["ActionController::RoutingError", "ZeroDivisionError"])
+  ignore_actions: ["SecretController#index"],
+  ignore_exceptions: ["ActionController::RoutingError", "ZeroDivisionError"])
 ```
 
 By default ActionController::RoutingError is ignored in order to not be flooded with 404.

data/lib/rorvswild/agent.rb

@@ -7,32 +7,33 @@ module RorVsWild
     def self.default_config
       {
         api_url: "https://www.rorvswild.com/api/v1",
-        ignored_exceptions: [],
+        ignore_exceptions: default_ignored_exceptions,
+        ignore_actions: [],
       }
     end
 
-    attr_reader :api_url, :api_key, :app_id, :app_root, :ignored_exceptions
+    def self.default_ignored_exceptions
+      if defined?(Rails)
+        %w[ActionController::RoutingError] + Rails.application.config.action_dispatch.rescue_responses.map { |(key,value)| key }
+      else
+        []
+      end
+    end
 
-    attr_reader :app_root_regex, :client, :queue
+    attr_reader :config, :app_root, :app_root_regex, :client, :queue
 
     def initialize(config)
-      config = self.class.default_config.merge(config)
-      @ignored_exceptions = config[:ignored_exceptions]
-      @app_root = config[:app_root]
-      @client = Client.new(config)
+      @config = self.class.default_config.merge(config)
+      @client = Client.new(@config)
       @queue = config[:queue] || Queue.new(client)
-      cleanup_data
-
-      if defined?(Rails)
-        @app_root ||= Rails.root.to_s
-        config = Rails.application.config
-        @ignored_exceptions ||= %w[ActionController::RoutingError] + config.action_dispatch.rescue_responses.map { |(key,value)| key }
-      end
 
+      @app_root = config[:app_root]
+      @app_root ||= Rails.root.to_s if defined?(Rails)
       @app_root_regex = app_root ? /\A#{app_root}/ : nil
 
       RorVsWild.logger.info("Start RorVsWild #{RorVsWild::VERSION} from #{app_root}")
       setup_plugins
+      cleanup_data
     end
 
     def setup_plugins
@@ -134,6 +135,10 @@ module RorVsWild
       end
     end
 
+    def ignored_action?(name)
+      config[:ignore_actions].include?(name)
+    end
+
     #######################
     ### Private methods ###
     #######################
@@ -178,7 +183,7 @@ module RorVsWild
     end
 
     def ignored_exception?(exception)
-      ignored_exceptions.include?(exception.class.to_s)
+      (config[:ignored_exceptions] || config[:ignore_exceptions]).include?(exception.class.to_s)
     end
   end
 end

data/lib/rorvswild/installer.rb

@@ -19,9 +19,10 @@ module RorVsWild
       <<YAML
 production:
   api_key: #{api_key}
-  # ignored_exceptions:
-  #   - ActionController::RoutingError
-  #   - UncommentToIgnoreAnyExceptionNameListedHere
+  ignore_actions: # Do not track following endpoints
+    # - SecretController#index
+  ignore_exceptions: # Do not track following exceptions
+    # - ActionController::RoutingError
 YAML
     end
   end

data/lib/rorvswild/local/middleware.rb

@@ -14,8 +14,8 @@ module RorVsWild
       end
 
       def standalone_profiler(env)
-        html = "<!DOCTYPE html>\n<html><head></head><body></body></html>"
-        [200, {"Content-Type:" => "text/html; charset=utf-8"}, StringIO.new(inject_into(html))]
+        html = inject_into(empty_html_page)
+        [200, {"Content-Type:" => "text/html; charset=utf-8"}, StringIO.new(html || empty_html_page)]
       end
 
       def embed_profiler(env)
@@ -44,6 +44,7 @@ module RorVsWild
         html
       rescue Encoding::UndefinedConversionError => ex
         log_incompatible_encoding_warning(ex)
+        nil
       end
 
       LOCAL_FOLDER = File.expand_path(File.dirname(__FILE__))
@@ -69,6 +70,10 @@ module RorVsWild
         files.map { |file| File.read(File.join(directory, file)) }.join("\n")
       end
 
+      def empty_html_page
+        "<!DOCTYPE html>\n<html><head></head><body></body></html>"
+      end
+
       def log_incompatible_middleware_warning
         RorVsWild.logger.warn("RorVsWild::Local cannot be embeded into your HTML page because of compression." +
           " Try to disable Rack::Deflater in development only." +

data/lib/rorvswild/plugin/action_controller.rb

@@ -35,8 +35,9 @@ module RorVsWild
 
       # Payload: controller, action, params, format, method, path
       def start(name, id, payload)
-        name = "#{payload[:controller]}##{payload[:action]}"
-        RorVsWild.agent.start_request(name: name, path: payload[:path])
+        if !RorVsWild.agent.ignored_action?(name = "#{payload[:controller]}##{payload[:action]}")
+          RorVsWild.agent.start_request(name: name, path: payload[:path])
+        end
       end
 
       def finish(name, id, payload)

data/lib/rorvswild/plugin/elasticsearch.rb

@@ -8,11 +8,11 @@ module RorVsWild
         ::Elasticsearch::Transport::Client.class_eval do
           alias_method :perform_request_without_rorvswild, :perform_request
 
-          def perform_request(method, path, params={}, body=nil)
+          def perform_request(*args)
             RorVsWild::Plugin::NetHttp.ignore do
-              command = {method: method, path: path, params: params, body: body}.to_json
+              command = {method: args[0], path: args[1], params: args[2], body: args[3]}.to_json
               RorVsWild.agent.measure_section(command, kind: "elasticsearch") do
-                perform_request_without_rorvswild(method, path, params, body)
+                perform_request_without_rorvswild(*args)
               end
             end
           end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.3.5".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexis Bernard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Performances and quality insights for rails developers.
 email: