USACE / USACE/cwms-data-api

Implement microprofile health style endpoint for CDA monitoring

Open
#1,628 0 comments 0 reactions 1 assignee View on GitHub

@MikeNeilson is already working on this.

Since Jul 16, 2026.

enhancement
Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

Is your feature request related to a problem? Please describe.
CDA itself is getting more complex with additional backends.
Additional there is need for more reporting about what is support so that clients can fail and expand gracefully.

Describe the solution you'd like
Similar to https://github.com/opendcs/opendcs/commit/2f0166efea2e0f216c35a7b1ddb2c5da8c6cb98c, make use of the jakarta ee microprofile health design to implement both simple and detailed state handling.

Describe alternatives you've considered
Build something that doesn't have a defined standard?

Additional context
Currently we report state with just checking the offices endpoint (it's fast and proves the database is alive), however the micro profile health includes startup, liveness, and ready which can be useful to understand what state the system is in.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.