RockefellerArchiveCenter/fornax

All service responses should return the identifiers of the objects processed

Closed this issue · 0 comments

Is your feature request related to a problem? Please describe.

Users currently have difficulty understanding the location of a particular transfer in the microservice pipeline. In addition, it's often difficult to diagnose errors effectively because it's hard to tell which transfer is throwing an error. Identifiers which are visible and searchable would help remedy both these situations.

Describe the solution you'd like

All services in this application should return the identifier of any object they touch, regardless of whether the service succeeds or fails. Consider breaking this out into a separate JSON key so the response looks like:

{
  "detail": "Yay, it worked!!"
  "objects": ["12345", "35123"]
}

Describe alternatives you've considered

Much of this logging is already happening within applications, but it needs to be visible in the Zodiac UI in order for it to be useful.