@aurox/telemetry

Aurox Telemetry

Universal solution for logging, tracing, metrics, health-checks and more.

Service

• AUROX_TELEMETRY_SERVICE_PORT: The port the telemetry service uses to respond to health check, metrics, etc... requests. Default: 8080.
• AUROX_TELEMETRY_SERVICE_NAME: The name of the service as a whole. Default: service.
• AUROX_TELEMETRY_INSTANCE_NAME: The name of the instance currently running. Defaults to instance name.

Beacon

Setups health-check endpoints such as /health, /live and /ready on the telemetry service.

• AUROX_TELEMETRY_BEACON_DISABLED: Disables the beacon when set to true, this forces the beacon to be disabled.

Metrics

Setups prometheus metrics endpoint /metrics on the telemetry service.

• AUROX_TELEMETRY_METRICS_DISABLED: Disables the metrics when set to true, this forces the metrics to be disabled.

Logger

Intercepts the console object to output json, yaml or pretty printed logs.

• AUROX_TELEMETRY_LOGGER_FORMAT: How to output the logs. Can be json, yaml or pretty. Default: json.
• AUROX_TELEMETRY_LOGGER_SEVERITY: Pick a severity to disable outputting any severity that is lower. Default: INFO.
  • Valid values: DEFAULT, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY