Check your applications' heart.
https://github.com/locaweb/heartcheck/wiki/Endpoint-Json
-
Include the gem in your Gemfile:
gem 'heartcheck'
-
Install the gem:
bundle install
-
Generate some required files according to the framework you are using:
heartcheck rails heartcheck padrino heartcheck sinatra
-
After that, follow the instructions, edit the generated files and restart your server.
-
Done! Now you are able to access
[host]/monitoring
and check the monitoring JSON!
[host]/monitoring
- To check if the app and its integrations are avaiable;
- Directed for verifying the app SLA;
[host]/monitoring/info
- To view some informations that you can configure;
- Directed for availability check from load balanced and get info about the installed app;
[host]/monitoring/functional
- To check if the app is healty (no async job failed and other checks that aren't related to app availability);
- Directed for verifying consistency problems within the app;
[host]/monitoring/dev
- Directed for the development team;
- It's run the essential and functional checks;
[host]/monitoring/health_check
- To check if the app is up and running
You can see how to use in template that is generated when install:
Don't forget to tag your work! After a merge request being accepted, run:
1 - (git tag -a "x.x.x" -m "") to create the new tag. 2 - (git push origin "x.x.x") to push the new tag to remote.
Follow the RubyGems conventions at http://docs.rubygems.org/read/chapter/7 to know how to increment the version number. Covered in more detail in http://semver.org/
Don't forget to write tests to all your code. It's very important to maintain the codebase's sanity. Any merge request that doesn't have enough test coverage will be asked a revision
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request