Package io.vertx.mutiny.micrometer

Interface PrometheusRequestHandler

All Superinterfaces:
MutinyDelegate
All Known Implementing Classes:
PrometheusRequestHandler.PrometheusRequestHandlerImpl
public interface PrometheusRequestHandler extends MutinyDelegate
An interface for creating handlers to expose Prometheus metrics via an HTTP endpoint.

This interface provides factory methods to create handlers that can scrape metrics from a PrometheusMeterRegistry and serve them over HTTP. It allows for various configurations of the metrics endpoint and the Prometheus registry.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Swamy Mavuri
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    PrometheusRequestHandler.PrometheusRequestHandlerImpl
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Consumer<HttpServerRequest>
    create()
    Creates a handler with a new PrometheusMeterRegistry and the default metrics endpoint ("/metrics").
    static Consumer<HttpServerRequest>
    create(io.micrometer.prometheusmetrics.PrometheusMeterRegistry registry)
    Creates a handler with the specified PrometheusMeterRegistry and the default metrics endpoint ("/metrics").
    static Consumer<HttpServerRequest>
    create(io.micrometer.prometheusmetrics.PrometheusMeterRegistry registry, String metricsEndpoint)
    Creates a handler with the specified PrometheusMeterRegistry and metrics endpoint.
    io.vertx.micrometer.PrometheusRequestHandler
    getDelegate()
     
    static PrometheusRequestHandler
    newInstance(io.vertx.micrometer.PrometheusRequestHandler delegate)
    Creates a new instance of the PrometheusRequestHandler.

  • Method Details

    • getDelegate

      io.vertx.micrometer.PrometheusRequestHandler getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • create

      static Consumer<HttpServerRequest> create(io.micrometer.prometheusmetrics.PrometheusMeterRegistry registry, String metricsEndpoint)
      Creates a handler with the specified PrometheusMeterRegistry and metrics endpoint.

      This handler scrapes metrics from the given PrometheusMeterRegistry and serves them at the specified endpoint.

      Parameters:
      registry - the PrometheusMeterRegistry to use for scraping metrics
      metricsEndpoint - the endpoint to expose metrics
      Returns:
      a handler for scraping Prometheus metrics

    • create

      static Consumer<HttpServerRequest> create(io.micrometer.prometheusmetrics.PrometheusMeterRegistry registry)
      Creates a handler with the specified PrometheusMeterRegistry and the default metrics endpoint ("/metrics").

      This handler scrapes metrics from the given PrometheusMeterRegistry and serves them at the default endpoint "/metrics".

      Parameters:
      registry - the PrometheusMeterRegistry to use for scraping metrics
      Returns:
      a handler for scraping Prometheus metrics

    • create

      static Consumer<HttpServerRequest> create()
      Creates a handler with a new PrometheusMeterRegistry and the default metrics endpoint ("/metrics").

      This handler scrapes metrics from a newly created PrometheusMeterRegistry and serves them at the default endpoint "/metrics".

      Returns:
      a handler for scraping Prometheus metrics

    • newInstance

      static PrometheusRequestHandler newInstance(io.vertx.micrometer.PrometheusRequestHandler delegate)
      Creates a new instance of the PrometheusRequestHandler.