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 摘要。