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

Abierto
#3,279 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
react, typescript

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
10.1k
Forks
527
Merge medio
1 d 20 h
PR fusionados (30 d)
186

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ClickHouse/ClickStack

Todos los issues de ClickHouse/ClickStack

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.