docs(storage): document task_tracker backend config from #1949#1971
Merged
qin-ctx merged 2 commits intoMay 11, 2026
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
qin-ctx
approved these changes
May 11, 2026
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
Document the new
storage.task_tracker.backendconfiguration field added in #1949 (zhoujh01 / MaojiaSheng, 2026-05-11T03:06:31Z,feat: Persist task tracker). Bothdocs/en/guides/01-configuration.mdanddocs/zh/guides/01-configuration.mdcurrently have zero mention oftask_tracker, so operators reading the configuration guide cannot discover the field or know to enablepersistentfor multi-instance deployments.What's documented
## storage.task_tracker Section(EN) /## storage.task_tracker 段(ZH) inserted adjacent tostorage.transactionin each filebackend: "memory"(preserves existing single-process behavior)TaskTrackerConfig.backend(Literal["memory","persistent"], default"memory") verbatim fromopenviking_cli/utils/config/storage_config.pypersistent(cross-instancetask_idlookup or restart survival)Description copy uses
task_typenaming (session_commit/add_resource/add_skill/admin_reindex) matching #1949 PR body. Limitations called out in the PR's "非目标" list (no auto-cleanup, no lease/heartbeat, no takeover, no CAS — last-write-wins) are deliberately NOT advertised as features.Verification
Notes
storage.transactionsection template (lead sentence → JSON example → parameter table → usage hint)"memory"is highlighted so single-instance operators upgrading do not feel pressured to flip the backend