lib/heartcheck/generators/templates/config.rb in heartcheck-1.3.0 vs lib/heartcheck/generators/templates/config.rb in heartcheck-1.4.0
- old
+ new
@@ -12,18 +12,21 @@
# Checks
# For each check you can set the folling options
# name: String => root name to show in report page (default: class.name)
# functional: Boolean => When is false your check is essential to your application (default: false)
+ # doc_url: String => To provide more details about the failure (optional)
+ # (default: nil)
# on_error: Block => to customize the errors (default: nil)
# to_validate: Block => to validate the sevices (default: nil)
#
# See the exemple bellow to undertand how you can configure it.
#
# monitor.add :base do |c|
# c.name = "filesystem"
# c.functional = true
# c.add_service(name: "my_file", path: "/var/www/my_project/my_file")
+ # c.doc_url = 'http://docs.com/monitoring#check-filesystem'
#
# c.on_error do |sevices|
# errors << "Custom error message for #{service[:name]}"
# end
#