
Your custom module will be built by taking the base module and overriding it with the other values you specified. Monitoring/http_ipv4_10s : extends : http_ipv4 timeout : 10s
except for the prober field, no further validation checks are executed on your custom modules.Īn example of a custom module for the monitoring group, for a probe using ICMP over IPv4 with a timeout of 10 seconds, would be:. for monitoring group, a valid name would be monitoring/myprobename) each module has to be named using the format / (e.g. However, there are a few important things to note: Inside this file, you can define as many custom modules as you like, following the Blackbox exporter documentation. To define a custom module, you need to create a file in your group's folder named custom_modules.yaml. If you want to know the details of these probes, have a look at the related chapter. If you would like to probe both over IPv4 and IPv6, and be notified only if both fail, you'll need to use use both modules separately, and then create a custom alarm to achieve the behavior you want. We currently support the following modules:Īs you can understand from their name, these modules utilize either the HTTP or ICMP protocol, and either ipv4 or ipv6. You can either use one of our supported modules or create a custom module yourself. * certificate_expiration: alerts you one month before the SSL certificate expires (only for http probes) What modules can I use? The list of alerts you can enable is the following: Targets : - url : enabled_alerts : - certificate_expiration labels : snow_functional_element : "Some Functional Element" To do so, add target_path in the, following this example: an HTTP probe), you can also decide to probe a custom endpoint on the hosts belonging to the. If your puppet probe is configured with a module that uses the http prober (i.e. toplevel_hostgorup: default derived from the targeted hostgroup. submitter_hostgroup: defaults to the targeted hostgroup. submitter_environment: default is retrieved from Puppet. remote_producer: defaults to the folder name. To override the internal labels automatically set by MONIT: To trigger the creation of NoContact alarms: Query_interval is an optional configuration that you can use to set up a different query frequency for your targets than the default one "1m". Labels can be set for two use cases here they are, along with their related labels: monitoring/something/example) you can also specify different labels, if you need so. Here, the is of course the hostgroup you want to probe (e.g.
The general structure of this file is the following: Head into your folder and create a probes.yaml file. Remember that you are only allowed to make changes in your group's folder and to the whitelist.yaml file. Now create a folder using your group's name: that's where you will operate. Whitelist yourself by adding your group's name (if it's missing) and your username under it, in a similar fashion of what is already there. If you've never configured a remote probe before, open the whitelist.yaml file: it's used to prevent accidental changes to other people's probes. First thing to do is to create a branch for your changes. How do I add a new probe?Īll probes are centrally managed in our monit-remote-probes
You can either pick a module from a fixed set that we support (you can check it here) or create a custom module which can include more things, such as authentication. That allow to tweak probe settings such as the used protocol, the expected This configuration is carried out through the use of modules, which are templates To then expose the results as metrics to be scraped by Prometheus. The Blackbox exporter executes the configured probes against the remote targets, If you want to read more about the Blackbox exporter, please refer to theĪnd to the GitHub project. Over a variety of protocols: HTTP, HTTPS, TCP, DNS, ICMP. Workflow is based on Prometheus and the Blackbox exporter, probing endpoints
Prometheus blackbox exporter example how to#
This section explains how to setup and execute probes on remote targets.