HeartbeatRestService

Service returns heartbeat via HTTP/REST protocol.

Extends: RestService

Description

The HeartbeatRestService class allows you to create services that return heartbeat via HTTP/REST protocol.

Important points

The service responds on /heartbeat route (can be changed) with a string with the current time in UTC.
This service route can be used to perform health checks by loadbalancers and container orchestrators.

Configuration parameters

base_route: base route for remote URI (default: “")
route: route to heartbeat operation (default: “heartbeat”)
dependencies:
- endpoint: override for HTTP Endpoint 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
*:traces:*:*:1.0 - (optional) ITracer components to record traces
*:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection

Instance methods

configure

Configures component by passing configuration parameters.

public configure(config: ConfigParams): void

config: ConfigParams - configuration parameters to be set.

register

Registers all service routes in HTTP endpoint.

public register(): void

Examples

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

await service.open("123");
console.log("The Heartbeat service is accessible at http://+:8080/ping");