Here is an overview of how you can operate Promitor.

Health

Promitor provides a basic health endpoint that indicates the state of the scraper.

Health endpoints can be useful for monitoring the scraper, running sanity tests after deployments or use it for sending liveness / health probes.

Consuming the health endpoint

You can check the status with a simple GET:

❯ curl -i -X GET "http://<uri>/api/v1/health"

Health is currently indicated via the HTTP response status:

In the future, the endpoint will be more advanced by giving detailed status on dependencies as well.

Azure Resource Manager API - Consumption & Throttling

Promitor exposes runtime metrics to provide insights on the API consumption of Azure Resource Manager API:

You can read more about the Azure Resource Manager limitations on docs.microsoft.com.

Configuration REST APIs

In order to run Promitor certain aspects have to be configured. Once up & running, you typically do not touch or open the configuration anymore and just intereact with Promitor.

For some scenarios it can be useful to know what was configured:

Therefor we provide the following REST APIs:

For security reasons, some sections of the configuration might be sanitized in the response to avoid leaking secrets.

← back