Simple Log Service:Syntaxe des nouveaux modèles d'alerte

Présentation

La nouvelle syntaxe est entièrement compatible avec la syntaxe originale, mais utilise des types, des valeurs et des styles différents pour les attributs d'alerte. Nous vous recommandons d'utiliser uniquement la nouvelle syntaxe et d'éviter de mélanger les deux.

Démarrage rapide

Les exemples suivants illustrent le contenu des notifications défini dans les nouveaux modèles d'alerte.

• Contenu de l'alerte :

  {
      "alert_id": "test-alert",
      "alert_name": "PV/UV Alert",
      "project": "project-1",
      "status": "firing",
      "severity": 6,
      "labels": {
          "app": "nginx",
          "host": "host-1"
      },
      "results": [
          {
              "project": "project-1",
              "logstore": "logstore-1",
              "query": "* | select count(*) as pv"
          },
          {
              "project": "project-2",
              "logstore": "logstore-2",
              "query": "* | select count(distinct user_id) as uv"
          }
      ]
  }

• Configuration du modèle d'alerte :

  - Alert ID: {{ alert.alert_id }}
  - Alert Name: {{ alert.alert_name }}
  - Project: {{ alert.project }}
  - Status: {% if alert.status == "firing" %}FIRING{% else %}RESOLVED{% endif %}
  - Labels:
  {%- for key, val in alert.labels.items() %}
      - {{ key }}: {{ val }}
  {%- endfor %}
  - Query: {{ alert.results[0].query }}

• Résultat de sortie :

  - Alert ID: test-alert
  - Alert Name: PV/UV Alert
  - Project: project-1
  - Status: FIRING
  - Labels:
      - app: nginx
      - host: host-1
  - Query: * | select count(*) as pv

Syntaxe de base

Par défaut, Simple Log Service ignore les espaces entre un délimiteur et l'expression qu'il contient. Par exemple, {{ 23 }} < {{ 45 }} et {{23}} < {{45}} produisent tous deux le rendu 23 < 45. Cependant, les caractères d'espacement (espaces, tabulations et sauts de ligne) situés en dehors des délimiteurs sont conservés. Par exemple, {{ 23 }} < {{ 45 }} produit le rendu 23 < 45, et non 23<45.

Les instructions conditionnelles évaluent les valeurs des paramètres et les expressions logiques pour contrôler le rendu.

• Si la clause if est suivie d'une constante ou d'une variable, elle est évaluée comme vraie ou fausse. Les valeurs booléennes false, le nombre 0, la chaîne vide "", null, le tableau vide [] et l'objet vide {} sont évalués comme faux. Toutes les autres valeurs sont évaluées comme vraies.

• Si la clause if est suivie d'une expression logique, le résultat de l'expression est évalué comme vrai ou faux. Par exemple, {{ if alert.severity >= 8 }} vérifie si la gravité de l'alerte est supérieure ou égale à 8.

{% if alert.severity >= 8 %}
Critical alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% else %}
Normal alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% elif alert.severity >= 4 %}
Normal alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% elif alert.severity >= 4 %}
Normal alert
{% else %}
Notification
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% else %}
{% if alert.severity >= 4 %}
Normal alert
{% else %}
Notification
{% endif %}
{% endif %}

Les instructions de boucle itèrent sur les tableaux et les objets. Le tableau suivant décrit les instructions de boucle prises en charge.

{% for result in alert.results %}
{{ result }}
{% endfor %}

{% for index, result in enumerate(alert.results) %}
{{ index }}: {{ result }}
{% endfor %}

{% for index, result in enumerate(alert.results, start=1) %}
{{ index }}: {{ result }}
{% endfor %}

{% for key, val in alert.labels.items() %}
    {{ key }}: {{ val }}
    {% endfor %}

{% for result in alert.fire_results %}
{% for key, val in result.items() %}
{{ key }}: {{ val }}
{% endfor %}
{% endfor %}

Pour empêcher Simple Log Service d'analyser les chaînes de caractères spéciaux telles que {{, vous pouvez les échapper. L'exemple suivant conserve tel quel tout le contenu situé entre {% raw %} et {% endraw %} :

• Configuration du modèle d'alerte

  {% raw %}
  {% for result in alert.results %}
  {{ result }} {% endfor %} {% endraw %}

• Résultat

  {% for result in alert.results %}
  {{ result }}
  {% endfor %}

Les modèles d'alerte fournissent des fonctions intégrées pour configurer de manière flexible les formats et les styles des notifications. Pour plus d'informations, consultez Fonctions intégrées des modèles.

Par exemple, pour envoyer des notifications d'alerte au format JSON à l'aide d'une URL de webhook, utilisez la configuration de modèle suivante :

• Instruction de requête incluant un saut de ligne

  * |
  select count(*) as cnt

• Comparaison entre différentes configurations de modèles d'alerte

  Élément	Modèle d'alerte	Résultat	Remarques
  Aucune fonction utilisée	{ "query": "{{ alert.results[0].query }}" }	{ "query": "* | select count(*) as pv" }	Le format JSON n'est pas valide.
  Utilisation de la fonction quote	{ "query": {{ quote(alert.results[0].query) }} }	{ "query": "* | \nselect count(*) as pv" }	Le format JSON est valide.

Lorsque des fonctions imbriquées telles que {{ block(to_list(alert.labels)) }} deviennent difficiles à lire, vous pouvez utiliser des filtres à la place. Les filtres utilisent des barres verticales (|) comme opérateurs et prennent en charge le chaînage de méthodes. Spécifiez les filtres au format {{ xxx | filiter1 | filter2 | ... }}. Par exemple, {{ blockquote(to_list(alert.labels)) }} équivaut à {{ alert.labels | to_list | blockquote }}.

Avant d'utiliser des filtres avec une fonction intégrée, vérifiez que la fonction prend en charge les filtres. La plupart des fonctions intégrées dans les nouveaux modèles d'alerte prennent en charge les filtres. Pour plus d'informations, consultez Fonctions intégrées des modèles.

Le tableau suivant décrit les opérateurs pris en charge. Pour plus d'informations sur les priorités des opérateurs, consultez Priorité des opérateurs.

Variables d'alerte

Dans les nouveaux modèles d'alerte, les variables d'alerte utilisent le format alert.xxx. Par exemple, alert.project est une variable d'alerte valide. Pour plus d'informations, consultez Variables dans les modèles d'alerte.

Exemples de configuration

• Exemple 1 : Affichez les informations d'alerte en fonction de l'état de l'alerte.

  Lorsqu'une alerte est déclenchée, l'état, le niveau de gravité et le résultat sont fournis. Lorsqu'une alerte est résolue, seul l'état est fourni.

  • La configuration de modèle suivante n'inclut pas de fonctions :

    {% if alert.status == "firing" %}
    - Status: <font color="#E03C39">Firing</font>
    - Severity level: {{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% else %}
    - Status: <font color="#72C140">Cleared</font>
    {% endif %}

  • La configuration de modèle suivante inclut des fonctions :

    Les fonctions format_status et format_severity simplifient la configuration du modèle :

    - Status: {{ alert.status | format_status }}
    {% if alert.status == "firing" %}
    - Severity level: {{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% endif %}

• Exemple 2 : Affichez les informations d'alerte dans un format structuré.

  Les libellés d'alerte sont convertis en un tableau au format Markdown.

  • La configuration de modèle suivante n'inclut pas de fonctions :

    - Project: {{ alert.project }}
    - Alert name: {{ alert.alert_name }}
    - Label:
    {%- for key, val in alert.labels.items() %}
    > - {{ key }}: {{ val }}
    {%- endfor %}

  • La configuration de modèle suivante inclut des fonctions :

    Les fonctions to_list et blockquote simplifient la configuration du modèle.

    - Project: {{ alert.project }}
    - Alert name: {{ alert.alert_name }}
    - Label:
    {{ alert.labels | to_list | blockquote }}