govuk_app_config 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4791548002b6883ab4483008296f2df6a8151865
-  data.tar.gz: 1dcbcb6a7e6790cb555ca4f776266667a94183aa
+  metadata.gz: 7c1aa04a3723ed9121a0a5396efcde54f888c923
+  data.tar.gz: 6d8e1e534ed8f3969ac2aa9f59ea575572d45ae7
 SHA512:
-  metadata.gz: 8ebacb7a67fa6da41352fce27f2331b5ecf26244bf0a14525d4de17d478282a4b3a73f72b54bc1a308064ef0abbf57967640a6c5748cda254f7de9b899606d63
-  data.tar.gz: dfe3d0ff930dbe2e2073e3fed0d925635f00d1002410d7385d05b4c02552b5a1e52baae6c5719fab2d3a485fe38efed16d805772c05726a5819aee368d47ad5d
+  metadata.gz: 171cf7e15d152cbc6675be11cdd076f3e741588a9d6459455c4fddab83e00d76d754fa04630944fd39dbeb2962f94dbb4ce75fa6ecfd5aa7a561c179ad1eddd7
+  data.tar.gz: 95b2fe9fe50983cb1c687d52b1b2d7c98d303e0a6e0708b2753106739eb3619e28520b5d2c7b90cc40b48c78f0d1bd32fa42c113daac47ca0b4c6598bc99071a

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.4.2

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-# Changelog
+# 1.0.0
+
+* Add Unicorn (our web server) as a dependency
+* Use version [2.7.0 of the Sentry client][sentry-270].
+* Set up logging configuration for Rails applications.
+* Don't send `ActionController::BadRequest`
 to Sentry
+
+[sentry-270]: https://github.com/getsentry/raven-ruby/commit/ef623824cb0a8a2f60be5fb7e12f80454da54fd7
+
+### How to upgrade
+
+* Remove `gem 'unicorn'` from your Gemfile
+* Remove `gem 'logstasher'` from your Gemfile
+* Remove all `config.logstasher.*` configs from `config/production.rb`
 
 ## 0.3.0
 

data/README.md

@@ -1,5 +1,11 @@
 # GOV.UK Config
 
+Adds the basics of a GOV.UK application:
+
+- Unicorn as a web server
+- Error reporting with Sentry
+- Statsd client for reporting stats
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,6 +20,12 @@ And then execute:
 
 ## Usage
 
+## Unicorn
+
+No configuration required.
+
+## Error reporting
+
 ### 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 to Sentry.

data/govuk_app_config.gemspec

@@ -22,7 +22,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "statsd-ruby", "~> 1.4.0"
-  spec.add_dependency "sentry-raven", "~> 2.6.3"
+  spec.add_dependency "logstasher", "~> 1.2.2"
+  spec.add_dependency "sentry-raven", "~> 2.7.1"
+  spec.add_dependency "unicorn", "~> 5.3.1"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/govuk_app_config.rb

@@ -1,4 +1,6 @@
 require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
+require "govuk_app_config/govuk_logging"
 require "govuk_app_config/configure"
+require "govuk_app_config/railtie" if defined?(Rails)

data/lib/govuk_app_config/configure.rb

@@ -3,9 +3,6 @@ if defined?(Airbrake)
 end
 
 GovukError.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 {
@@ -18,6 +15,19 @@ GovukError.configure do |config|
     true
   }
 
+  config.excluded_exceptions = [
+    'AbstractController::ActionNotFound',
+    'ActionController::BadRequest',
+    'ActionController::InvalidAuthenticityToken',
+    'ActionController::RoutingError',
+    'ActionController::UnknownAction',
+    'ActiveJob::DeserializationError',
+    'ActiveRecord::RecordNotFound',
+    'CGI::Session::CookieStore::TamperedWithCookie',
+    'Mongoid::Errors::DocumentNotFound',
+    'Sinatra::NotFound',
+  ]
+
   config.transport_failure_callback = Proc.new {
     GovukStatsd.increment("error_reports_failed")
   }

data/lib/govuk_app_config/govuk_logging.rb

@@ -0,0 +1,52 @@
+# Rails applications have 2 outputs types:
+#
+# 1) Structured logging statements like the ones we create with
+# `Rails.logger.info` and Rails request logging, which we do with the logstasher
+# gem. These logs are output in JSON and can be read easily by our logging
+# stack.
+#
+# 2) The second are logs that are outputted when an exception occurs or `puts`
+# is used directly. This is unstructured text. Often this logging is sent to
+# STDOUT directly.
+#
+# We want to differentiate between the two types. To do this, we direct all log
+# statements that would _normally_ go to STDOUT to STDERR. This frees up the "real
+# stdout" for use by our loggers.
+$real_stdout = $stdout.clone
+$stdout.reopen($stderr)
+
+require 'logstasher'
+
+module GovukLogging
+  def self.configure
+    # Send Rails' logs to STDERR because they're not JSON formatted.
+    Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr))
+
+    # Custom that will be added to the Rails request logs
+    LogStasher.add_custom_fields do |fields|
+      # Mirrors Nginx request logging, e.g GET /path/here HTTP/1.1
+      fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers["SERVER_PROTOCOL"]}"
+
+      # Pass request Id to logging
+      fields[:govuk_request_id] = request.headers["GOVUK-Request-Id"]
+
+      fields[:varnish_id] = request.headers["X-Varnish"]
+
+      fields[:govuk_app_config] = GovukAppConfig::VERSION
+    end
+
+    Rails.application.config.logstasher.enabled = true
+
+    # Log controller actions so that we can graph response times
+    Rails.application.config.logstasher.controller_enabled = true
+
+    # The other loggers are not that interesting in production
+    Rails.application.config.logstasher.mailer_enabled = false
+    Rails.application.config.logstasher.record_enabled = false
+    Rails.application.config.logstasher.view_enabled = false
+    Rails.application.config.logstasher.job_enabled = false
+
+    Rails.application.config.logstasher.logger = Logger.new($real_stdout)
+    Rails.application.config.logstasher.supress_app_log = true
+  end
+end

data/lib/govuk_app_config/railtie.rb

@@ -0,0 +1,7 @@
+module GovukAppConfig
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      GovukLogging.configure if Rails.env.production?
+    end
+  end
+end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -24,20 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: logstasher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: unicorn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: 5.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +158,9 @@ files:
 - lib/govuk_app_config.rb
 - lib/govuk_app_config/configure.rb
 - lib/govuk_app_config/govuk_error.rb
+- lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb
+- lib/govuk_app_config/railtie.rb
 - lib/govuk_app_config/version.rb
 homepage: https://github.com/alphagov/govuk_app_config
 licenses:
@@ -152,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications