Skip to content

Commit

Permalink
Rename Diag/LoggerOptions to DiagLoggerOptions (#3641)
Browse files Browse the repository at this point in the history
* Rename LoggerOptions to DiagLoggerOptions

* Change log

---------

Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
Co-authored-by: Gerhard Stöbich <deb2001-github@yahoo.de>
Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
  • Loading branch information
4 people authored Mar 1, 2023
1 parent a457d94 commit 31dd7b7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions api/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions api/src/diag/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand All @@ -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;

/**
*
Expand Down

0 comments on commit 31dd7b7

Please sign in to comment.