[Gap]: Document console usage and event retention for both gateways
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 62/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- helm
调研方向
Start with the existing Connector Gateway Tool Usage and Activity pages, the AI Gateway budget guides, the Enterprise Manager Helm reference, and the audit-log forwarding guides, and search them for retention wording. Add a section that covers each listed point: the four-week default, weekly partitions, both retention settings, the captured-text window, and the note that the three-month chart does not extend history. Done means every point appears with the correct setting names, and the Helm guidance states that a dedicated Connector Gateway setting is not yet available.
由索引模型根据 Issue 内容生成。
描述
What needs documentation?
Document retention for the usage metrics and event history backing the Connector Gateway and AI Gateway console views, including defaults, supported configuration, and cleanup behavior.
Cover:
- Both gateways default to four weeks of event retention, configurable from 1–12 weeks.
- Retention uses weekly UTC partitions: four complete previous weeks plus the current week, with hourly cleanup by default, rather than an exact rolling 28-day deletion cutoff.
- AI Gateway usage/spend retention is configured through
enterprise-manager.appConfig.budgets.retentionWeeks. - Connector Gateway tool-call usage/activity retention currently uses the Enterprise Manager environment variable
ENTERPRISE_METERING_PARTMAN_RETENTION_WEEKS, supplied throughenterprise-manager.extraEnvwhen using Helm. Document a dedicated Helm setting when it becomes available in a released version. - Budget totals and dimension counters survive event partition cleanup; explain which views remain available and which depend on retained events.
- Captured AI conversation text, when enabled, has independent retention: seven days after the last turn by default, configurable through
appConfig.budgets.captureInactivityWindow, capped at thirty days. - External audit-log retention is controlled by the operator's log pipeline/SIEM and is separate from console-data retention.
Explain that selecting a three-month chart window does not extend stored history. The Connector Gateway Tool Usage page currently describes a three-month trend without explaining the four-week storage default.
Context and references
The relevant documentation includes the Connector Gateway Tool Usage and connector Activity guidance, the AI Gateway budget guides, and the Enterprise Manager Helm reference. Both gateways already have audit-log forwarding guides that describe externally managed retention, but those guides do not cover console-data storage.
Use case
As a platform operator, I need to know how much usage and activity history the console keeps, how to configure that window, and whether older aggregate totals remain available. This helps me size database storage, interpret incomplete chart history, and decide whether I need an external audit archive for longer retention.
Additional context
Documentation coverage checked on October 15, 2026. The docs contain references to retention clamping in generated API descriptions and generic appConfig/extraEnv Helm guidance, but no operator-facing explanation of these defaults and settings.
Document the supported configuration for the released platform version. Document a dedicated Connector Gateway retention Helm setting when available; existing retention behavior can be documented independently.
- 主要语言
- JavaScript
- 星标
- 4
- 派生
- 4
- 平均合并
- 22 小时 31 分钟
- 30 天内合并 PR
- 70
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
stacklok/docs-website 的其他 Issue
-
documentation enhancement needs-triage
难度 2/5 1-3 小时 新手友好度 82/100
stacklok/docs-website#1258 ·
维护者通常 1 天内回复
-
documentation enhancement needs-triage
难度 1/5 1 小时以内 新手友好度 85/100
stacklok/docs-website#1241 ·
维护者通常 1 天内回复
-
bug documentation needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#1149 · 2 条评论 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 68/100
stacklok/docs-website#1143 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#564 · 1 条评论 ·
维护者通常 1 天内回复
查看 stacklok/docs-website 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
维护者通常 1 天内回复
-
type/bug
难度 2/5 1-3 小时 新手友好度 62/100
flarum/framework#5301 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
AOSSIE-Org/BabyNest#284 ·
维护者通常 1 天内回复
-
status:untriaged
难度 1/5 1 小时以内 新手友好度 86/100
midnightntwrk/servicedesk#275 ·
维护者通常 1 天内回复