sapience 2.2.3 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e548f9ac78525b4bdc14737a9351027a4e61ad16
-  data.tar.gz: baf8e6f1ba2ba1d62fb94175568d60f84537a20f
+  metadata.gz: 45cf15c8cd01eccd3169eec6a03022ad719cb869
+  data.tar.gz: 554f7d8d2050b1700d8ad625a9ae9a0c3d891fa8
 SHA512:
-  metadata.gz: e87aff1fbda64a208ed11b4b5783977f68c3af0d4d1c7b3e409e746d6aaf41a6fe1617472cf8884565249da862e1a6c0635c7d3f7d6d3bd423c7c7bc4c417fc8
-  data.tar.gz: d9d0154a073a774a69b3666a2dd2a283ed07b6b1518d88c38dc88da89288df1fe21c2307a91a9d3180905519a7e7728d641b4fd5e65b64167f19cf9638ed5c3f
+  metadata.gz: 137cc64c62b9205a8cf0ee79f9268fe0393b95e6416455590f6487b96005e789dce97bc599aa0deb774652cecb98444a5fbf1e1fe2a9b48d6ed853d28630c9fd
+  data.tar.gz: ae743a5713cf3743f1e835c80b7838ea83299a6e51cd287d67f50486652f90af0d26cafd6d69b51fc44824cdca78782b285dade3f955b896f866fb900a08f058

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v2.3.3
+
+- Put back single_thread_executor and leave immediate_executor only for test environment
+
+
+## v2.3.2
+
+- Changing the log level of ActiveRecord has the side effect of changing the
+  log level of Rails.logger. We don't want that therefore we remove the
+  assignment.
+
+## v2.3.1
+
+- Add namespaced events
+
 ## v2.2.3
 
 - Set immediate_executor by default to avoid Errno::EIO error for multithreaded processes. 

data/README.md

@@ -104,7 +104,6 @@ Add a `config/sapience.yml` file to you appplication. Or if you, like us, have m
 default:
   app_name: My Application
   log_level: debug
-  log_level_active_record: info
   appenders:
     - stream:
         io: STDOUT
@@ -159,7 +158,6 @@ production:
 Sapience.configure(force: true) do |config|
   config.app_name = "My Application"
   config.default_level   = :info
-  config.log_level_active_record = :info
   config.backtrace_level = :error
   config.filter_parameters = %w(password password_confirmation)
   config.appenders       = [

data/config/default.yml

@@ -3,7 +3,7 @@ default:
   filter_parameters:
     - password
     - password_confirmation
-  log_executor: immediate_executor
+  log_executor: single_thread_executor
   log_level: info
   appenders:
     - stream:
@@ -12,6 +12,7 @@ default:
 
 test:
   log_level: warn
+  log_executor: immediate_executor
   appenders:
     - stream:
         file_name: log/test.log

data/docs/metrics.md

@@ -45,6 +45,7 @@ metrics.count("metric-key", -3)
 metrics.histogram("metric-key", 2_500)
 metrics.gauge("metric-key", 1_000, {})
 metrics.event("metric-key", "description about event", {})
+metrics.event("metric-key", "description about event", {namespace: true})
 metrics.batch do
   metrics.event("metric-key", "description about event", {})
   metrics.increment("another-metric-key", 2)
@@ -85,3 +86,24 @@ We use it mainly for error metrics. Example:
 ```ruby
 metrics.increment('error', tags: %w(error_class:AccessDenied module:authentication component:permissions))
 ```
+
+### Event Metric
+
+For the `event` metric the first parameter is `title` - string.
+By default it is not namespaced, however with option `namespace: true` it will automatically namespace it.  
+
+
+```ruby 
+metrics.event("metric-key", "description about event", {namespace: true})
+
+```
+Output: `app_name.environment.metric-key`
+
+#### Event Grouping
+
+In order to group similar events, use option: `aggregation_key`
+
+```ruby 
+metrics.event("metric-key", "description about event", {namespace: true, aggregation_key:true})
+
+```

data/lib/sapience/configuration.rb

@@ -4,14 +4,13 @@ module Sapience
 
   # rubocop:disable ClassVars
   class Configuration
-    attr_reader :default_level, :log_level_active_record, :backtrace_level, :backtrace_level_index
+    attr_reader :default_level, :backtrace_level, :backtrace_level_index
     attr_writer :host
     attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters, :metrics, :error_handler
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
       log_level:               :info,
-      log_level_active_record: :info,
       host:              nil,
       ap_options:        { multiline: false },
       appenders:         [{ stream: { io: STDOUT, formatter: :color } }],
@@ -28,7 +27,6 @@ module Sapience
       @options[:log_executor] &&= @options[:log_executor].to_sym
       validate_log_executor!(@options[:log_executor])
       self.default_level           = @options[:log_level].to_sym
-      self.log_level_active_record = @options[:log_level_active_record].to_sym
       self.backtrace_level   = @options[:log_level].to_sym
       self.host              = @options[:host]
       self.app_name          = @options[:app_name]
@@ -47,13 +45,6 @@ module Sapience
       @default_level_index = level_to_index(level)
     end
 
-    # Sets the active record log level
-    def log_level_active_record=(level)
-      @log_level_active_record = level
-      # For performance reasons pre-calculate the level index
-      @log_level_active_record_index = level_to_index(level)
-    end
-
     # Returns the symbolic level for the supplied level index
     def index_to_level(level_index)
       LEVELS[level_index]

data/lib/sapience/logger.rb

@@ -18,7 +18,7 @@ module Sapience
             logger.trace "Appender thread: Flushing appender: #{appender.class.name}"
             appender.flush
           rescue StandardError => exc
-            logger.error "Appender thread: Failed to flush appender: #{appender.inspect}", exc
+            $stderr.write("Appender thread: Failed to flush to appender: #{appender.inspect}\n #{exc.inspect}")
           end
         end
 

data/lib/sapience/metrics/datadog.rb

@@ -90,9 +90,48 @@ module Sapience
         provider.batch(&block)
       end
 
-      def event(title, text, options = {})
+      # Create Event
+      #
+      # @param [String] title the title of the event
+      # @param [String] text  the description
+      # @param [Hash] opts event options
+      # @option opts [Array] :namespaced_keys the keys we want to be namespaced. Valid: :title or :aggregation_key
+      # @option opts [String] :namespace_prefix custom namespace
+      #   (to override default from Sapience `app_name.environment`)
+      # @option opts [String] :aggregation_key custom aggregation_key
+      #   (to override default based on `title`, only applies when :aggregation_key includes in namespaced_keys option)
+      #
+      # @example Create an Event
+      #   Sapience.metrics.event('article-published', "article #123")
+      #
+      # @example Create a namespaced Event with default namespacing
+      #   Sapience.metrics.event('article-published', "article #123", {namespaced_keys: [:title, :aggregation_key]})
+      #
+      # @example Create a namespaced Event with custom namespacing
+      #   Sapience.metrics.event(
+      #     'article-published',
+      #     "article #123",
+      #     {namespace_prefix: 'custom_namespace',  namespaced_keys: [:title, :aggregation_key]}
+      #   )
+      #
+      # @example Create an Event with a custom aggregation_key
+      #   Sapience.metrics.event('article-published', "article #123", {aggregation_key: 'custom_aggregation_key')
+
+      def event(title, text = "", opts = {})
         return false unless valid?
-        provider.event(title, text, options)
+        fail ArgumentError "Title must be provided" unless title
+        opts ||= {}
+
+        namespaced_keys = opts.delete(:namespaced_keys) || []
+        namespace_prefix = opts.delete(:namespace_prefix) || namespace
+
+        if namespaced_keys.include?(:aggregation_key)
+          aggregation_key = opts[:aggregation_key] || title
+          opts[:aggregation_key] = "#{namespace_prefix}.#{aggregation_key}"
+        end
+
+        title = "#{namespace_prefix}.#{title}" if namespaced_keys.include?(:title)
+        provider.event(title, text, opts)
       end
 
       def namespace

data/lib/sapience/rails/engine.rb

@@ -72,12 +72,7 @@ module Sapience
         Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
         Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller
         # Sapience::Extensions::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer
-        if defined?(ActiveRecord)
-          Sapience::Extensions::ActiveRecord::Notifications.use
-          ActiveRecord::Base.logger.level =
-              Sapience.config.log_level_active_record if defined?(ActiveRecord::Base.logger.level)
-        end
-
+        Sapience::Extensions::ActiveRecord::Notifications.use if defined?(ActiveRecord)
         Sapience::Extensions::ActionView::LogSubscriber.attach_to :action_view
         # Sapience::Extensions::ActiveJob::LogSubscriber.attach_to :active_job
         Sapience::Extensions::ActionController::Notifications.use

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "2.2.3"
+  VERSION = "2.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.3
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby