opensearch-project/alerting-dashboards-plugin

[FEATURE] Document content of ctx for better message composition

Open

#1.209 geöffnet am 13. Feb. 2025

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (118 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (31 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Sehen Sie sich die Struktur des Kontextobjekts (ctx) des Alerting Plugins an und stellen Sie einen Beispiel Dump oder einen Link zur vorhandenen Dokumentation bereit, die seine Felder erklärt.
Tech Stack
javascripttypescript
Domain
frontenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85