Log process ID in each log entry #949
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
This will help differentiate multiple cli commands that write to the same log file. Noticed that the root module wasn't using the common log utilities, refactored it to avoid missing log arguments
pietern
reviewed
Nov 6, 2023
libs/log/logger.go
Outdated
| @@ -25,6 +26,7 @@ func log(logger *slog.Logger, ctx context.Context, level slog.Level, msg string) | |||
| // skip [runtime.Callers, this function, this function's caller]. | |||
| runtime.Callers(3, pcs[:]) | |||
| r := slog.NewRecord(time.Now(), level, msg, pcs[0]) | |||
| r.AddAttrs(slog.Int("pid", os.Getpid())) | |||
There was a problem hiding this comment.
You can cache the slog.Attr. I propose adding a pidAttr function (can be separate file because it is used from 2 places) that uses sync.Once to initialize a global that contains it. The PID doesn't change once a process has started, so it's not necessary to make the system call more than once.
There was a problem hiding this comment.
After reading the code and the docs, I've moved the pid attribute to the cmd/root/logger::initializeContext. With that change we aren't limited to using only our own libs/log/logger wrappers, but can also use logger instances from the context (as we do in the cmd/root)
andrewnester
approved these changes
Nov 7, 2023
pietern
changed the title
pietern
approved these changes
Nov 7, 2023
andrewnester
added a commit
that referenced
this pull request
Nov 8, 2023
CLI: * Hide `--progress-format` global flag ([#965](#965)). * Make configure command visible + fix bundle command description ([#961](#961)). * Log process ID in each log entry ([#949](#949)). * Improve error message when `--json` flag is specified ([#933](#933)). Bundles: * Remove validation for default value against pattern ([#959](#959)). * Bundle path rewrites for dbt and SQL file tasks ([#962](#962)). * Initialize variable definitions that are defined without properties ([#966](#966)). Internal: * Remove mention of Lakehouse apps from the changelog ([#945](#945)). * Function to merge two instances of `config.Value` ([#938](#938)). * Make to/from string methods private to the jsonschema package ([#942](#942)). * Make Cobra runner compatible with testing interactive flows ([#957](#957)). * Added `env.UserHomeDir(ctx)` for parallel-friendly tests ([#955](#955)). Dependency updates: * Bump golang.org/x/mod from 0.13.0 to 0.14.0 ([#954](#954)). * Bump golang.org/x/text from 0.13.0 to 0.14.0 ([#953](#953)). * Bump golang.org/x/sync from 0.4.0 to 0.5.0 ([#951](#951)). * Bump github.com/spf13/cobra from 1.7.0 to 1.8.0 ([#950](#950)). * Bump github.com/fatih/color from 1.15.0 to 1.16.0 ([#952](#952)).
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 8, 2023
CLI: * Hide `--progress-format` global flag ([#965](#965)). * Make configure command visible + fix bundle command description ([#961](#961)). * Log process ID in each log entry ([#949](#949)). * Improve error message when `--json` flag is specified ([#933](#933)). Bundles: * Remove validation for default value against pattern ([#959](#959)). * Bundle path rewrites for dbt and SQL file tasks ([#962](#962)). * Initialize variable definitions that are defined without properties ([#966](#966)). Internal: * Function to merge two instances of `config.Value` ([#938](#938)). * Make to/from string methods private to the jsonschema package ([#942](#942)). * Make Cobra runner compatible with testing interactive flows ([#957](#957)). * Added `env.UserHomeDir(ctx)` for parallel-friendly tests ([#955](#955)). Dependency updates: * Bump golang.org/x/mod from 0.13.0 to 0.14.0 ([#954](#954)). * Bump golang.org/x/text from 0.13.0 to 0.14.0 ([#953](#953)). * Bump golang.org/x/sync from 0.4.0 to 0.5.0 ([#951](#951)). * Bump github.com/spf13/cobra from 1.7.0 to 1.8.0 ([#950](#950)). * Bump github.com/fatih/color from 1.15.0 to 1.16.0 ([#952](#952)).
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.
Changes
This will help differentiate multiple cli commands that write to the same log file.
Noticed that the root module wasn't using the common log utilities, refactored it to avoid missing log arguments.
Relevant PR on the databricks vscode extension side: databricks/databricks-vscode#923
Tests
Tested manually for sdk and cli loggers