Skip to content

Add otel.event.name attribute reserved for OpenTelemetry #2597

@pellared

Description

@pellared

Area(s)

area:otel

What's missing?

Scenario 1: exporting event records for non-OTLP exporters

Non-OTLP exporters (e.g. a console/stdout exporter) need to emit EventName .

Scenario 2: emitting event records using logging libraries

Application developers that are already using some existing logging libraries (like log4j) may not want to additionally depend on OTel Logs API in places where they want to emit application-specific event records. Most logging libraries do not have a "event name" or "event ID" concept.

Describe the solution you'd like

Add otel.event_name attribute to the OTel attributes registry.

Scenario 1:
The non-OTLP exporters (like stdout exporter) can add otel.event_name attribute when exporting event records.

Scenario 2:
Users of non-OTel logging libraries can add otel.event_name attribute/field when emitting logs. Then the SDK or Collector can be configured with a log record processor that sets the EventName on log records that contain the otel.event_name attribute.
Prior art:

Other attribute keys that were considered:

  • event.name - it is already deprecated. It is more probable to have collision with some attributes/fields that are already used by the end users. otel. prefix is already a convention for mapping with non-OTLP/OTel models
  • otel.event_name - this was the original proposal, @trask gave feedback that having event. scopes it under "event" signal/domain

Tip

React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.

Metadata

Metadata

Assignees

Projects

Status

No status

Status

Need triage

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions