feat: Add contextual logger #527
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
Returns a zerolog instance configured with the service name. We can add more contextual information going forward.
narbs91
reviewed
Mar 5, 2025
pkg/solver/controller.go
Outdated
| @@ -413,7 +421,7 @@ func (controller *SolverController) addJobOffer(jobOffer data.JobOffer) (*data.J | |||
| } | |||
| jobOffer.ID = id | |||
|
|
|||
| controller.log.Info("add job offer", jobOffer) | |||
| controller.log.Info().Any("jobOffer", jobOffer).Msg("add job offer") | |||
There was a problem hiding this comment.
Let's also add the jobOfferId as a key-value so it'll be a little easier to spot in the logs
There was a problem hiding this comment.
Yeah! Great idea. Added in 157cc4c
narbs91
reviewed
Mar 5, 2025
pkg/solver/controller.go
Outdated
| return nil, nil | ||
| } | ||
|
|
||
| controller.log.Info("add resource offer", resourceOffer) | ||
| controller.log.Info().Any("resourceOffer", resourceOffer).Msg("add resource offer") |
There was a problem hiding this comment.
Let's also add the resourceOfferId and resourceProviderId as a key-value so it'll be a little easier to spot in the logs
narbs91
reviewed
Mar 5, 2025
pkg/solver/controller.go
Outdated
| @@ -520,7 +535,7 @@ func (controller *SolverController) addDeal(ctx context.Context, deal data.Deal) | |||
| span.SetAttributes(attribute.String("deal.id", deal.ID)) | |||
| span.AddEvent("data.get_deal_id.done") | |||
|
|
|||
| controller.log.Info("add deal", deal) | |||
| controller.log.Info().Any("deal", deal).Msg("add deal") | |||
There was a problem hiding this comment.
Let's also add the dealId and the resourceProviderId of the RP whose going to do the job as key-value pairs here
There was a problem hiding this comment.
Also done in 157cc4c. Did the job creator ID as well.
narbs91
approved these changes
Mar 5, 2025
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.
Summary
This pull request makes the following changes:
GetLoggerhelper to get a logger with service contextSetupLoggingtoSetupGlobalLogger(to clarify its purpose)This pull request moves us towards a uniform logging system built around the
zerologinterface.We have also made a small naming change:
solverServerinstances toserver(we know we're in the solver)Task/Issue reference
Implements: #303
Test plan
Start the stack. Run a job. Make sure it all works.
Also may be of interest to run a job and compare the logs on
mainwith the logs in this pull request.Details
Our system currently uses a global
zerologimplementation in some places and a service logger in others. We would like to move to individualizedzerologloggers for each package or component that can be configured with additional context. This pull request starts with loggers configured with theservicethey log from.This pull request also updates the solver logs to replace global logger and service logger calls with the new contextualized logs. We have updated many of the existing logs with additional key-pairs which in some cases were not possible using the service logger. The additional key-pair fields support our upcoming OpenTelemetry work.
Related issues or PRs
Epic: https://github.com/Lilypad-Tech/internal/issues/345