USACE / USACE/cwms-data-api

Debugging messages can be difficult to understand

Open
#511 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Here are some examples trying to save time-series data with an invalid identifier. In some cases debugging required going into the oracle table AT_LOG_MESSAGE. That is not practical for all users/developers.

Invalid ID attempted API Response Server Log Oracle/AT_LOG_MESSAGE
Hartwell.Energy-Sched.Inst.0.1Hour.Raw-source1 status code: 404 {"message":"Not Found.","incidentIdentifier":
"8589911861355292194", "details":{}}
INFO [http-nio-7000-exec-4]
cwms.cda.ApiServlet.lambda$init$10 8589911861355292194: Not Found.
cwms-data-api-data-api-1
cwms.cda.api.errors.NotFoundException: ORA-20998: ERROR: ORA-06512: at "CWMS_20.CWMS_TS", line 1999
ORA-20205: ERROR: Invalid Time Series Description: Hartwell.Energy-Sched.Inst.0.1Hour.Raw-source1 Inst/Cum parameter types cannot have non-zero duration
Hartwell.Storage.Inst.1Hour.0.Raw-source1 status code: 500 {"message":"Internal Error","incidentIdentifier":
"-5846316739419111664","details":{}
ORA-20006: INVALID_PARAM_ID: "Storage" is not a valid CWMS timeseries Parameter ORA-20006: INVALID_PARAM_ID: "Storage" is not a valid CWMS timeseries Parameter

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

Start by comparing the API responses and server-log entries in the issue for the two invalid time-series identifiers, then inspect the corresponding records in the Oracle AT_LOG_MESSAGE table. Done means invalid identifiers produce debugging information that users and developers can understand without querying that table.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.