USACE / USACE/cwms-data-api

Create an Error Event Details Controller for getting error log messages from database.

Open
#516 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Karl showed a series of steps he went through to track down a database error.
Can we automate some/all of those steps?

What if CDA created an event-id for each request with the start/stop time. If the request results in an error the user gets back the event id and CDA adds the event to a self-expiring list of the last X errors.
Authorized Users could then hit the controller and request more details about their errors. Maybe they can get a more detailed message or a stack or maybe even rows from AV_LOG_MESSAGE for the event start/stop.

The user could have 10 minutes or something like that to request the details

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.

Research direction

No files, tests, or entry points are named. Start by clarifying how request event IDs, authorization, retention, error details, and AV_LOG_MESSAGE queries should work, then identify the existing controller and database error-handling paths. Done means an agreed design and implementation scope for retrieving self-expiring error details.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.