Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for external logging schemas #215

Open
Tracked by #214
uniqueg opened this issue Apr 29, 2024 · 1 comment · May be fixed by #216
Open
Tracked by #214

Add support for external logging schemas #215

uniqueg opened this issue Apr 29, 2024 · 1 comment · May be fixed by #216

Comments

@uniqueg
Copy link
Contributor

uniqueg commented Apr 29, 2024

Problem

It is currently not possible to describe the shape of logging information. This makes it difficult for clients to make use of structured logging information, if available. For example, if a WES implementation returns logging information in the shape of the OPM provenance model and/or according to the one of the profiles of the Workflow Run RO-Crate collection, even clients capable of interpreting this additional information would need to first guess the shape of the returned information. Moreover, documentation on where to log what is terse in WES, which might lead different implementations to include structured logging information in different places.

Proposed solution

Refine WES's logging capabilities such that there is exactly one place where structured logging information for a given logging level (workflow, task) shall be provided, if available, as well as a means of defining the shape of a given (sub)log in a way that a client can understand. Clearly document the expected usage.

Alternative solutions

NA

Additional context

See metaissue on logging improvements.

@uniqueg
Copy link
Contributor Author

uniqueg commented Jun 18, 2024

Almost a duplicate of #13 (but the proposed solution is different)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant