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.

Sign up for GitHub

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

Jump to bottom

rfc24: Add redirect event #206

Merged
merged 1 commit into from
Sep 27, 2019
+36 −0
Merged

rfc24: Add redirect event #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions spec_24.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,42 @@ Example:
}
----

=== Redirect Event

The redirect event indicates that a stream's data has been redirected
away from the log. The caller should not expect any additional data
events in the log for that stream.

The following keys are REQUIRED in the event context object:

stream::
(string) The stream name (e.g. `stdout`, `stderr`). All valid stream
names MUST appear as keys in the header `encoding` object.

rank::
(string) An idset string (RFC 22) representing the rank(s) that are
redirecting output.

The following keys are OPTIONAL in the event context object:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a thought, we may want to add an optional rank key to indicate the tasks to which the redirect applies. This would allow some tasks to be redirected and not others in the future. (e.g. redirect all tasks except rank 0 to /dev/null)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I went back and forth on that. Now that I think about it, I suppose if the redirect applies to all ranks, the rank be == all? So we should make the rank a requirement.

Copy link
Member Author

@chu11 chu11 Sep 27, 2019 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh wait, ranks are idset strings. Hmmm. Should we allow idset string or "all"? Just trying to think of how shell & job-attach handle this. one line per task is cumbersome for the "all" case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be too difficult to generate the correct idset in the shell output plugin?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, that shouldn't be too hard.

I was mostly thinking about how to recognize that all tasks have been redirected, but we can can count idsets just like EOFs and we'd be fine.

I was also hoping to output a single message if both stdout/stderr were redirected to the same file, but I suppose that can be two messages.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was also hoping to output a single message if both stdout/stderr were redirected to the same file, but I suppose that can be two messages.

Ah, that is a good point. Maybe stream could be a list? Eh, maybe two events is ok like you say.


path::
(string) Indicates the path data has been redirected to, if the data
has been redirected to a file.

Example:

[source,json]
----
{
"timestamp":1552593350.4,
"name":"redirect",
"context":{
"stream":"stdout",
"path":"job.output",
}
}
----

=== Log Event

The log event supports error and debug logging from the Flux shells.
Expand Down