feat(cli): add configurable agent metadata report interval #21140
+15
−2
Conversation
This file contains hidden or 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
Add CODER_AGENT_REPORT_METADATA_INTERVAL env var to control how often the agent reports metadata to the Coder server. This helps reduce database load from pg_notify spam in deployments with many agents. The default remains 1s for backwards compatibility, but operators can now increase this interval if they experience database pressure from metadata updates.
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
Adds
CODER_AGENT_REPORT_METADATA_INTERVALenvironment variable to control how often the workspace agent reports metadata to the Coder server.Problem
The agent publishes metadata updates via
pg_notifyevery 1 second by default. At scale with many agents, this can cause significant database load from the pubsub notifications.Solution
Make the metadata report interval configurable via:
CODER_AGENT_REPORT_METADATA_INTERVAL--report-metadata-intervalThe default remains
1sfor backwards compatibility, but operators experiencing database pressure from metadata updates can now increase this interval (e.g.,5sor10s).Changes
reportMetadataIntervalvariable to CLI agent commandReportMetadataIntervaltoagent.OptionsinitializationCODER_AGENT_REPORT_METADATA_INTERVALTesting