canary/README.adoc

977 B
Raw Permalink Blame History

<html lang="en"> <head> </head>

Canary

Build Status
Grace

Canary is the service providing public status and information for Code Valet.

Goals

  1. Provide live-visibility for Jenkins developers into warnings/errors from Code Valet.

  2. Give Code Valet users insight into the status of the service.

  3. Provide Code Valet administrators with a centralized dashboard for service health.

Hacking

This application requires a Sentry API token to be defined in the environment as SENTRY_API_TOKEN or else it simply wont work properly.

Once that environment variable has been defined, executing make run on a Docker-capable machine should bring Canary online at localhost:9292.

</html>