Permalink
Fetching contributors…
Cannot retrieve contributors at this time
141 lines (120 sloc) 5.52 KB
init_config:
# Change default path of trusted certificates
# ca_certs: /etc/ssl/certs/ca-certificates.crt
instances:
- name: My first service
url: http://some.url.example.com
timeout: 1
# The default HTTP method is GET but the (optional) method parameter allows you to change the
# HTTP method to POST.
# If using the POST method, you can then specify the data to send in the body of the request
# with the data parameter.
# SOAP requests are supported if you use the POST method and supply an XML string as the data parameter.
#
# method: get
# data:
# key: value
# The (optional) content_match parameter will allow the check
# to look for a particular string within the response. The check
# will report as DOWN if the string is not found.
#
# content_match uses Python regular expressions which means that
# you will have to escape the following "special" characters with
# a backslash (\) if you're trying to match them in your content:
# . ^ $ * + ? { } [ ] \ | ( )
#
# Examples:
# content_match: 'In Stock'
# content_match: '^(Bread|Apples|Very small rocks|Cider|Gravy|Cherries|Mud|Churches|Lead) float(s)? in water'
# The (optional) reverse_content_match parameter will allow the content_match
# to work the other way around. That means that the check will report
# as DOWN if the string is found.
# reverse_content_match: false
# If your service uses basic authentication, you can optionally
# specify a username and password that will be used in the check.
#
# username: user
# password: pass
# The (optional) http_response_status_code parameter will instruct the check
# to look for a particular HTTP response status code or a Regex identifying
# a set of possible status codes.
# The check will report as DOWN if status code returned differs.
# This defaults to 1xx, 2xx and 3xx HTTP status code: (1|2|3)\d\d.
# http_response_status_code: 401
# The (optional) include_content parameter will instruct the check
# to include the first 200 characters of the HTTP response body
# in notifications sent by this plugin. This is best used with
# "healthcheck"-type URLs, where the body contains a brief, human-
# readable summary of failure reasons in the case of errors. This
# defaults to false.
#
# include_content: false
# The (optional) collect_response_time parameter will instruct the
# check to create a metric 'network.http.response_time', tagged with
# the url, reporting the response time in seconds.
#
# collect_response_time: true
# The (optional) disable_ssl_validation will instruct the check
# to skip the validation of the SSL certificate of the URL being tested.
# This is mostly useful when checking SSL connections signed with
# certificates that are not themselves signed by a public authority.
# When true, the check logs a warning in collector.log
# Defaults to true, set to false if you want SSL certificate validation.
#
# disable_ssl_validation: true
# If you enable the disable_ssl_validation above, you might want to disable security warnings
# You can use the flag below to do so
# ignore_ssl_warning: false
# Path of trusted CA certificates used to validate the SSL certificate
# for this url.
# Overrides the default path and the one specified in init_config.
#
# ca_certs: /etc/ssl/certs/ca-certificates.crt
# The (optional) check_certificate_expiration will instruct the check
# to create a service check that checks the expiration of the
# ssl certificate. Allow for a warning to occur when x days are
# left in the certificate, and alternatively raise a critical
# warning if the certificate is y days from the expiration date.
# The SSL certificate will always be validated for this additional
# service check regardless of the value of disable_ssl_validation
#
# check_certificate_expiration: true
# days_warning: 14
# days_critical: 7
# The (optional) headers parameter allows you to send extra headers
# with the request. This is useful for explicitly specifying the host
# header or perhaps adding headers for authorisation purposes. Note
# that the http client library converts all headers to lowercase.
# This is legal according to RFC2616
# (See: http://tools.ietf.org/html/rfc2616#section-4.2)
# but may be problematic with some HTTP servers
# (See: https://code.google.com/p/httplib2/issues/detail?id=169)
#
# headers:
# Host: alternative.host.example.com
# X-Auth-Token: SOME-AUTH-TOKEN
# The (optional) skip_event parameter will instruct the check to not
# create any event to avoid duplicates with a server side service check.
# This default to False.
#
skip_event: true
# The (optional) no_proxy parameter would bypass any proxy settings enabled
# and attempt to reach the the URL directly.
# If no proxy is defined at any level, this flag bears no effect.
# Defaults to False.
#
# no_proxy: false
# The (optional) allow_redirects parameter can enable redirection.
# Defaults to True.
#
# allow_redirects: true
# The (optional) include_default_header parameter instructs the check to include the default headers.
#
# Defaults to True.
#
#include_default_headers: false
# tags:
# - url:http://alternative.host.example.com
# - env:production
# - name: My second service
# url: https://another.url.example.com