Skip to content

Commit

Permalink
Updated docstring on KytosEvent
Browse files Browse the repository at this point in the history
  • Loading branch information
Ktmi committed Aug 4, 2023
1 parent 9a7d7ab commit 24babe7
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions kytos/core/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 24babe7

Please sign in to comment.