opensearch-project/alerting-dashboards-plugin

[FEATURE] Document content of ctx for better message composition

Open

#1209 aperta il 13 feb 2025

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)JavaScript (118 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (31 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Is your feature request related to a problem?

When I am creating an alert message, I want the message to contain as much information as possible, but I do not know the structure of the ctx element and what it contains.

What solution would you like? A dump of a sample ctx object from the query I am alerting on.

What alternatives have you considered? A link to a document that explains the structure of the ctx document.

Do you have any additional context?

This screenshot shows the problem: OK I get a link to mustache templates, but that isn't of much help!

Image

Guida contributor

Direzione di ricerca
Esamina la struttura dell'oggetto contesto (ctx) del plugin di allerta e fornisci un dump di esempio o un collegamento alla documentazione esistente che spiega i suoi campi.
Tech stack
javascripttypescript
Dominio
frontenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85