expose client ID in config and on client #206
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
bgentry
force-pushed
the
bg-expose-client-id
branch
from
2858bd2
to
858713b
Compare
|
really neat thanks! :) |
brandur
approved these changes
Feb 17, 2024
client.go
Outdated
| @@ -101,6 +101,15 @@ type Config struct { | |||
| // Defaults to 1 second. | |||
| FetchPollInterval time.Duration | |||
|
|
|||
| // ID is the unique identifier for this client. If not set, a random ULID will | |||
There was a problem hiding this comment.
What do you think about saying "random identifier" instead of "random ULID" here?
I'm kind of thinking that we shouldn't commit to the ULID algorithm specifically — it'd be nice to get rid of that dependency, and also I think a more human friendly combination of say host name plus start time might be a better default for operations anyway. Not something we need to do right now, but if we changed it, it'd a minor alteration of the contract above.
There was a problem hiding this comment.
I made that change and also relocated some relevant language that we had stashed on JobRow.AttemptedBy so that the full explanation is only given on the Config.ID field now.
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.
Inspired by #203, I wanted to make the client IDs configurable by the user and also programmatically accessible (in the event a user decides to rely on auto-generated client IDs). This PR achieves both.