PrometheusMetricsService

Implements: RestService

Description

The PrometheusMetricsService class allows you to create services that expose the "/metrics" and "/metricsandreset" routes for Prometheus to obtain performance metrics.

Configuration parameters

dependencies:

• endpoint: override for HTTP Endpoint dependency
• prometheus_counters: override for PrometheusCounters dependency

connection(s):

• discovery_key: (optional) key to retrieve the connection from IDiscovery
• protocol: connection protocol: http or https
• host: host name or IP address
• port: port number
• uri: resource URI or connection string with all parameters in it

References

• • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
• • *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements
• • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connections
• • *:endpoint:http:*:1.0 - (optional) HttpEndpoint reference to expose REST operations
• • *:counters:prometheus:*:1.0 - PrometheusCounters reference to retrieve collected metrics

Constructors

Creates a new instance of this service.

PrometheusMetricsService()

Instance methods

set_references

Sets references to dependent components.

set_references(references: IReferences)

• references: IReferences - references to locate the component dependencies.

register

Registers all service routes in a HTTP endpoint.

register()

Examples

    service = PrometheusMetricsService()

    service.configure(ConfigParams.from_tuples(
        "connection.protocol", "http",
        "connection.host", "localhost",
        "connection.port", 8080
    ))

    try:
        service.open("123")
        print("The Prometheus metrics service is accessible at http://+:8080/metrics")
    except Exception as err:
        # do something

See also

• RestService

• RestClient