Dashboards: a stored per-dashboard default for the release-marker and alert-annotation toggles

Đang mở
#3,279 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
react, typescript
Lĩnh vực
api, full-stack, observability

Hướng nghiên cứu

Start with DBDashboardPage.tsx and trace the dashboard model and v2 external API entry points mentioned in the issue. Define how optional releaseMarkers and alertAnnotations values are stored and exposed, preserving URL-parameter precedence and current behavior when fields are absent; done means the UI and API support per-dashboard defaults consistently.

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

Mô tả

external

What are you trying to do?

We keep our HyperDX dashboards as files in a repository and apply them through the dashboards API, and a few of them exist to answer "did this deploy change things?". For those, release markers are the point of the dashboard, so we want them showing whenever someone opens it. The release-marker toggle (#2894) and the alert-annotation toggle live only in the URL (releaseMarkers=true, alertAnnotations=true), and DBDashboardPage.tsx describes them as "Ephemeral view state (URL param), not persisted on the dashboard". Someone who opens the dashboard from the sidebar, a search or a bookmark without the parameter doesn't see markers until they turn them on.

What would you like to see?

An optional per-dashboard default for each toggle, stored with the dashboard and settable through the API, such as releaseMarkers: true and alertAnnotations: true on the dashboard document. The URL parameter would still win, so ?releaseMarkers=false turns the markers off for one view and nothing else changes. The stored value only replaces the hard-coded false default. Dashboards without the field behave as now.

Alternatives you've considered

We add ?releaseMarkers=true to every link we publish. That covers the links we control and misses every other way of opening the dashboard. We also considered asking for markers to default to on wherever a source has a service version expression, but that changes every dashboard's behaviour and its query load, which a per-dashboard opt-in avoids.

Anything else?

The change is in the dashboard schema, UI and API: a field in the dashboard model and the v2 external API, and the toggle's default in DBDashboardPage.tsx. A "save as default" control beside the toggle could follow. If keeping the toggles out of the dashboard document was a deliberate choice, we'd like to hear why, and we're happy to take a different approach. We'd also gladly write the change if you want it.

Posted by Claude Code on behalf of Jun Matsushita.

Ngôn ngữ chính
TypeScript
Star
10.1k
Fork
527
Merge trung bình
1 ngày 20 giờ
Pull request đã merge (30 ngày)
186

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

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 ClickHouse/ClickStack

Tất cả issue của ClickHouse/ClickStack

Issue tương tự

Thêm issue về TypeScript

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.