Skip to content

Mark events API/SDK as deprecated #4654

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- Mark the Events API/SDK as deprecated. The Logs API/SDK should be used instead. An event is now a `LogRecord` with the `event_name` field set
([#4654](https://github.com/open-telemetry/opentelemetry-python/pull/4654)).
- Update OTLP proto to v1.7 [#4645](https://github.com/open-telemetry/opentelemetry-python/pull/4645).
- Add `event_name` as a top level field in the `LogRecord`. Events are now simply logs with the
`event_name` field set, the logs SDK should be used to emit events ([#4652](https://github.com/open-telemetry/opentelemetry-python/pull/4652)).
Expand Down
35 changes: 35 additions & 0 deletions opentelemetry-api/src/opentelemetry/_events/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
from os import environ
from typing import Optional, cast

from typing_extensions import deprecated

from opentelemetry._logs import LogRecord
from opentelemetry._logs.severity import SeverityNumber
from opentelemetry.environment_variables import (
Expand All @@ -30,6 +32,9 @@
_logger = getLogger(__name__)


@deprecated(
"You should use `LogRecord` with the `event_name` field set instead. Deprecated since version 1.35.0."
)
class Event(LogRecord):
def __init__(
self,
Expand Down Expand Up @@ -59,6 +64,9 @@ def __init__(
self.name = name


@deprecated(
"You should use `Logger` instead. Deprecated since version 1.35.0."
)
class EventLogger(ABC):
def __init__(
self,
Expand All @@ -77,11 +85,17 @@ def emit(self, event: "Event") -> None:
"""Emits a :class:`Event` representing an event."""


@deprecated(
"You should use `NoOpLogger` instead. Deprecated since version 1.35.0."
)
class NoOpEventLogger(EventLogger):
def emit(self, event: Event) -> None:
pass


@deprecated(
"You should use `ProxyLogger` instead. Deprecated since version 1.35.0."
)
class ProxyEventLogger(EventLogger):
def __init__(
self,
Expand Down Expand Up @@ -118,6 +132,9 @@ def emit(self, event: Event) -> None:
self._event_logger.emit(event)


@deprecated(
"You should use `LoggerProvider` instead. Deprecated since version 1.35.0."
)
class EventLoggerProvider(ABC):
@abstractmethod
def get_event_logger(
Expand All @@ -130,6 +147,9 @@ def get_event_logger(
"""Returns an EventLoggerProvider for use."""


@deprecated(
"You should use `NoOpLoggerProvider` instead. Deprecated since version 1.35.0."
)
class NoOpEventLoggerProvider(EventLoggerProvider):
def get_event_logger(
self,
Expand All @@ -143,6 +163,9 @@ def get_event_logger(
)


@deprecated(
"You should use `ProxyLoggerProvider` instead. Deprecated since version 1.35.0."
)
class ProxyEventLoggerProvider(EventLoggerProvider):
def get_event_logger(
self,
Expand Down Expand Up @@ -171,6 +194,9 @@ def get_event_logger(
_PROXY_EVENT_LOGGER_PROVIDER = ProxyEventLoggerProvider()


@deprecated(
"You should use `get_logger_provider` instead. Deprecated since version 1.35.0."
)
def get_event_logger_provider() -> EventLoggerProvider:
global _EVENT_LOGGER_PROVIDER # pylint: disable=global-variable-not-assigned
if _EVENT_LOGGER_PROVIDER is None:
Expand All @@ -186,6 +212,9 @@ def get_event_logger_provider() -> EventLoggerProvider:
return cast("EventLoggerProvider", _EVENT_LOGGER_PROVIDER)


@deprecated(
"You should use `_set_logger_provider` instead. Deprecated since version 1.35.0."
)
def _set_event_logger_provider(
event_logger_provider: EventLoggerProvider, log: bool
) -> None:
Expand All @@ -201,12 +230,18 @@ def set_elp() -> None:
)


@deprecated(
"You should use `set_logger_provider` instead. Deprecated since version 1.35.0."
)
def set_event_logger_provider(
event_logger_provider: EventLoggerProvider,
) -> None:
_set_event_logger_provider(event_logger_provider, log=True)


@deprecated(
"You should use `get_logger` instead. Deprecated since version 1.35.0."
)
def get_event_logger(
name: str,
version: Optional[str] = None,
Expand Down
8 changes: 8 additions & 0 deletions opentelemetry-sdk/src/opentelemetry/sdk/_events/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
from time import time_ns
from typing import Optional

from typing_extensions import deprecated

from opentelemetry import trace
from opentelemetry._events import Event
from opentelemetry._events import EventLogger as APIEventLogger
Expand All @@ -26,6 +28,9 @@
_logger = logging.getLogger(__name__)


@deprecated(
"You should use `Logger` instead. Deprecated since version 1.35.0."
)
class EventLogger(APIEventLogger):
def __init__(
self,
Expand Down Expand Up @@ -65,6 +70,9 @@ def emit(self, event: Event) -> None:
self._logger.emit(log_record)


@deprecated(
"You should use `LoggerProvider` instead. Deprecated since version 1.35.0."
)
class EventLoggerProvider(APIEventLoggerProvider):
def __init__(self, logger_provider: Optional[LoggerProvider] = None):
self._logger_provider = logger_provider or get_logger_provider()
Expand Down
Loading