opensearch-project/alerting-dashboards-plugin

[FEATURE] Document content of ctx for better message composition

Open

#1 209 ouverte le 13 févr. 2025

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)JavaScript (118 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (31 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez la structure de l'objet contexte (ctx) du plugin d'alerte et fournissez un exemple de dump ou un lien vers la documentation existante expliquant ses champs.
Stack technique
javascripttypescript
Domaine
frontenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85