Skip to content

docs(observability): document health checks and metrics - #317

Merged
Tybravo merged 6 commits into
SwiftChainn:mainfrom
Aboyeji-Isaac:docs/health-observability-metrics
Oct 28, 2026
Merged

Tybravo merged 6 commits into
SwiftChainn:mainfrom
Aboyeji-Isaac:docs/health-observability-metrics

Conversation

@Aboyeji-Isaac

Copy link
Copy Markdown
Contributor

Summary

Documents the backend's health checks, observability features, and metrics to make deployment, monitoring, and troubleshooting easier.

Changes

  • Document the available health-check endpoints and their purposes.
  • Explain the metrics endpoint, its output, and the metrics it exposes.
  • Describe relevant environment variables and configuration options.
  • Include guidance for deployment and monitoring integrations.
  • Explain how operators can use the available observability information to investigate service health and performance.
  • Keep the documentation aligned with the actual implementation.

Testing

  • Review the documentation against the implemented endpoints and configuration.
  • Verify that referenced paths, environment variables, and commands are accurate.

Closes #281

@Tybravo

Tybravo commented Oct 28, 2026

Copy link
Copy Markdown
Collaborator

@Aboyeji-Isaac

Thank you for working on the task

@Tybravo
Tybravo merged commit ec61df9 into SwiftChainn:main Oct 28, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Health, observability, and metrics reference

2 participants