sapience 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85f907c18a21df4ca3ef9505ee38c1bb7509c4a0
-  data.tar.gz: 1fa7b7505c45f0934153d3765a5f1721718ad582
+  metadata.gz: 7af7111709b92aaa1a65d94c9f8033c75bec80ad
+  data.tar.gz: 5de17972d7e7c4c6dd0ff51501df9a67a417df8d
 SHA512:
-  metadata.gz: db0ebb6ef294981e68d284afc2902c5455879b4edeb681f09eabd365661fc713907aa869e9578d9079c03923a9e0f64c148a71f8a04038d43c307017135c1873
-  data.tar.gz: 6cc66a7b88e17131b6e1d2f2b42f3395efe4e269a554b5f799bd5856db8ec0d00e55349b8c112b668aee0ae4f621a1ca8ecabd96bae3c3cd4fac788385583ebf
+  metadata.gz: fa1e5cffa6779704c9521b987ad85499d728537162f2eb4a7fa098436380929ee5c56fa392d660447001c0008856decbf30778c745b2dc4d9d36cb667a663776
+  data.tar.gz: 47c9b58310c9777e2746138c4037b4ee1f42cb52e49f8910028b526ee166a9940d42d1137240bfe8a469593d39364961fb0c1d9965ab6ec3c00d03503acd5f04

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v2.1.0
+
+- Add `Sapience::ErrorHandler:Sentry#capture`
+- Add `Sapience::ErrorHandler:Sentry#capture!`
+
 ## v2.0.5
 
 - Add "flush" as an instance method in logger.

data/docs/metrics.md

@@ -9,7 +9,7 @@ You can configure datadog through "sapience.yml", using the "metrics" section sh
 ```yml
 production:
   log_level: info
- 
+
   metrics:
     datadog:
       url: <%= ENV.fetch("STATSD_URL", "udp://localhost:8125") %>
@@ -22,7 +22,7 @@ Sapience.metrics = { datadog: { url: ENV["STATSD_URL"] } }
 
 Of course, whatever url you use (like for example "udp://localhost:8125"), make sure you have launched the Datadog agent listening to that host and url. See how to install a Datadog agent in the [Datadog Agent Documentation](http://docs.datadoghq.com/guides/basic_agent_usage/).
 
-Then you can send error metrics to Datadog using  the following methods:
+Then you can send metrics to Datadog using  the following methods:
 ```ruby
 timing(metric, duration = 0, options = {})
 increment(metric, options = {})
@@ -38,14 +38,50 @@ event(title, text, options = {})
 As in the examples below:
 ```ruby
 metrics = Sapience.metrics
-metrics.timing("company/project/metric-name", 100)
-metrics.increment("company/project/metric-name", 10)
-metrics.decrement("company/project/metric-name", 5)
-metrics.histogram("company/project/metric-name", 2_500)
-metrics.gauge("company/project/metric-name", 1_000, {})
-metrics.event("company/project/metric-name", "description about event", {})
+metrics.timing("metric-key", 100)
+metrics.increment("metric-key")
+metrics.decrement("metric-key")
+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.batch do
-  metrics.event("company/project/metric-name", "description about event", {})
-  metrics.increment("company/project/another-metric-name", 2)
+  metrics.event("metric-key", "description about event", {})
+  metrics.increment("another-metric-key", 2)
 end
-```
+```
+
+### Metric keys and tags
+
+The metric key argument used in all tracking methods can be arbitrary string however we recommend to use combination of names
+identifying component of your system joined by dots. All the metric keys are automatically prefixed with `app_name.environment`.
+
+We use two different schema for key that can be combined in one app:
+
+#### Fully specified key
+
+```
+app_name.environment.module.(component)*.event
+```
+
+The key fully identify the source of event and is useful in cases where you don't need to aggregate events
+occurred in one component, module or whole app. Example:
+
+```ruby
+metrics.increment('authentication.sign_in') # full key: booking_app.production.authentication.sign_in
+```
+
+#### Partially specified key in combination with tags
+
+```
+key: app_name.environment.event_type
+tags: event:name, module:name, component:name
+```
+
+The key itself doesn't identify the source of tracked event and is useful in cases where you want to aggregate events
+occurred in one component, module or whole app. It's handy for event types that can occur in all modules of an app.
+We use it mainly for error metrics. Example:
+
+```ruby
+metrics.increment('error', tags: %w(error_class:AccessDenied module:authentication component:permissions))
+```

data/lib/sapience/error_handler/sentry.rb

@@ -37,13 +37,22 @@ module Sapience
       end
 
       def capture_exception(exception, payload = {})
-        capture(exception, payload)
+        capture_type(exception, payload)
       end
 
       def capture_message(message, payload = {})
-        capture(message, payload)
+        capture_type(message, payload)
       end
 
+      def user_context(options = {})
+        Raven.user_context(options)
+      end
+
+      def tags_context(options = {})
+        Raven.tags_context(options)
+      end
+      alias_method :tags=, :tags_context
+
       def configured?
         @configured == true
       end
@@ -58,9 +67,42 @@ module Sapience
         @configured = true
       end
 
+      # Capture, process and reraise any exceptions from the given block.
+      #
+      # @example
+      #   Raven.capture do
+      #     MyApp.run
+      #   end
+      def capture!(options = {})
+        fail ArgumentError unless block_given?
+
+        begin
+          yield
+        rescue StandardError => e
+          capture_type(e, options)
+          raise
+        end
+      end
+
+      # Capture, process and not reraise any exceptions from the given block.
+      #
+      # @example
+      #   Raven.capture do
+      #     MyApp.run
+      #   end
+      def capture(options = {})
+        fail ArgumentError unless block_given?
+
+        begin
+          yield
+        rescue StandardError => e
+          capture_type(e, options)
+        end
+      end
+
       private
 
-      def capture(data, payload)
+      def capture_type(data, payload)
         return false unless valid?
         configure_sentry
 

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "2.0.5"
+  VERSION = "2.1.0"
 end

data/sapience.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Hasslefree autoconfiguration for logging, metrics and exception collection."
   spec.description   = "Hasslefree autoconfiguration for logging, metrics and exception collection."
-  spec.homepage      = "https://github.com/reevoo/sapience"
+  spec.homepage      = "https://github.com/reevoo/sapience-rb"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -365,7 +365,7 @@ files:
 - lib/sapience/version.rb
 - lib/tasks/coverage.rake
 - sapience.gemspec
-homepage: https://github.com/reevoo/sapience
+homepage: https://github.com/reevoo/sapience-rb
 licenses:
 - MIT
 metadata: