Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Gap]: Document console usage and event retention for both gateways

Đang mở
  • Có gì không ổn?
#1,243 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
helm
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement needs-triage
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 through enterprise-manager.extraEnv when 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.

Ngôn ngữ chính
JavaScript
Star
4
Fork
4
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
58

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.