Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Events and Logs API #202

Merged
merged 40 commits into from
Jul 11, 2022
Merged

Events and Logs API #202

merged 40 commits into from
Jul 11, 2022

Conversation

scheler
Copy link
Contributor

@scheler scheler commented May 11, 2022

We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK. This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.

@scheler scheler requested a review from a team May 11, 2022 02:20
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 11, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
@MSNev
Copy link

MSNev commented May 31, 2022

Related issue, which could allow for having a common EventsApi for using Logs or Traces, if the Attributes definition is expanded to match the protocol. open-telemetry/opentelemetry-specification#2581

@bogdandrutu
Copy link
Member

As logs approvers, I would like more opinions:

@kumoroku
@djaglowski
@zenmoto

text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
text/0202-events-api.md Outdated Show resolved Hide resolved
@tigrannajaryan
Copy link
Member

All, Log SIG has been discussing this initiative for the last few weeks. If you want to talk about this live please join the Log SIG meeting today.

@tigrannajaryan
Copy link
Member

All, we had an extensive discussion of this OTEP in Log SIG. There is one major blocker which prevents us from moving forward: whether there needs to be a single Logs/Events API or 2 separate APIs.

I started a document to compare the 2 approaches (separate vs one API) side-by-side: https://docs.google.com/document/d/1Uy5L3UThFyc4PelgH51G3OCLFbvzq2xWiNDy2G8iXxU/edit#
The document also has the links to prototypes with both approaches.

We agreed in the Log SIG we are going to make the choice by the next Log SIG (next Wed). If you have any opinion on this topic please add arguments in favour of the one of the approach to the document.

Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OTEP no longer contains the details that describe the API precisely and only contains the general description of the intent to add one.
I think this is fine, we do allow OTEPs which are an "intent", with a purpose to seek alignment in Otel community.
I agree with the intent and that's why I am approving the OTEP. The details of the Logs and Events API can be either a follow-up OTEP or direct PRs to the spec repo.

@tigrannajaryan
Copy link
Member

@open-telemetry/specs-logs-approvers please review.

@tigrannajaryan
Copy link
Member

@open-telemetry/specs-approvers please review.

@dyladan
Copy link
Member

dyladan commented Jul 1, 2022

The OTEP no longer contains the details that describe the API precisely and only contains the general description of the intent to add one. I think this is fine, we do allow OTEPs which are an "intent", with a purpose to seek alignment in Otel community. I agree with the intent and that's why I am approving the OTEP. The details of the Logs and Events API can be either a follow-up OTEP or direct PRs to the spec repo.

I think we should clarify what is meant to be in an OTEP and how far it is acceptable to diverge from the OTEP when writing spec. The specification parts of this OTEP were removed because of concerns that it was too prescriptive and didn't leave room for the spec to make any decisions if something came up in a language SIG which required a change. If we're just going to add those things back in a follow-up OTEP, then maybe they should be added back to this one (with my apologies to @scheler and others who removed those at least partially due to my comments)?

@tigrannajaryan
Copy link
Member

I think we should clarify what is meant to be in an OTEP and how far it is acceptable to diverge from the OTEP when writing spec.

Normally some refinement happens when writing the spec. This is expected.

The specification parts of this OTEP were removed because of concerns that it was too prescriptive and didn't leave room for the spec to make any decisions if something came up in a language SIG which required a change. If we're just going to add those things back in a follow-up OTEP, then maybe they should be added back to this one (with my apologies to @scheler and others who removed those at least partially due to my comments)?

I think this OTEP in its current form is essentially an alignment document, which seeks agreement to add the Events and Logs API. It does not define the API itself and that's fine. We can define the API by working directly on the spec repo (like we did in the past for Traces).

@tigrannajaryan
Copy link
Member

@open-telemetry/specs-approvers @open-telemetry/specs-trace-approvers @open-telemetry/specs-logs-approvers @open-telemetry/specs-metrics-approvers We have enough approvals to merge. I am going to let this open for a couple more days, but unless I see objections I am going to merge this OTEP and proceed to defining/adding the new Events and Logs API to Otel specification.

@tigrannajaryan
Copy link
Member

No new comments, no objections for the last 5 days. Merging.

@tigrannajaryan tigrannajaryan merged commit d226b67 into open-telemetry:main Jul 11, 2022
itaykat pushed a commit to itaykat/oteps that referenced this pull request Sep 14, 2022
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
itaykat pushed a commit to itaykat/oteps that referenced this pull request Nov 16, 2022
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 23, 2024
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 23, 2024
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 30, 2024
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
carlosalberto pushed a commit to open-telemetry/opentelemetry-specification that referenced this pull request Nov 8, 2024
We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.  This is meant to be used by end-users for creating Events and by the Log Appender authors to create Logs.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.