Skip to main content
Version: v0.10 🚧

prometheus

Schema Prometheus

Prometheus can be used to define monitoring requirements

Attributes

Name and DescriptionTypeDefault ValueRequired
path
The path to scrape metrics from.
str/metricsoptional
port
The port to scrape metrics from. When using Prometheus operator, this needs to be the port NAME. Otherwise, this can be a port name or a number.
strcontainer ports when scraping pod (monitorType is pod) and service port when scraping service (monitorType is service)optional

Examples

import catalog.models.schema.v1.monitoring as m

monitoring: m.Prometheus{
path: "/metrics"
port: "web"
}