Package org.pipservices4.prometheus.controllers

Class PrometheusMetricsController

java.lang.Object
org.pipservices4.http.controllers.RestController
org.pipservices4.prometheus.controllers.PrometheusMetricsController
All Implemented Interfaces:
org.pipservices4.components.config.IConfigurable, org.pipservices4.components.refer.IReferenceable, org.pipservices4.components.refer.IUnreferenceable, org.pipservices4.components.run.IClosable, org.pipservices4.components.run.IOpenable, org.pipservices4.http.controllers.IRegisterable
public class PrometheusMetricsController extends org.pipservices4.http.controllers.RestController

  • Field Summary

    Fields inherited from class org.pipservices4.http.controllers.RestController

    _baseRoute, _config, _counters, _dependencyResolver, _endpoint, _logger, _swaggerController, _swaggerEnable, _swaggerRoute, _tracer, _url

  • Constructor Summary

    Constructors
    Constructor
    Description
    PrometheusMetricsController()
    Creates a new instance of this service.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    metrics(jakarta.ws.rs.container.ContainerRequestContext req)
    Handles metrics requests
    void
    register()
    Registers all service routes in HTTP endpoint.
    void
    setReferences(org.pipservices4.components.refer.IReferences references)
    Sets references to dependent components.

    Methods inherited from class org.pipservices4.http.controllers.RestController

    close, configure, getBodyAsJson, getBodyAsString, getQueryParameter, getTraceId, instrument, isOpen, open, registerInterceptor, registerOpenApiSpec, registerOpenApiSpecFromFile, registerRoute, registerRoute, registerRouteWithAuth, sendCreatedResult, sendDeletedResult, sendEmptyResult, sendError, sendResult, unsetReferences

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PrometheusMetricsController

      public PrometheusMetricsController()
      Creates a new instance of this service.

  • Method Details

    • setReferences

      public void setReferences(org.pipservices4.components.refer.IReferences references) throws org.pipservices4.components.refer.ReferenceException, org.pipservices4.commons.errors.ConfigException
      Sets references to dependent components.
      Specified by:
      setReferences in interface org.pipservices4.components.refer.IReferenceable
      Overrides:
      setReferences in class org.pipservices4.http.controllers.RestController
      Parameters:
      references - references to locate the component dependencies.
      Throws:
      org.pipservices4.components.refer.ReferenceException
      org.pipservices4.commons.errors.ConfigException

    • register

      public void register()
      Registers all service routes in HTTP endpoint.
      Specified by:
      register in interface org.pipservices4.http.controllers.IRegisterable
      Specified by:
      register in class org.pipservices4.http.controllers.RestController

    • metrics

      public jakarta.ws.rs.core.Response metrics(jakarta.ws.rs.container.ContainerRequestContext req)
      Handles metrics requests
      Parameters:
      req - an HTTP request
      Returns:
      res an HTTP response