rack-ecg 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e69b8b06f6e9447931c2dd5f6a709153fc05054
-  data.tar.gz: 7fd824b68af2e6db167af65b7518004c1c7aabce
+SHA256:
+  metadata.gz: 83d08e1fb5c31c7f5883cbf1b698b207ce837980d511f35f7d7c32300067d5c4
+  data.tar.gz: 88688776e3d95f7b040b0701d9955830bfa833c6ec44e8bcf6a1ce647a30d7a7
 SHA512:
-  metadata.gz: 80b858e5dbf7874a6db6d70361c7f8c5726b515113e3bece707c9c857ed70d0d14448ee640899433f7bc4206458cb418b23b03b66d72e32b18c2b5a347c2bcc8
-  data.tar.gz: 6fa5476c8cba27af405f0c648be87843d79c89f166328ca0b8b15368f3d8cb1b8c3fda15ddc0c850e8d5b66711635c1ca02193001e5cd514fe43074599f8582d
+  metadata.gz: d5c0db20e6bf5cfab2e64252ecce8d6f38a240d6356813929a134c8b1dc7fec25cb663b756230b9b81087fef1cef05c196be31258b699181b210a0c75877651b
+  data.tar.gz: e77ddb23c3b406fb3e51621364a38be99e3ef5fdb3a0fb91fb850fa21add92415a0e1e47539619fa5c148701eb076782d3de555ef63de15ec7286e48388e983e

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "19:00"

data/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: test
+
+on: [push,pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+    runs-on: ubuntu-latest
+    name: Test (Ruby ${{ matrix.ruby }})
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.3.7
+        bundle install
+        bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rack-ecg.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.9

data/.yardopts

@@ -0,0 +1 @@
+--files lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,84 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2022-02-21
+
+### Added
+
+- The `static` check, which uses the provided check parameters to return the same result every time.
+
+### Changed
+
+- **Breaking**: The Redis check now requires being configured with an instance of the Redis client, via the named `instance` parameter
+- **Deprecated**: The `git_revision` check will be removed in rack-ecg version 1.0.0. For a suggested replacement, [see the GitRevision Check Replacement example](./examples/gitrevision_check_replacement.ru), which uses the `static` check to memoize the value.
+
+### Removed
+
+- **Breaking:** Dropped support for Ruby versions < 2.6.0
+
+## [0.1.0] - 2020-12-16
+
+### Added
+
+- YARD-based gem documentation
+
+### Changed
+
+- **Breaking**: The Rack::ECG initializer now uses named options, instead of an options hash.
+
+  If you manually initialized an instance, you may need to use the `**` operator to pass these options. (e.g. `Rack::ECG.new(nil, **options)`)
+
+### Removed
+
+- **Breaking:** Dropped support for Ruby versions < 2.5.0
+
+## [0.0.5] - 2017-05-12
+
+### Added
+
+- A new `sequel` check (#8), which checks if the Sequel database connection is active.
+
+## [0.0.4] - 2017-05-04
+
+### Added
+
+- A new `active_record` check (#7), which checks if the ActiveRecord connection is active.
+- A new `redis` check (#7), which checks if the Redis connection is active.
+
+## [0.0.3] - 2017-02-13
+
+### Added
+
+- Accept a `hook` in configuration, which is run when all check results have been gathered (#6)
+
+### Fixed
+
+- Resolved an issue with the migration version check and MySQL connections (#3)
+
+## [0.0.2] - 2015-06-17
+
+### Added
+
+- Support running Rack::ECG as a standalone application
+- Support adding checks via the `CheckRegistry`
+
+## [0.0.1] - 2015-04-09
+
+### Added
+
+- Base middleware to use in Rails or Rack apps
+- `git_revision` check to return the current git revision
+- `migration_version` check to return the current ActiveRecord migration version
+
+[Unreleased]: https://github.com/envato/rack-ecg/compare/v0.2.0...HEAD
+[0.2.0]:      https://github.com/envato/rack-ecg/compare/v0.1.0...v0.2.0
+[0.1.0]:      https://github.com/envato/rack-ecg/compare/v0.0.5...v0.1.0
+[0.0.5]:      https://github.com/envato/rack-ecg/compare/v0.0.4...v0.0.5
+[0.0.4]:      https://github.com/envato/rack-ecg/compare/v0.0.3...v0.0.4
+[0.0.3]:      https://github.com/envato/rack-ecg/compare/v0.0.2...v0.0.3
+[0.0.2]:      https://github.com/envato/rack-ecg/compare/v0.0.1...v0.0.2
+[0.0.1]:      https://github.com/envato/rack-ecg/releases/tag/v0.0.1

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rack-ecg.gemspec
 gemspec

data/README.md

@@ -1,21 +1,23 @@
 # Rack::ECG
 
-An easy to configure Rack middleware for Ruby web apps to provide a simple
-health check endpoint that tells you vital life signs about your app. All
-without the boilerplate service checking code you've written 10 times before.
+[![Gem version](https://img.shields.io/gem/v/rack-ecg)][gem-page] [![Rubydoc](https://img.shields.io/badge/docs-rubydoc-success)][rubydoc]
 
-(it's ECG as in electrocardiogram - as in the machine that monitors how your
-heart works)
+Rack middleware for Ruby web apps, providing a simple and extensible health
+check endpoint, with minimal configuration.
+
+> Electrocardiogram (ECG): A recording of the electrical activity of the heart.
 
 ## Features
-- simple 1 line to drop into your `config.ru` or `config/application.rb` file to
-  set up
+
+- Start with a single line in your `config.ru` or `config/application.rb` file.
 - reports git revision status
 - reports ActiveRecord migration schema version
 - reports errors if any check can't be executed for whatever reason
 - JSON output
 
-## Development Status [![travis ci build](https://api.travis-ci.org/envato/rack-ecg.svg)](https://travis-ci.org/envato/rack-ecg)
+## Development Status
+
+[![Build Status](https://github.com/envato/rack-ecg/workflows/test/badge.svg?branch=main)](https://github.com/envato/rack-ecg/actions?query=branch%3Amain)
 
 `Rack::ECG` is extracted from production code in use at
 [Envato](http://envato.com). However, it is undergoing early development, and
@@ -23,23 +25,15 @@ APIs and features are almost certain to be in flux.
 
 ## Getting Started
 
-Add this line to your application's Gemfile:
+Add this to your application's `Gemfile`:
 
 ```ruby
-gem 'rack-ecg'
+gem 'rack-ecg', '~> 0.2.0`
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rack-ecg
+Then run `bundle install`.
 
-### Rails
-
-In Rails you can add `Rack::ECG` to your `config/application.rb` as a middleware
+In Rails you can add `Rack::ECG` to your `config/application.rb` as a middleware:
 
 ```ruby
 # config/application.rb
@@ -48,9 +42,7 @@ config.middleware.use Rack::ECG
 # ...
 ```
 
-### Rack
-
-In Rack apps, you can add `Rack::ECG` to your `config.ru`
+In Rack apps, you can add `Rack::ECG` to your `config.ru`:
 
 ```ruby
 # config.ru
@@ -61,6 +53,8 @@ use Rack::ECG
 run MyRackApp
 ```
 
+## Usage
+
 You can now hit your app and get a basic health check response from `Rack::ECG`
 
 ```
@@ -79,39 +73,149 @@ status if any of the checks fail.
 
 ## Configuration
 
-There are options that can be passed to `use Rack::ECG` to customise how it
-works.
+There are options that can be passed to `use Rack::ECG` to customise how it works.
 
-### `checks`
-Out of the box `Rack::ECG` doesn't do much and just checks that
-HTTP responses can be returned. There are a number of built in checks that
-`Rack::ECG` can be told to do (more to come)
-- `:git_revision` - this assumes your code is deployed via git and exists in a
-  git repo, and that the `git` command can access it
-- `:migration_version` - this assumes you are using ActiveRecord migrations. It
-  queries the `schema_versions` table and tells you what version the database is
-at.
+### Checks
 
-So using `git_revision` and `migration_version` would look like:
+By default, `Rack::ECG` indicates that the service is reponsive via a `http` check. Additional checks are included in this gem, and can be enabled by passing their configuration to the `checks` parameter. To enable a check, add its name, and optionally configuration, to the `checks` array:
 
 ```ruby
-use Rack::ECG, checks: [:git_revision, :migration_version]
+use Rack::ECG, checks: [
+  # no configuration required, or allowed
+  :http,
+  # passing configuration options
+  [:static, { name: "app", value: "my-cool-app" }],
+  # some checks can be used multiple times
+  [:static, { name: "env", value: Rails.env }],
+]
 ```
 
+#### `active_record`
+
+Requires a configured ActiveRecord connection. Does not support configuration. Indicates whether the connection to the default database is currently open. On success, returns something in the following format:
+
+```json
+{
+  "active_record": {
+    "status": "ok",
+    "value": true
+  }
+}
 ```
-$ curl http://localhost:9292/_ecg
+
+#### `error`
+
+Does not support configuration. Always returns the following:
+
+```json
+{
+  "error": {
+    "status": "error",
+    "value": "PC LOAD ERROR"
+  }
+}
+```
+
+#### `git_revision`
+
+**Deprecated**: will be removed in version 1.0.0. [See the GitRevision Check Replacement example](./examples/git_revision_check_replacement.ru), which uses the `static` check to memoize the value.
+
+Requires the `git` executable on path, and that the application's working directory is within a Git repository. Does not support configuration. On success, returns something in the following format:
+
+```json
+{
+  "git_revision": {
+    "status": "ok",
+    "value": "dc840f9d5563e6e5a8b34da29c298764e3046039"
+  }
+}
+```
+
+#### `http`
+
+Automatically included, and does not support configuration. Always returns the following:
+
+```json
 {
   "http": {
     "status": "ok",
     "value": "online"
-  },
-  "git_revision": {
-    "status": "ok",
-    "value": "fb16e2c3b88af671c42880e6977bba34d7b05ba6\n"
-  },
+  }
+}
+```
+
+#### `migration_version`
+
+Requires a configured ActiveRecord connection, and that ActiveRecord migrations are in use. Does not support configuration. Queries the `schema_versions` table on the default database to report the current migration version. On success, returns something in the following format:
+
+```json
+{
   "migration_version": {
     "status": "ok",
-    "value": "20150319050250"
+    "value": "20210506024055"
+  }
+}
+```
+
+#### `redis`
+
+Requires the Redis gem. Requires configuration, an instance of a Redis client. Indicates whether the Redis client passed in is currently connected to the Redis database. On success, returns something in the following format:
+
+```json
+{
+  "redis": {
+    "status": "ok",
+    "value": true
+  }
+}
+```
+
+#### `sequel`
+
+Requires the Sequel gem. Requires configuration, and can be configured multiple times. Indicates whether a (new) connection can be established to the configured Sequel database.
+
+Given the following configuration:
+
+```ruby
+{
+  connection: "sqlite://events.db",
+  name: "events", # must be unique per sequel check
+}
+```
+
+Returns the something in the following format on success:
+
+```json
+{
+  "sequel_events": {
+    "status": "ok",
+    "value": true
+  }
+}
+```
+
+#### `static`
+
+Returns the same value every time. Requires configuration, and can be configured multiple times.
+
+Given the following configuration:
+
+```ruby
+{
+  name: "image_build_url",               # must be unique per static check
+  success: true,                         # default value
+  status: Rack::ECG::Check::Status::OK,  # optional, overrides `success`
+  value: ENV["IMAGE_BUILD_URL"], 
+}
+```
+
+Returns the something in the following format:
+
+```json
+{
+  "image_build_url": {
+    "status": "ok",
+    "value": "https://example.com/pipelines/my-cool-app/builds/1234"
   }
 }
 ```
@@ -125,11 +229,23 @@ a different path by setting the `at` option. e.g.
 use Rack::ECG, at: "/health_check"
 ```
 
-More examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/master/examples)
+### `hook`
+
+The `hook` option takes a `Proc` or equivalent, and calls it after the checks
+have run, but before the response is complete.
+
+```ruby
+use Rack::ECG, hook: Proc.new { |success, _checks| puts "Is healthy? #{success}" }
+```
+
+- `success`: whether the response will indicate success
+- `checks`: an array of the check names and values
+
+More examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/main/examples)
 
 ## Requirements
-- Ruby >= 1.9.3 (this may be increased to Ruby >= 2.0 if it makes sense to use
-  Ruby 2.0 features)
+
+- Ruby >= 2.6
 - Rack
 - To use optional `git_revision` check, your deployed code needs to be in a git repo, and
 `git` command must be accessible on the server
@@ -145,24 +261,24 @@ migrations stored in `schema_versions` table
 
 ## Maintainers
 
-- [Tao Guo](https://github.com/taoza)
-- [Warren Seen](https://github.com/warrenseen)
+- [Liam Dawson](https://github.com/liamdawson)
 
-## Authors
+## Contributors
 
+- [Tao Guo](https://github.com/taoza)
 - [Julian Doherty](https://github.com/madlep)
 - [Warren Seen](https://github.com/warrenseen)
 
 ## License
 
 `Rack::ECG` uses MIT license. See
-[`LICENSE.txt`](https://github.com/envato/rack-ecg/blob/master/LICENSE.txt) for
+[`LICENSE.txt`](https://github.com/envato/rack-ecg/blob/main/LICENSE.txt) for
 details.
 
 ## Code of conduct
 
 We welcome contribution from everyone. Read more about it in
-[`CODE_OF_CONDUCT.md`](https://github.com/envato/rack-ecg/blob/master/CODE_OF_CONDUCT.md)
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/rack-ecg/blob/main/CODE_OF_CONDUCT.md)
 
 ## Contributing
 
@@ -178,7 +294,7 @@ For larger new features: Do everything as above, but first also make contact wit
 
 ## About
 
-This project is maintained by the [Envato engineering team][webuild] and funded by [Envato][envato]. 
+This project is maintained by the [Envato engineering team][webuild] and funded by [Envato][envato].
 
 [<img src="http://opensource.envato.com/images/envato-oss-readme-logo.png" alt="Envato logo">][envato]
 
@@ -188,3 +304,5 @@ Encouraging the use and creation of open source software is one of the ways we s
   [envato]: https://envato.com?utm_source=github
   [oss]: http://opensource.envato.com//?utm_source=github
   [careers]: http://careers.envato.com/?utm_source=github
+  [gem-page]: https://rubygems.org/gems/rack-ecg
+  [rubydoc]: https://www.rubydoc.info/gems/rack-ecg/

data/Rakefile

@@ -1,7 +1,17 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new
+
+task(default: [:rubocop, :spec, :yard])
 
-task :default => :spec
+task(:watch_docs) do
+  sh "yard server --reload"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rack-ecg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,18 @@
+# for running tests across different versions locally
+
+version: "3"
+services:
+  ruby30: &ruby30
+    image: ruby:3.0
+    volumes:
+      - ./:/app
+    command: bash -c 'gem update --system && cd /app && { ! [ -f Gemfile.lock ] || rm Gemfile.lock; } && bundle install && bundle exec rake'
+  ruby27:
+    <<: *ruby30
+    image: ruby:2.7
+  ruby26:
+    <<: *ruby30
+    image: ruby:2.6
+  ruby25:
+    <<: *ruby30
+    image: ruby:2.5

data/examples/basic.ru

@@ -1,5 +1,7 @@
-require 'rack/ecg'
+# frozen_string_literal: true
 
-use Rack::ECG
+require "rack/ecg"
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+use(Rack::ECG)
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/checks.ru

@@ -1,5 +1,7 @@
-require 'rack/ecg'
+# frozen_string_literal: true
 
-use Rack::ECG, checks: [:git_revision, :migration_version]
+require "rack/ecg"
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+use(Rack::ECG, checks: [:git_revision, :migration_version])
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/git_revision_check_replacement.ru

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rack/ecg"
+
+# This example behaves just like the deprecated GitRevision check, except that the value is memoized.
+#   i.e. "Fetching the git revision" shouldn't show up for every `GET /_ecg` request.
+#
+# Also consider writing the git revision to a file, or storing it in an environment variable, so it can found more
+# efficiently and with fewer dependencies.
+
+def git_revision
+  puts "Fetching the git revision"
+
+  _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
+
+  success = wait_thread.value.success?
+
+  status = success ? Rack::ECG::Check::Status::OK : Rack::ECG::Check::Status::ERROR
+
+  value = success ? stdout.read : stderr.read
+  value = value.strip
+
+  { name: :git_revision, status: status, value: value }
+end
+
+use(Rack::ECG, { checks: [[:static, git_revision]] })
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/hook.ru

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rack/ecg"
+
+log_check_results = proc do |success, checks|
+  next if success
+
+  checks.each do |check_name, check_status|
+    next unless check_status[:status] == "error"
+
+    puts "Check #{check_name} failed: #{check_status[:value]}"
+  end
+end
+
+use(Rack::ECG, checks: [:git_revision, :migration_version], hook: log_check_results)
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/mounted_path.ru

@@ -1,5 +1,7 @@
-require 'rack/ecg'
+# frozen_string_literal: true
 
-use Rack::ECG, at: "/health_check"
+require "rack/ecg"
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+use(Rack::ECG, at: "/health_check")
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/parameters.ru

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rack/ecg"
+require "sequel"
+require "sqlite3"
+
+use(Rack::ECG, checks: [
+  :http,
+  [:sequel, { connection: "sqlite://events.db", name: "events" }],
+  [:sequel, { connection: "sqlite://projections.db", name: "projections" }],
+])
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/stand_alone.ru

@@ -1,3 +1,5 @@
-require 'rack/ecg'
+# frozen_string_literal: true
 
-run Rack::ECG.new
+require "rack/ecg"
+
+run(Rack::ECG.new)