Add support for customizing Prometheus request for metrics scraping by introducing PrometheusRequestHandler

[swamymavuri]

Describe the feature

This feature aims to enhance the customization options for Prometheus request handling by introducing the PrometheusRequestHandler. This handler provides users with the ability to define their own request handling strategies tailored to their application's needs, enabling greater flexibility and control over how Prometheus metrics are scraped and served.

Proposal:

The proposal involves adding support for customizing Prometheus request handling through the introduction of the PrometheusRequestHandler. This handler can be configured to scrape metrics from a PrometheusMeterRegistry and serve them over HTTP, offering various configuration options for metrics endpoints and the Prometheus registry.

Use cases

Enhanced Flexibility: Users can define custom request handling procedures tailored to their application's unique requirements by customizing registry.

Adaptability: By allowing users to define their own request handling logic, the feature promotes adaptability to diverse project environments and use cases.

Implementation Details

The implementation involves:

• Introducing the PrometheusRequestHandler interface with factory methods for creating handlers.
• Providing configuration options for specifying PrometheusMeterRegistry and metrics endpoints.
• Implementing the PrometheusRequestHandlerImpl class to handle HTTP requests for Prometheus metrics scraping.

PrometheusMeterRegistry customRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT); customRegistry.config().namingConvention(NamingConvention.camelCase); router.route("/custom-metrics").handler(ctx -> PrometheusRequestHandler.create(customRegistry,"/custom-metrics") .handle(ctx.request()));

This feature enhancement will enrich the Prometheus integration in Vert.x, offering users greater flexibility and control over how metrics are handled and served.

Contribution

Who should implement this feature ? are you volunteering for implementing this feature - YES