Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a human-readable message as an attribute representing the event #1076

Open
alexvanboxel opened this issue May 26, 2024 · 0 comments
Open
Labels
area:event enhancement New feature or request

Comments

@alexvanboxel
Copy link

Area(s)

area:event

Is your change request related to a problem? Please describe.

Many logging tools have a convention where, upon finding a "message" or "msg" field in a structured log, they'll display its contents prominently for easier user analysis. Since we're establishing event definitions, we can include a human-readable representation of each event. Think of it like a span name in a trace: it carries no inherent meaning but aids user comprehension.

Describe the solution you'd like

Include an event.message attribute that provides a clear, concise, and human-readable description of the event.

Describe alternatives you've considered

Following the convention used in some logging tools, we could try to utilize a message field in the event body. However, this clashes with the principle that each event can freely define its own fields.

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:event enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

3 participants