govuk_app_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 392722d9260ccaa86d8c644cc18c744f68fff73e
-  data.tar.gz: 1ac8c30697b380b69c1650afa4867240409a433a
+  metadata.gz: '089341e237b45993c1de26ae8fcc53b765c37f1f'
+  data.tar.gz: '096f6ff793400709eaf33bd73efcacb0068896d0'
 SHA512:
-  metadata.gz: 2a6386a6e6283f987a671948f2ddbfd69662f18fd4df1f974a5ed5f4578e8e3901859920d9ff1ddc5e3770bb5826c445624da644715b1ac5bd711b2ad942c954
-  data.tar.gz: c33474d08b24146bf1c47f364d74b7c43cb93fcc29abbecdde830d0c927b4d3308c52797d18153d1fb48e9eac2c89f1845189acb7cd69d07ca4c6d39018c791c
+  metadata.gz: 84d313cb9e2ae553f7a87184578b7cb6946e963cd132614736c0b9e4ad7b49e37e2602bbf14cf3723ce3fb1a3b59e9cedf440a9077859edbbccc42284dc062bc
+  data.tar.gz: 5e00d1dee3208dd26ddec7046f6bf7ab3049c840bb5975a9ffd49ad7f43a1753d1f5304337cbc3b32786f788b6a115590a5f2e7e2799d7a17fcdc6b5632229da

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+spec/examples.txt

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.2.0
+
+* First actual release with support for Sentry
+
+## 0.1.0
+
+Empty gem.

data/README.md

@@ -14,6 +14,47 @@ And then execute:
 
 ## Usage
 
+### Automatic error reporting
+
+If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanism will make sure that your application is configured to send errors Sentry.
+
+If you use the gem outside of Rails you'll have to explicitly require it:
+
+```rb
+require 'govuk_app_config/configure'
+```
+
+Your app will have to have the following environment variables set:
+
+- `SENTRY_DSN` - the [Data Source Name (DSN)][dsn] for Sentry
+- `SENTRY_CURRENT_ENV` - production, staging or integration
+- `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name`
+
+[dsn]: https://docs.sentry.io/quickstart/#about-the-dsn
+
+### Manual error reporting
+
+Report something to Sentry manually:
+
+```rb
+GovukError.notify("Something went terribly wrong")
+```
+
+```rb
+GovukError.notify(ArgumentError.new("Or some exception object"))
+```
+
+Extra parameters are:
+
+```rb
+GovukError.notify(
+  "Oops",
+  extra: { offending_content_id: '123' }, # Additional context for this event. Must be a hash. Children can be any native JSON type.
+  level: 'debug', # debug, info, warning, error, fatal
+  tags: { key: 'value' } # Tags to index with this event. Must be a mapping of strings.
+)
+```
+
 ## License
 
 [MIT License][LICENSE.md]

data/govuk_app_config.gemspec

@@ -21,7 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "statsd-ruby", "~> 1.4.0"
+  spec.add_dependency "sentry-raven", "~> 2.6.3"
+
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.6.0"
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config.rb

@@ -1,4 +1,4 @@
 require "govuk_app_config/version"
-
-module GovukAppConfig
-end
+require "govuk_app_config/govuk_statsd"
+require "govuk_app_config/govuk_error"
+require "govuk_app_config/configure"

data/lib/govuk_app_config/configure.rb

@@ -0,0 +1,24 @@
+if defined?(Airbrake)
+  raise "This gem isn't compatible with Airbrake. Please remove it from the Gemfile."
+end
+
+Raven.configure do |config|
+  # We need this until https://github.com/getsentry/raven-ruby/pull/736 is released
+  config.current_environment = ENV["SENTRY_CURRENT_ENV"]
+
+  # We're misusing the `should_capture` block here to hook into raven until
+  # there's a better way: https://github.com/getsentry/raven-ruby/pull/750
+  config.should_capture = Proc.new {
+    GovukStatsd.increment("errors_occurred")
+
+    # For backwards compatibility
+    GovukStatsd.increment("errbit.errors_occurred")
+
+    # Return true so that we don't accidentally skip the error
+    true
+  }
+
+  config.transport_failure_callback = Proc.new {
+    GovukStatsd.increment("error_reports_failed")
+  }
+end

data/lib/govuk_app_config/govuk_error.rb

@@ -0,0 +1,13 @@
+require "sentry-raven"
+require "govuk_app_config/govuk_statsd"
+
+module GovukError
+  def self.notify(exception_or_message, args = {})
+    # Allow users to use `parameters` as a key like the Airbrake
+    # client, allowing easy upgrades.
+    args[:extra] ||= {}
+    args[:extra].merge!(parameters: args.delete(:parameters))
+
+    Raven.capture_exception(exception_or_message, args)
+  end
+end

data/lib/govuk_app_config/govuk_statsd.rb

@@ -0,0 +1,15 @@
+require "statsd"
+
+module GovukStatsd
+  def self.increment(*args)
+    client.increment(*args)
+  end
+
+  def self.client
+    @statsd_client ||= begin
+      statsd_client = ::Statsd.new("localhost")
+      statsd_client.namespace = ENV["GOVUK_STATSD_PREFIX"].to_s
+      statsd_client
+    end
+  end
+end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: webmock
+  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'
 description: Base configuration for GOV.UK applications
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -62,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Jenkinsfile
 - LICENSE.md
@@ -71,6 +128,9 @@ files:
 - bin/setup
 - govuk_app_config.gemspec
 - lib/govuk_app_config.rb
+- lib/govuk_app_config/configure.rb
+- lib/govuk_app_config/govuk_error.rb
+- lib/govuk_app_config/govuk_statsd.rb
 - lib/govuk_app_config/version.rb
 homepage: https://github.com/alphagov/govuk_app_config
 licenses: