flux-framework / rfc

Flux RFC project
https://flux-framework.readthedocs.io/projects/flux-rfc/
7 stars 13 forks source link

Document required exec system/job shell events logged to guest.exec.eventlog #170

Open grondo opened 5 years ago

grondo commented 5 years ago

RFC 16 requires that the exec system create an exec.eventlog under the guest KVS namespace for use by the job shells.

We should document a minimal set of required events for this eventlog. Though the job shell is a user replaceable component, it should perhaps adhere to some minimal standard behavior so that tools and apps may synchronize and interact with conforming job shells in a predictable manner.

Also, the exec system itself could probably dump some events of its own into this eventlog, e.g. an initial init event to denote creation of the eventlog, and a final done or end event as the terminating event. cleanup.start and cleanup.finish events might also be useful to indicate when cleanup tasks on ranks were started and completed (though maybe this doesn't belong in the user-level eventlog?)

To start, we could define these well-known job shell events:

garlick commented 5 years ago

Sounds good!

Might want to add debug.* like in the primary eventlog. That turned out to be kind of handy.

This may be useful for logging PMI timing info, e.g.

debug.pmi.init.entry
debug.pmi.init.exit
debug.pmi.barrier.entry
debug.pmi.barrier.exit

etc.

No need to specify that, just pointing out a use for debug entries.