Skip to main content

LMS Health and Diagnostics

Summary

Source-backed Draft reference for LMS Health and Diagnostics across the implemented Training Service and, where applicable, Gateway surface.

Audience

API consumers, engineering, QA, support, architecture, security, product, and implementation reviewers.

Reference Content

Confirmed routes and telemetry

CapabilityState
Process health routeImplemented with registered health checks
Training health-data routeImplemented; returns tenant-filtered entity counts and foundation state
Service information routeImplemented through shared envelope
Dependency readiness checksNot implemented
Separate liveness/readiness routesNot implemented
OpenTelemetry setupRegistered through shared observability extension
CorrelationShared middleware executed
Exception recordingShared observability plus local response mapping; exact exporter behavior is outside this API source
Custom metricsNot found
Dashboard/alert integrationNot found

The process health registration has no explicit Training database, Document Service, broker, or downstream probe in Program. It therefore must not be described as dependency readiness.

The health-data route reads tenant business counts and outbox count. It has no endpoint authorization declaration and may disclose operational/business state; public exposure requires confirmation. This documentation omits actual counts, environment details, and internal telemetry configuration.

Source References

  • microservices/src/training-service/Program.cs
  • microservices/src/training-service/Api/TrainingEndpoints.cs
  • microservices/src/shared-kernel/Extensions/ObservabilityExtensions.cs
  • microservices/src/shared-kernel/Middleware/CorrelationIdMiddleware.cs

See Also

Keywords

  • LMS API
  • Training Service
  • Source-backed contract

Revision Information

  • Status: Draft
  • Last reviewed: 2026-07-17
  • Review cycle: Quarterly