Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PrometheusMetricsService

Service that exposes "/metrics" route for Prometheus to scap performance metrics.

Configuration parameters

  • dependencies:
    • endpoint: override for HTTP Endpoint dependency
    • prometheus-counters: override for PrometheusCounters dependency
  • connection(s):
    • discovery_key: (optional) a 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 connection
  • *:endpoint:http:*:1.0 (optional) HttpEndpoint reference to expose REST operation
  • *:counters:prometheus:*:1.0 PrometheusCounters reference to retrieve collected metrics
see

RestService

see

RestClient

Example

let service = new PrometheusMetricsService();
service.configure(ConfigParams.fromTuples(
    "connection.protocol", "http",
    "connection.host", "localhost",
    "connection.port", 8080
));

service.open("123", (err) => {
   console.log("The Prometheus metrics service is accessible at http://+:8080/metrics");
});

Hierarchy

  • RestService
    • PrometheusMetricsService

Implements

  • IOpenable
  • IConfigurable
  • IReferenceable
  • IUnreferenceable
  • IRegisterable

Index

Constructors

constructor

Properties

Protected _baseRoute

_baseRoute: string

Protected _counters

_counters: CompositeCounters

Protected _dependencyResolver

_dependencyResolver: DependencyResolver

Protected _endpoint

_endpoint: HttpEndpoint

Protected _logger

_logger: CompositeLogger

Methods

close

  • close(correlationId: string, callback?: function): void
  • Parameters

    • correlationId: string
    • Optional callback: function
        • (err: any): void
        • Parameters

          • err: any

          Returns void

    Returns void

configure

  • configure(config: ConfigParams): void
  • Parameters

    • config: ConfigParams

    Returns void

Protected instrument

  • instrument(correlationId: string, name: string): Timing
  • Parameters

    • correlationId: string
    • name: string

    Returns Timing

isOpen

  • isOpen(): boolean
  • Returns boolean

open

  • open(correlationId: string, callback?: function): void
  • Parameters

    • correlationId: string
    • Optional callback: function
        • (err: any): void
        • Parameters

          • err: any

          Returns void

    Returns void

register

  • register(): void

Protected registerRoute

  • registerRoute(method: string, route: string, schema: Schema, action: function): void
  • Parameters

    • method: string
    • route: string
    • schema: Schema
    • action: function
        • (req: any, res: any): void
        • Parameters

          • req: any
          • res: any

          Returns void

    Returns void

Protected sendCreatedResult

  • sendCreatedResult(req: any, res: any): function
  • Parameters

    • req: any
    • res: any

    Returns function

      • (err: any, result: any): void
      • Parameters

        • err: any
        • result: any

        Returns void

Protected sendDeletedResult

  • sendDeletedResult(req: any, res: any): function
  • Parameters

    • req: any
    • res: any

    Returns function

      • (err: any, result: any): void
      • Parameters

        • err: any
        • result: any

        Returns void

Protected sendError

  • sendError(req: any, res: any, error: any): void
  • Parameters

    • req: any
    • res: any
    • error: any

    Returns void

Protected sendResult

  • sendResult(req: any, res: any): function
  • Parameters

    • req: any
    • res: any

    Returns function

      • (err: any, result: any): void
      • Parameters

        • err: any
        • result: any

        Returns void

setReferences

  • setReferences(references: IReferences): void
  • Sets references to dependent components.

    Parameters

    • references: IReferences

      references to locate the component dependencies.

    Returns void

unsetReferences

  • unsetReferences(): void
  • Returns void

Generated using TypeDoc