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

未關閉
#3,279 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
48/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
react, typescript

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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.

主要語言
TypeScript
星號
10.1k
分支
527
平均合併
1 天 20 小時
30 天內合併 PR
186

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

ClickHouse/ClickStack 的其他 Issue

查看 ClickHouse/ClickStack 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。