From c0eb873379d12f0065f98835563c661d4344ca00 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Mon, 7 Feb 2022 12:41:23 -0500 Subject: [PATCH] notifications: document eval_* --- doc/manual/src/notifications.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/manual/src/notifications.md b/doc/manual/src/notifications.md index 2423670c..0c666559 100644 --- a/doc/manual/src/notifications.md +++ b/doc/manual/src/notifications.md @@ -55,6 +55,30 @@ After processing, the row's `notificationspendingsince` column is set to null. It is possible for subsequent deliveries of the same `build_finished` data to imply different outcomes. For example, if the build fails, is restarted, and then succeeds. In this scenario the `build_finished` events will be delivered at least twice, once for the failure and then once for the success. +### `eval_started` + +* **Payload:** Exactly three values, separated by the two-character string `\t` (ie: not a tab): an opaque trace ID representing this evaluation, the name of the project, and the name of the jobset. +* **When:** At the beginning of the evaluation phase for the jobset, before any work is done. +* **Delivery Semantics:** Ephemeral. `hydra-notify` must be running to react to this event. No record of this event is stored. + +### `eval_added` + +* **Payload:** Exactly two values, separated by the two-character string `\t` (ie: not a tab): an opaque trace ID representing this evaluation, and the ID of the JobsetEval record. +* **When:** After the evaluator fetches inputs and completes the evaluation successfully. +* **Delivery Semantics:** Ephemeral. `hydra-notify` must be running to react to this event. No record of this event is stored. + +### `eval_cached` + +* **Payload:** Exactly one value: an opaque trace ID representing this evaluation. +* **When:** After the evaluator fetches inputs, if none of the inputs changed. +* **Delivery Semantics:** Ephemeral. `hydra-notify` must be running to react to this event. No record of this event is stored. + +### `eval_failed` + +* **Payload:** Exactly one value: an opaque trace ID representing this evaluation. +* **When:** After any fetching any input fails, or any other evaluation error occurs. +* **Delivery Semantics:** Ephemeral. `hydra-notify` must be running to react to this event. No record of this event is stored. + ## Development Notes ### Re-sending a notification