Skip to content

Commit

Permalink
Add OpenTelemetry diag logger
Browse files Browse the repository at this point in the history
In order to get more information when our users encounter issues, the
OpenTelemetry diag logger is now enabled when the AppSignal log level is
set to trace.
  • Loading branch information
luismiramirez committed Jan 10, 2024
1 parent e37f91b commit 6d4cd2b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .changesets/add-opentelemetry-diag-logger.md
@@ -0,0 +1,6 @@
---
bump: "patch"
type: "add"
---

When the AppSignal log level is set to "trace". Additional information from the OpenTelemetry instrumentations is now logged.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions src/client.ts
Expand Up @@ -9,6 +9,7 @@ import { demo } from "./demo"
import { VERSION } from "./version"
import { setParams, setSessionData } from "./helpers"
import { BaseLogger, Logger, LoggerFormat, LoggerLevel } from "./logger"
import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api"

import { Instrumentation } from "@opentelemetry/instrumentation"
import {
Expand Down Expand Up @@ -157,6 +158,7 @@ export class Client {
this.#metrics = new Metrics()
if (this.config.data.initializeOpentelemetrySdk) {
this.#sdk = this.initOpenTelemetry()
this.setUpOpenTelemetryLogger()
}
}
} else {
Expand Down Expand Up @@ -416,6 +418,17 @@ export class Client {
return logger
}

/**
* Sets up the OpenTelemetry diag logger based on our integration logger level.
* If our integration logger level is "silly" ("trace"), the OpenTelemetry diag debug messages
* are logged.
*/
private setUpOpenTelemetryLogger(): void {
if (this.config.data["logLevel"] === "trace") {
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG)
}
}

/**
* Stores the client in global object after initializing
*/
Expand Down

0 comments on commit 6d4cd2b

Please sign in to comment.