This repository contains a Ruby script that consumes the various service/vender status feeds and posts corresponding alerts to a specified Slack channel as events occur. A Google Cloud Firestore database is used to track a little state to ensure duplicate updates aren't posted.

• Ensure that Ruby is installed
• Install Bundler using gem install bundler
• Install the RubyGems this script depends on using bundle install

The environment variables below are required:

FIRESTORE_PROJECT           # Name of the GCP project containing the Firestore project
SLACK_WEBHOOK               # Used for accessing the Slack Incoming Webhooks API
STATUS_ALERTS_SLACK_CHANNEL # Name of the Slack channel to post alerts to

The environment variable below is optional:

FIRESTORE_CREDENTIALS       # Path to the GCP service account JSON key (used when running locally)

Run the script using bundle exec ./cloud_status_alerter.rb.

Updates from a status feed source are implemented by providers, which are simply classes within the providers directory that conform to these rules:

• Provider classes must inherit from the Provider base class
• Provider class names must have an initial capital and then be all lower-case e.g. Github
• The provider class's initialize method must set the @icon and @name for use within the Slack message (the icon should be the name of a Slack emoji minus the surrounding colons)
• The provider class must implement a latest_update method that returns a populated StatusFeedUpdate struct. This struct contains the following fields:

Copyright (C) 2019–2020 Crown Copyright (Office for National Statistics)