Bleemeo agent can relay your custom metrics to the Bleemeo Cloud platform. There are several ways to gather custom metrics:
The Bleemeo agent can check that your custom application is alive. It can use a built-in check (HTTP and TCP), a Nagios check command, or check for a running process.
To configure additional check, add the following to your Bleemeo agent
configuration (/etc/glouton/conf.d/50-custom-check.conf
):
service:- id: "myapplication"port: 8080check_type: "nagios"check_command: "command-to-run"- id: "custom_webserver"port: 8181check_type: "http"- id: "process_check_name"check_type: "process"match_process: "command-to-check"
Custom check are defined under service
in the configuration.
Add to your configuration file (any *.conf
file in /etc/glouton/conf.d/
):
service:# Use "/path/to/bin --with-option" to check the service. Also keep a# TCP connection with 127.0.0.1:8080, if that connection is closed run# a check immediatly instead of waiting 1 minute.- id: "service_name"port: 8080address: "127.0.0.1"check_type: "nagios"check_command: "/path/to/bin --with-option"# HTTPS check to URL https://127.0.0.1:8443/check/- id: "an_https_server"port: 8443check_type: "https"http_path: "/check/"# TCP check on 127.0.0.1:22- id: "another_service"port: 22# Process check for Docker daemon- id: "process_check_name"check_type: "process"match_process: "/usr/bin/dockerd"
Custom checks are run every minutes. If port
is provided, Bleemeo Agent
maintains a TCP connection with this port, and if that connection is closed
the check is run immediately.
Fields are:
id
: Name of your service. This name must be unique for one Bleemeo Agent.
port
: TCP port number. This field is mandatory if check_type
is not
"nagios".
address
: IP address associated with the TCP port. Default value is "127.0.0.1".
check_type
: Check used for this service. Possible value are:
check_command
to test liveliness of service.match_process
is running.http_path
: The path of URL checked with HTTP or HTTPS check_type
. Default
value is "/"
http_status_code
: The expected status code of HTTP response (only valid if check_type
is HTTP or HTTPS). Default is unset.
When set, the check pass if the response status code is equal to the expected one and critical in other case.
When unset, if response status code is
check_command
: Command used for a Nagios check. This field is mandatory if
check_type
is "nagios".
The command must conform to Nagios check standard, that is:
In addition, the command may print to stdout a short explanation of its result. For example if a check fail to connect to your service, the check may print: "CRITICAL - connection refused"
match_process
: Regex to match in a process check. It supports regular expressions with the
RE2 syntax.
If no process matched, or if all matched processes are in a zombie state, the check is critical, else it passes.