Package io.quarkus.kubernetes.deployment

Class PrometheusConfig

java.lang.Object

io.quarkus.kubernetes.deployment.PrometheusConfig

public class PrometheusConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	annotations	When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.
(package private) boolean	generateServiceMonitor	When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.
(package private) Optional<String>	path	Define the annotation used to indicate the path to scrape.
(package private) Optional<String>	port	Define the annotation used to indicate the port to scrape.
(package private) String	prefix	Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults.
(package private) Optional<String>	scheme	Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.
(package private) Optional<String>	scrape	Define the annotation used to indicate services that should be scraped.

Constructor Summary

Constructors

Constructor	Description
PrometheusConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

annotations

@ConfigItem(defaultValue="true")
boolean annotations

When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.

generateServiceMonitor

@ConfigItem(defaultValue="true")
boolean generateServiceMonitor

When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.

prefix

@ConfigItem(defaultValue="prometheus.io")
String prefix

Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is prometheus.io See Prometheus example: https://github.com/prometheus/prometheus/blob/main/documentation/examples/prometheus-kubernetes.yml

scrape

@ConfigItem
Optional<String> scrape

Define the annotation used to indicate services that should be scraped. By default, /scrape will be appended to the defined prefix.

path

@ConfigItem
Optional<String> path

Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.

port

@ConfigItem
Optional<String> port

Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.

scheme

@ConfigItem
Optional<String> scheme

Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.

Constructor Details

PrometheusConfig

public PrometheusConfig()