artefactual-sdps / enduro

Designed to automate the processing of transfers in multiple Archivematica pipelines.
https://enduro.readthedocs.io/
Apache License 2.0
4 stars 3 forks source link

Problem: Archivematica job detail messages are not visible in the Enduro UI #954

Open fiver-watson opened 3 weeks ago

fiver-watson commented 3 weeks ago

Describe the issue

Currently, there is no way to see AM STDOUT and/or STDERR messages related to specific jobs run in Archivematica. This can make troubleshooting more difficult and provides operators with less insight into what actions are being performed on their content.

Expected behavior

Currently, Enduro workflow tasks are organized into a table, with a Notes column. At present, that Notes column is not being used.

For now, the initial implementation proposal is to add a "View" link to the Notes column. When clicked, this should open an expandable dropdown below the current row, that will include the STDOUT or STDERR messages from the related Archivematica job.

Screenshots

A rough wireframe has been prepared below:

Enduro-AM-Notes-mockup-v0 1

You can see a bit more context on the following Miro board:

Ideally, much like in AM, STDERR messages would be in a light red frame, rather than the light grey of the STDOUT as shown in the wireframe.

Additional context

This issue is part of an incremental effort to improve the end user messages shown in workflow tasks. Part 1, hiding some of the unnecessary AM tasks, is described in issue #950. Future tickets will also be filed to customize the task names and outcome messages shown in Enduro, for better clarity to operators.

jraddaoui commented 3 weeks ago

We should be careful about accessibility, I'm not sure how that expandable section inside a table (inside another expandable section) will work in that regard.

aseles13 commented 3 weeks ago

I am not sure how much work or analysis is still needed to be able to include this in PoC#2, but if we can show them some error messages (user or system) it would be a good step forward.