healthcheck

Example

import { startupHealthInfo } from '@mimik/healthcheck';
// or
import healthcheck from '@mimik/healthcheck';

healthcheck~startupHealthInfo(config, correlationId) ⇒ void

Generate service startup message.

Kind: inner method of healthcheck
Throws:

• TypeError When config is null/undefined or config.serverSettings is missing.
• TypeError When serverSettings.public.domainName is falsy and serverSettings.ip is missing, because hrefId then falls back to serverSettings.ip.public || serverSettings.ip.local.

Requires: module:@mimik/sumologic-winston-logger, module:@mimik/address-helper

| Param | Type | Description | | --- | --- | --- | | config | object | Configuration of the micro-service. | | config.serverSettings | object | Server settings object. | | config.serverSettings.name | string | Name of the micro-service. | | config.serverSettings.id | string | Id of the micro-service. | | config.serverSettings.port | number | Port the micro-service is listening on. | | config.serverSettings.basePath | string | Base path of the micro-service. | | config.serverSettings.public | object | Public address settings. | | config.serverSettings.public.domainName | string | Domain name of the micro-service. | | config.serverSettings.public.protocol | string | Protocol of the micro-service. | | correlationId | string | CorrelationId to display during startup. |