Event basics

[trask]

No description provided.

[jack-berg]

I know this is just a draft, but I support the ideas here. Let's have the debate about the high level direction of events and logs once, here. Assuming we agree and merge, we can focus on the details of making the vision a reality, without having to re-litigate the overall direction with each discussion.

[trask]

(just a heads up to reviewers, due to volume of comments, I'm resolving those that I think are addressed so we can focus on the remaining questions, but please feel free to unresolve any if you think they need more discussion)

EDIT: since some of the discussions are quite long, instead of unresolving it may help instead to start a new discussion with a summary of remaining discussion points (along with a pointer to the prior discussion for full context)

[lmolkova]

WRT why do we need new APIs (leaving naming aside), I created this comparison of key features

Feature	Event/Logging v2 API	'Traditional' Logging API
Formatted string body	❔ not a priority	✅ common case
Complex body	✅ common case	❌ usually not supported or stringified
Extra properties	✅ attributes	✅ attributes (or not supported)
Named and identifiable	✅ always	❔ (depends on app, inconsistent)
Predictable structure	✅ highly encouraged	❔ (depends on app, inconsistent)
Semantics and stability guarantees	➕ depends on app, encouraged	❔ (depends on app, usually no expectations)
How to consume	💻 query, aggregate, auto-analyze	❔ read + grep by humans, parse and re-create structure to be used by tools. Depends on app
Filtering by scope + name + severity (API support)	future	✅ yes, usually by scope + severity
Severity	❔ optional	✅ required
Context	✅ explicit	❔ implicit or none

[update] big thanks to @cijothomas for pointing out difference around severity

[dyladan]

Looks good to me. Thanks for putting this together

[pellared]

nit:

Currently, we have Logs Bridge API and Logs SDK.

Shouldn't we rename Log API to Logs API in this document?

[svrnm]

lgtm

[scheler]

Events API can be merged with Logs API as long as the Logs API does not evolve to become bloated with a boat load of features that other logging libraries provide. Those will not be applicable to Events, so someone wanting just Events API should not be forced to use the much-larger Logs API.

[XSAM]

LGTM 👍 I like this!

[jsuereth]

This OTEP now passes requirements to merge, outside of waiting 2 business days after the last change. This will be merged tomorrow.