From 31dd7b72588a2490b52577efe021445426cd7dda Mon Sep 17 00:00:00 2001 From: Altinok Darici Date: Wed, 1 Mar 2023 13:53:13 -0800 Subject: [PATCH] Rename Diag/LoggerOptions to DiagLoggerOptions (#3641) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Rename LoggerOptions to DiagLoggerOptions * Change log --------- Co-authored-by: Marc Pichler Co-authored-by: Gerhard Stöbich Co-authored-by: Daniel Dyla --- api/CHANGELOG.md | 1 + api/src/diag/types.ts | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md index cc96483c766..be8c623e847 100644 --- a/api/CHANGELOG.md +++ b/api/CHANGELOG.md @@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file. ### :bug: (Bug Fix) * fix(metrics): export `MetricsAPI` type [#3535](/~https://github.com/open-telemetry/opentelemetry-js/pull/3535) +* fix(api): rename `LoggerOptions` to `DiagLoggerOptions` [#3641](/~https://github.com/open-telemetry/opentelemetry-js/pull/3641) ## 1.4.0 diff --git a/api/src/diag/types.ts b/api/src/diag/types.ts index e861d430c1f..588b525ec65 100644 --- a/api/src/diag/types.ts +++ b/api/src/diag/types.ts @@ -97,7 +97,7 @@ export interface ComponentLoggerOptions { namespace: string; } -export interface LoggerOptions { +export interface DiagLoggerOptions { /** * The {@link DiagLogLevel} used to filter logs sent to the logger. * @@ -117,10 +117,10 @@ export interface DiagLoggerApi { * If a global diag logger is already set, this will override it. * * @param logger - The {@link DiagLogger} instance to set as the default logger. - * @param options - A {@link LoggerOptions} object. If not provided, default values will be set. + * @param options - A {@link DiagLoggerOptions} object. If not provided, default values will be set. * @returns `true` if the logger was successfully registered, else `false` */ - setLogger(logger: DiagLogger, options?: LoggerOptions): boolean; + setLogger(logger: DiagLogger, options?: DiagLoggerOptions): boolean; /** *