Skip to content

Commit 9a1c3b8

Browse files
authored
deprecate event logger (#1466)
The event logger was a Development-status component of the logging signal. It has been removed in favour of adding emitEvent to the logger interface, see open-telemetry/opentelemetry-specification#4319
1 parent 39157e9 commit 9a1c3b8

8 files changed

+32
-1
lines changed

Diff for: Logs/EventLogger.php

+4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
use OpenTelemetry\Context\Context;
1313
use OpenTelemetry\Context\ContextInterface;
1414

15+
/**
16+
* @deprecated
17+
* @phan-suppress PhanDeprecatedInterface
18+
*/
1519
class EventLogger implements EventLoggerInterface
1620
{
1721
/**

Diff for: Logs/EventLoggerProvider.php

+6
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,18 @@
77
use OpenTelemetry\API\Common\Time\Clock;
88
use OpenTelemetry\API\Logs\EventLoggerInterface;
99

10+
/**
11+
* @phan-suppress PhanDeprecatedInterface
12+
*/
1013
class EventLoggerProvider implements EventLoggerProviderInterface
1114
{
1215
public function __construct(private readonly LoggerProviderInterface $loggerProvider)
1316
{
1417
}
1518

19+
/**
20+
* @phan-suppress PhanDeprecatedClass
21+
*/
1622
public function getEventLogger(string $name, ?string $version = null, ?string $schemaUrl = null, iterable $attributes = []): EventLoggerInterface
1723
{
1824
return new EventLogger(

Diff for: Logs/EventLoggerProviderFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
use OpenTelemetry\SDK\Sdk;
88

9+
/**
10+
* @deprecated
11+
*/
912
class EventLoggerProviderFactory
1013
{
1114
public function create(LoggerProviderInterface $loggerProvider): EventLoggerProviderInterface

Diff for: Logs/EventLoggerProviderInterface.php

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
use OpenTelemetry\API\Logs as API;
88

9+
/**
10+
* @phan-suppress PhanDeprecatedInterface
11+
*/
912
interface EventLoggerProviderInterface extends API\EventLoggerProviderInterface
1013
{
1114
public function forceFlush(): bool;

Diff for: Logs/NoopEventLoggerProvider.php

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
use OpenTelemetry\API\Logs as API;
88

9+
/**
10+
* @phan-suppress PhanDeprecatedInterface
11+
*/
912
class NoopEventLoggerProvider extends API\NoopEventLoggerProvider implements EventLoggerProviderInterface
1013
{
1114
public static function getInstance(): self

Diff for: Sdk.php

+3
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ public function getLoggerProvider(): LoggerProviderInterface
6060
return $this->loggerProvider;
6161
}
6262

63+
/**
64+
* @deprecated
65+
*/
6366
public function getEventLoggerProvider(): EventLoggerProviderInterface
6467
{
6568
return $this->eventLoggerProvider;

Diff for: SdkAutoloader.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ public static function autoload(): bool
7474
return true;
7575
}
7676

77+
/**
78+
* @phan-suppress PhanDeprecatedClass,PhanDeprecatedFunction
79+
*/
7780
private static function environmentBasedInitializer(Configurator $configurator): Configurator
7881
{
7982
$propagator = (new PropagatorFactory())->create();
@@ -110,7 +113,7 @@ private static function environmentBasedInitializer(Configurator $configurator):
110113
}
111114

112115
/**
113-
* @phan-suppress PhanPossiblyUndeclaredVariable
116+
* @phan-suppress PhanPossiblyUndeclaredVariable,PhanDeprecatedFunction
114117
*/
115118
private static function fileBasedInitializer(Configurator $configurator): Configurator
116119
{

Diff for: SdkBuilder.php

+6
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ public function setLoggerProvider(LoggerProviderInterface $loggerProvider): self
5959
return $this;
6060
}
6161

62+
/**
63+
* @deprecated
64+
*/
6265
public function setEventLoggerProvider(EventLoggerProviderInterface $eventLoggerProvider): self
6366
{
6467
$this->eventLoggerProvider = $eventLoggerProvider;
@@ -95,6 +98,9 @@ public function build(): Sdk
9598
);
9699
}
97100

101+
/**
102+
* @phan-suppress PhanDeprecatedFunction
103+
*/
98104
public function buildAndRegisterGlobal(): ScopeInterface
99105
{
100106
$sdk = $this->build();

0 commit comments

Comments
 (0)