Package io.quarkus.kubernetes.deployment

Interface PrometheusConfig

public interface PrometheusConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    annotations()
    When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.
    boolean
    generateServiceMonitor()
    When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.
    Optional<String>
    path()
    Define the annotation used to indicate the path to scrape.
    Optional<String>
    port()
    Define the annotation used to indicate the port to scrape.
    String
    prefix()
    Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults.
    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.
    Optional<String>
    scrape()
    Define the annotation used to indicate services that should be scraped.

  • Method Details

    • annotations

      @WithDefault("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

      @WithDefault("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

      @WithDefault("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

    • scrape

      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

      Optional<String> path()
      Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.

    • port

      Optional<String> port()
      Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.

    • scheme

      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.