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

cat-log: list job.out and job.err when jobs are running that require a tailer to access #5802

Open
oliver-sanders opened this issue Nov 1, 2023 · 0 comments · May be fixed by #6480
Open
Assignees
Labels
could be better Not exactly a bug, but not ideal.
Milestone

Comments

@oliver-sanders
Copy link
Member

Ensure that the job.out and job.err files are listed for jobs running on platforms with a configured tailer command even if the file is not yet present in the job log directory.

Explanation:

  • The cylc cat-log command can be used to retrieve job logs.
  • The -m l option tells cat-log to list the available job log files.
  • The Cylc UI Server uses the -m l option to populate the dropdown of available log files.
  • Some platforms have a funny setup where the job.out and job.err files are moved into the job log directory after the job has completed. Until this point they live on a compute node somewhere so do not appear in the -m l listing.
  • To allow users to access these files whilst the job is still running the batch system provides a command.
  • Cylc provides support for these setups using the "tailer" options, these allow system administrators to configure the batch system command to view the files.
  • So in these situations, the job.out and job.err files are viewable via the configured "tailer", however, they don't appear in the file system listings (because they haven't been moved into the job log directory yet).
  • To get around this we should add some logic to cylc cat-log which:
    • Adds job.out and job.err to the list of files returned by cylc cat-log -m l,
    • if the job is running (as determined from the database),
    • and there is a "tailer" configured for the platform (as determined from the platform configuration).
  • We are (apparently) already performing database access somewhere in cylc cat-log so this should be a matter of hooking this extra logic into that check.
@oliver-sanders oliver-sanders added this to the cylc-8.x milestone Nov 1, 2023
@oliver-sanders oliver-sanders linked a pull request Nov 15, 2024 that will close this issue
8 tasks
@oliver-sanders oliver-sanders modified the milestones: 8.x, 8.3.7 Nov 15, 2024
@oliver-sanders oliver-sanders self-assigned this Nov 15, 2024
@oliver-sanders oliver-sanders added the could be better Not exactly a bug, but not ideal. label Nov 15, 2024
@hjoliver hjoliver modified the milestones: 8.3.7, 8.4.1 Jan 8, 2025
@wxtim wxtim linked a pull request Feb 3, 2025 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
could be better Not exactly a bug, but not ideal.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants