feat: Add log level config option to SDK #315
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jairo-mendoza
commented
Oct 1, 2024
| @@ -33,32 +33,48 @@ export const FAILED_AUTH_FOR_LOCAL_VISUALIZATIONS = | |||
| ); | |||
|
|
|||
| export const validateOptionsWarnings = (options?: HoneycombOptions) => { | |||
| const logLevel = options?.logLevel | |||
There was a problem hiding this comment.
Q for this change: Are there any other areas we'd like to see the logs being controlled?
There was a problem hiding this comment.
If we search for console.* Looks like there's some statements in packages/honeycomb-opentelemetry-web/src/console-trace-link-exporter.ts.
We might need to tweak the API for ConsoleTraceLinkExporter to accept the full options object rather than just the service name.
pkanal
reviewed
Oct 7, 2024
Comment on lines
36
to
48
| constructor(serviceName?: string, apikey?: string) { | ||
| if (!serviceName || !apikey) { | ||
| console.debug(MISSING_FIELDS_FOR_LOCAL_VISUALIZATIONS); | ||
| this._logLevel >= DiagLogLevel.DEBUG && |
There was a problem hiding this comment.
Let's move this into a nested if clause so that it's explicit. Fall through side effects can be difficult to reason over.
wolfgangcodes
approved these changes
Oct 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Short description of the changes
Users will now have the option to set a log level when initializing the SDK. This log level controls the verbosity of logs outputted. The current log levels includes DEBUG, INFO, WARN, and ERROR.
How to verify that this has the expected result