@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.

The logger will try to build a chain of errors for easier tracking. In order to make sure the chain is built correctly put cause first then the extra errors after:

try {
  // carry out task
} catch (error) {
  // caught error is treated as the cause of the new error
  console.error(error, new Error('Failed to carry out task'));
}

• 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
• AUROX_TELEMETRY_LOGGER_FORMAT: How to output the logs. Can be json, yaml or pretty. Default: json.
• AUROX_TELEMETRY_LOGGER_PRETTY_STACK_PRINT_SEVERITY: At which severity and above should the pretty printer output stacktraces. Default: WARNING.

Tracer

Pushes traces to Jaeger agent for tracing.

• AUROX_TELEMETRY_TRACER_DISABLED: Disables the tracer when set to true, this forces the tracer to be disabled.
• AUROX_TELEMETRY_TRACER_DEBUG: Enables tracer debugging when set to true, useful for debugging instrumentations.
• AUROX_TELEMETRY_TRACER_SAMPLE_RATE: Sets the sample rate at which traces are sampled for collection. Default: 1.
• AUROX_TELEMETRY_TRACER_AGENT_HOST: Sets the host of the Jaeger Agent for udp packets. Default: localhost.
• AUROX_TELEMETRY_TRACER_AGENT_PORT: Sets the port of the Jaeger Agent for udp packets. Default: 6832.