Skip to content

xav-b/sentinel

Repository files navigation

Only the paranoid will survice

Circle CI




Modern applications are mostly a composition of services that will eventually fail.

Sentinel is a framework to monitor and handle distributed infrastructures, like modern microservice topologies or complex applications.

Sentinels are composable bots you can launch to monitor your things, and forget until something goes wrong.

It is built out of of three components:

  • Configuration: declarative definition of stuff to monitor
  • Plugins:
    • Sensors: pluggable drivers to perform checks
    • Radios: pluggable services for alerting
    • Triggers: orchestrate sensors' measures
  • Core library glueing bullet points above in a neat lightweight cli package

It's written in Go to keep it super easy to deploy and elegant to implement multiple backends through interfaces.

The project is just getting started, don't expect anything to work at this point but contribution is welcome !

Deployment

local version=0.2.0
local platform=darwin-amd64

curl \
  -ksL \
  -o /usr/local/bin/sentinel \
  https://github.com/hackliff/sentinel/releases/download/${version}/sentinel-${platform}
chmod +x /usr/local/bin/sentinel

Doc is available online or you can build it locally :

make doc
open site/index.html

Go Package

Check it out on gowalker, godoc, or browse it locally:

$ make godoc
$ $BROWSER docker-dev:6060/pkg/github.com/hackliff/sentinel

Contributing

Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here =)

make build
make tests TESTARGS=-v

Conventions

sentinel follows some wide-accepted guidelines

Authors

Selfie Name Twitter
text Xavier Bruhiere @XavierBruhiere

Licence

Copyright 2015 Xavier Bruhiere.

Sentinel is available under the MIT Licence.


gopher

About

Temporary, dirty, exploratory sentinel rewrite draft

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages