docs(observability): document server.observability.usage_audit in config hierarchy#2473
Open
r266-tech wants to merge 2 commits into
Open
docs(observability): document server.observability.usage_audit in config hierarchy#2473r266-tech wants to merge 2 commits into
r266-tech wants to merge 2 commits into
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
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.
The Observability config hierarchy section lists
server.observability.{metrics,traces,logs,dump_body}but omitsserver.observability.usage_audit, even though it is a real wired subkey ofObservabilityConfig.Source-grounded in
openviking/server/config.py:class UsageAuditConfig(L89):enabled: bool = True(L92),backend: Literal["sqlite"] = "sqlite"(L93),sqlite_path: Optional[str] = None(L94),timezone: str = "local"(L102)class ObservabilityConfig→usage_audit: UsageAuditConfig = Field(default_factory=UsageAuditConfig)(L126)This gap became conspicuous after #2442: the multi-instance deployment notes (
03-deployment.md) now direct operators to setserver.observability.usage_audit.sqlite_pathfor per-instance paths, but the observability config hierarchy — the canonical place that enumerates theserver.observability.*subkeys — does not listusage_auditat all, so an operator cannot discoverenabled/sqlite_path/timezonefrom the hierarchy.Adds the missing
usage_auditbullet + an entry in the config example, matching the existingdump_bodydocumentation style (#2063). EN + ZH mirrored.