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

refactor: update logging to always output to STDOUT/STDERR by default #179

Draft
wants to merge 24 commits into
base: jghrefactor/A1-update-dockerfile
Choose a base branch
from

Conversation

hollandjg
Copy link
Collaborator

@hollandjg hollandjg commented Oct 28, 2024

Benefits:

  • The code handling the logger initialization is much simpler. (There isn't any.)
  • The command line option --log 0 or --log 1 is gone.
  • We remove the need to mount the directory for logs in the dockerfile.
  • It's easy to get logs using cylc, which will automatically collect the logs from stderr and provide them to the user via the user interface.
  • It's still easy enough to pipe the log output to a file when needed.
  • More documentation for debugging.

Unchanged:

  • Adding debug output is the same as ever (it uses the environment variable JULIA_DEBUG).

Drawbacks:

  • Defining the output filename for the logfiles becomes the responsibility of the user or workflow writer.

    This is going to be an idée fixe in the upcoming refactoring, as we make it possible to specify input and output filenames for each of the steps of the processing. If we're not happy with that, we should discuss it now.

Additional changes:

  • add a _test-cli.sh script for running checks on the pipeline tools without needing a full cylc workflow run.

@hollandjg hollandjg mentioned this pull request Oct 28, 2024
31 tasks
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 this pull request may close these issues.

1 participant