Observability and Health
Summary
HR Suit includes shared correlation, structured logging, OpenTelemetry, health endpoints, and service-health monitoring foundations, with optional exporters and AWS monitoring integration.
Audience
- DevOps and support engineers
- Developers and QA engineers
- Implementation partners
- Solution architects
Overview
Correlation identifiers connect gateway and downstream activity and are included in request handling and structured logs where the shared conventions are adopted. OpenTelemetry support provides a standard tracing foundation for ASP.NET Core and outbound HTTP activity. Exporters are configuration-dependent so telemetry can be sent to an approved destination without changing application behavior.
The current observability model includes:
- Correlation ID middleware and correlated gateway responses.
- Structured application and route logging.
- OpenTelemetry tracing foundations in the shared kernel and selected services.
- Optional console or remote telemetry exporters.
- Health endpoints for service and hosting-platform probes.
- Platform service-health monitoring for configured service registrations.
- AWS-native application logs and metrics for components hosted by supported managed services.
Health interpretation
A successful health endpoint can indicate that a process is running and able to answer its configured checks. It may not always prove that every downstream database, broker, provider, or dependent service is available. Operational readiness should combine health probes with dependency-aware checks, traces, logs, metrics, and business-level smoke tests.
Exporter destinations, log retention, alarm thresholds, dashboard definitions, and environment identifiers belong in approved operations documentation and are excluded here.
Related Articles
See Also
Keywords
- Distributed tracing
- Structured logging
- Process health
Revision Information
- Last reviewed: 2026-07-14
- Owner: platform-operations-team
- Status: Draft