Skip to content

Commit ffa2c3d

Browse files
committed
fix comments
Signed-off-by: Mengjin Yan <[email protected]>
1 parent 706207a commit ffa2c3d

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed
45.6 KB
Loading

doc/source/ray-observability/user-guides/ray-event-export.rst

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,20 @@ Event format
2727
Events are JSON objects in the POST request body.
2828

2929
All events contains the same base fields and different event specific fields.
30-
See ``src/ray/protobuf/events_base_event.proto`` for the base fields.
30+
See `src/ray/protobuf/events_base_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/events_base_event.proto>`_ for the base fields.
3131

3232
Task events
3333
^^^^^^^^^^^
3434

3535
For each task, Ray exports two types of events: Task Definition Event and Task Execution Event.
3636

37-
* Task Definition Event generated once per task attempt. It contains the metadata of the task. See ``src/ray/protobuf/events_task_definition_event.proto`` and ``src/ray/protobuf/actor_task_definition_event.proto`` for the event format for normal tasks and actor tasks respectively.
38-
* Task Execution Event contains the task state transition information and metadata that generated during the task execution. See ``src/ray/protobuf/events_task_execution_event.proto`` for the event format.
37+
* Task Definition Event generated once per task attempt. It contains the metadata of the task.
38+
See `src/ray/protobuf/public/events_task_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_task_definition_event.proto>`_
39+
and `src/ray/protobuf/public/events_actor_task_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_task_definition_event.proto>`_ for the event format for normal tasks
40+
and actor tasks respectively.
41+
* Task Execution Event contains the task state transition information and metadata that
42+
generated during the task execution.
43+
See `src/ray/protobuf/public/events_task_execution_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_task_execution_event.proto>`_ for the event format.
3944

4045
An example of the task events is as follows:
4146

@@ -108,4 +113,15 @@ An example of the task events is as follows:
108113
"workerPid":0
109114
},
110115
"message":""
111-
}
116+
}
117+
118+
High-level Architecture
119+
-----------------------
120+
121+
The following diagram shows the high-level architecture of Ray event export.
122+
123+
.. image:: ../images/ray-event-export.png
124+
125+
Ray introduces a new aggregator agent on the head node and each worker nodes. All the
126+
Ray components send events to the aggregator agent through gRPC. The aggregator agent
127+
collects the events and sends them to the configured HTTP endpoint.

0 commit comments

Comments
 (0)