From 24babe796f9415d411a8fc47e3d8a09ab5dc11c1 Mon Sep 17 00:00:00 2001 From: David Ramirez Date: Fri, 4 Aug 2023 19:37:27 +0000 Subject: [PATCH] Updated docstring on KytosEvent --- kytos/core/events.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/kytos/core/events.py b/kytos/core/events.py index 9a266cb2..501ac309 100644 --- a/kytos/core/events.py +++ b/kytos/core/events.py @@ -12,8 +12,24 @@ class KytosEvent: """Base Event class. - The event data will be passed in the `content` attribute, which should be a - dictionary. + Args: + `name`: + The name of the event. You should prepend it with + the name of the napp. + + `content`: + Dictionary with any extra data for the event. + + `trace_parent`: + APM TraceParent for distributed tracing, + if you have APM enabled, `@listen_to` will + set the root parent, and then you have to + pass the trace_parent to subsequent + correlated KytosEvent(s). + + `priority`: + Priority of this event if a `PriorityQueue` is being + used, the lower the number the higher the priority. """ name: str