2017-08-26 18:45:05 +00:00
|
|
|
= Canary
|
|
|
|
|
|
2017-12-19 16:53:33 +00:00
|
|
|
image::https://codevalet.codevalet.io/job/canary/job/master/badge/icon[Build Status, link=https://codevalet.codevalet.io/blue/organizations/jenkins/canary/activity]
|
2017-08-26 18:48:13 +00:00
|
|
|
|
2017-09-03 19:17:45 +00:00
|
|
|
image::https://github.com/codevalet/canary/raw/master/assets/images/songbird-128.png[Grace]
|
2017-08-26 18:45:05 +00:00
|
|
|
|
|
|
|
|
Canary is the service providing public status and information for
|
|
|
|
|
link:http://codevalet.io[Code Valet].
|
|
|
|
|
|
|
|
|
|
== Goals
|
|
|
|
|
|
|
|
|
|
. Provide live-visibility for link:https://jenkins.io[Jenkins] developers into
|
|
|
|
|
warnings/errors from Code Valet.
|
|
|
|
|
. Give Code Valet users insight into the status of the service.
|
|
|
|
|
. Provide Code Valet administrators with a centralized dashboard for service
|
|
|
|
|
health.
|
|
|
|
|
|
2017-09-03 19:43:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
== Hacking
|
|
|
|
|
|
|
|
|
|
This application requires a Sentry API token to be defined in the environment
|
|
|
|
|
as `SENTRY_API_TOKEN` or else it simply won't work properly.
|
|
|
|
|
|
|
|
|
|
Once that environment variable has been defined, executing `make run` on a
|
|
|
|
|
Docker-capable machine should bring Canary online at
|
|
|
|
|
link:http://localhost:9292/[localhost:9292].
|
