You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/source/ray-observability/user-guides/ray-event-export.rst
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,15 +27,20 @@ Event format
27
27
Events are JSON objects in the POST request body.
28
28
29
29
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.
31
31
32
32
Task events
33
33
^^^^^^^^^^^
34
34
35
35
For each task, Ray exports two types of events: Task Definition Event and Task Execution Event.
36
36
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.
39
44
40
45
An example of the task events is as follows:
41
46
@@ -108,4 +113,15 @@ An example of the task events is as follows:
108
113
"workerPid":0
109
114
},
110
115
"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