[log] feat(config): add debug logging to guard policy validation and parsing#2168
Draft
github-actions[bot] wants to merge 1 commit intomainfrom
Draft
[log] feat(config): add debug logging to guard policy validation and parsing#2168github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Add logGuardPolicy debug calls to ValidateGuardPolicy, ValidateWriteSinkPolicy, ParseServerGuardPolicy, and ParsePolicyMap to improve troubleshootability when guard policy configuration issues occur. - ValidateGuardPolicy: logs nil policy, write-sink delegation with accept count, and allow-only normalization delegation - ValidateWriteSinkPolicy: logs accept count and wildcard detection - ParseServerGuardPolicy: logs serverID and key count on entry - ParsePolicyMap: logs detected policy format (allow-only/write-sink/legacy) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
4 tasks
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
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
logGuardPolicydebug log calls to four key functions ininternal/config/guard_policy.gothat previously had no logging, improving troubleshootability when guard policy configuration issues arise.Changes
File:
internal/config/guard_policy.goAdded 7 targeted debug log calls (reusing existing
logGuardPolicy = logger.New("config:guard_policy")):ValidateGuardPolicynil(clarifies the error path)acceptCountValidateWriteSinkPolicyacceptCounton entry for visibility into policy size["*"]) as a distinct valid pathParseServerGuardPolicyserverIDandkeyCounton entry to trace which server's policy is being parsedParsePolicyMaphasAllowOnly,hasWriteSink) after key detection, distinguishing modern vs legacy policy map formatWhy This Matters
These functions are the critical path for guard policy configuration parsing and validation. When a misconfigured policy causes startup failures, these log calls (enabled via
DEBUG=config:guard_policyorDEBUG=*) will immediately surface:Testing
internal/config/guard_policy.gologGuardPolicylogger — no new imports