1 – In the side menu, click on Services Hub
2 – In the Monitoring category, click on the Monitoring via API card
3 – You will be directed to the Monitor configuration form via API, fill in the fields
4 – If you want, you can configure automatic incident opening. In the Open automatic incident section, fill in the fields:
- Severity -> Choose between “SEV-1 – Critical”, “SEV-2 – High”, “SEV-3 – Moderate”, “SEV-4 – Low”, “SEV-5 – Informational” or “Not Classified”;
- Check Interval in seconds -> This is the interval at which checking will take place (this interval cannot be less than the number of failures x the Interval configured in the monitoring form;
- Failures to open automatic incident -> It is the number of failures necessary to open the automatic incident;
- Check Interval in seconds -> This is the interval in which checking will take place (this interval cannot be less than the number of hits x the Interval configured in the monitoring form;
- Hits to close automatic incident -> It is the number of hits needed to close the automatic incident;
- Responders -> These are the teams that will be notified if there are incidents in this monitoring, and you can add one or multiple teams;
If necessary, you can create a team by clicking + RESPONDER, you will be directed to the form
to create the team, then click on the button
for the new team to appear in the list
***Don’t forget to activate the Enable to set up automatic incidents opening toggle to save the automatic incident opening settings
5 – Click on CREATE MONITORING
6 – On the resources screen, click the button
and select the option API Hits and Failures
7 – If you have not created the token for Hits/Failures, click here and follow steps “8”, “9” and “10”, if you have already, skip to step “11”
8 – Select the API tab
9 – Click on the button
To add a new token, choose the Hits/Failures type and fill in the desired name. Click on Generate Integration Token.
10 – a curl will appear, and with it you will be able to generate a token valid for 300 seconds
11 – Copy the hit and failure Curl’s (remember to replace “<token>” with the token generated in step “10” to curl)
12 – It must generate hits/failure with an interval less than or equal to the interval configured in step “3”, so the monitoring will have the status “operational” (if it receives a hit) or “not operational” (if it receives failure). If the platform does not receive any hits/failures within this interval, the monitoring will have the status “pending”
Note: Our application has a rate limit of 5 requests per second. This means that each IP can make a maximum of 5 requests to the server in a period of 1 second. If this limit is exceeded, additional requests will be temporarily blocked.