Foursight

A serverless chalice application to monitor and run tasks on Fourfront. Essentially, the app provides an number of endpoints to run checks, fetch results, dynamically create environments to check, and more.

Beta version

Foursight is under active development and features will likely change.

API Documentation

Foursight uses autodoc to generate documentation for both the core chalicelib and checks. You can find the autodocs in the Check Documentation files.

Foursight-core

For the rest of the documentation, see Foursight-core documentation.

Contents

• Getting Started
  • The big picture
  • Installing dependencies
  • Stages and environments
  • Creating a check
  • Creating a schedule
  • Adding checks to check_setup
  • Using the UI
  • Foursight API basics
• Foursight Checks
  • Quick reference for important check requirements
  • Attributes you can set on a check result
  • Our example check
  • Check setup
  • Check arguments
    • The ‘uuid’ key word argument
    • The ‘primary’ key word argument
    • The ‘queue_action’ key word argument
  • Handling exceptions in checks
  • Appending check results
  • Accessing previous/other check results
  • Running checks from the UI
  • Check setup
    • Quick reference to important check setup requirements
    • Dependencies
• Foursight Actions
  • Writing an action
    • Getting the check set up
    • The associated check
    • Writing the action
    • Linking the action to the check
    • Displaying action messages
    • Viewing action results
• Deploying Foursight
  • Automatic deployments
  • Running tests
• Foursight Environments
  • Anatomy of an environment
  • Dynamically creating environments
• ElasticSearch README
  • ES Mapping
  • ES Migration
  • ES Connection
• Development Notes
  • Running Tests Locally
  • Local Foursight
  • Updating CRON Mappings
• Development Tips
  • Overall process for adding, testing, and scheduling a brand new check
  • Testing tips
    • Manual testing of your check
    • Testing on the UI
    • Automated Check Testing
    • Manual testing of your action
    • Manual testing of your schedule
    • Some other testing notes
    • Scheduling your checks
    • Setting up a schedule for manual checks
• Check Documentation