Simple Log Service:Sintaxis para nuevas plantillas de alertas

Descripción general

La nueva sintaxis es totalmente compatible con la sintaxis original, pero utiliza tipos, valores y estilos diferentes para los atributos de las alertas. Se recomienda utilizar exclusivamente la nueva sintaxis y evitar mezclar ambas versiones.

Inicio rápido

A continuación se muestran ejemplos del contenido de notificación definido en las nuevas plantillas de alertas.

• Contenido de la alerta:

  {
      "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"
          }
      ]
  }

• Configuración de la plantilla de alertas:

  - 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 }}

• Resultado de salida:

  - 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

Sintaxis básica

De forma predeterminada, Simple Log Service ignora los espacios entre un delimitador y la expresión interna. Por ejemplo, tanto {{ 23 }} < {{ 45 }} como {{23}} < {{45}} se renderizan como 23 < 45. Sin embargo, los caracteres de espacio en blanco (espacios, tabulaciones y saltos de línea) fuera de los delimitadores se conservan. Por ejemplo, {{ 23 }} < {{ 45 }} se renderiza como 23 < 45, no como 23<45.

Las instrucciones condicionales evalúan valores de parámetros y expresiones lógicas para controlar el renderizado.

• Si a la cláusula if le sigue una constante o variable, esta se evalúa como verdadera o falsa. El valor booleano false, el número 0, la cadena vacía "", null, la matriz vacía [] y el objeto vacío {} se evalúan como falso. Todos los demás valores se evalúan como verdadero.

• Si a la cláusula if le sigue una expresión lógica, el resultado de la expresión se evalúa como verdadero o falso. Por ejemplo, {{ if alert.severity >= 8 }} comprueba si la severidad de la alerta es 8 o superior.

{% 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 %}

Las instrucciones de bucle iteran sobre matrices y objetos. La siguiente tabla describe las instrucciones de bucle compatibles.

{% 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 %}

Para evitar que Simple Log Service analice sintácticamente cadenas de caracteres especiales como {{, puede escaparlas. El siguiente ejemplo conserva intacto todo el contenido entre {% raw %} y {% endraw %}:

• Configuración de la plantilla de alertas

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

• Resultado

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

Las plantillas de alertas proporcionan funciones integradas para configurar de manera flexible los formatos y estilos de las notificaciones. Para obtener más información, consulte Built-in template functions.

Por ejemplo, para enviar notificaciones de alerta en formato JSON mediante una URL de webhook, utilice la siguiente configuración de plantilla:

• Instrucción de consulta con un salto de línea incluido

  * |
  select count(*) as cnt

• Comparación entre diferentes configuraciones de plantillas de alertas

  Elemento	Plantilla de alertas	Resultado	Observaciones
  Sin uso de funciones	{ "query": "{{ alert.results[0].query }}" }	{ "query": "* | select count(*) as pv" }	El formato JSON no es válido.
  Uso de la función quote	{ "query": {{ quote(alert.results[0].query) }} }	{ "query": "* | \nselect count(*) as pv" }	El formato JSON es válido.

Cuando las funciones anidadas como {{ block(to_list(alert.labels)) }} resultan difíciles de leer, puede utilizar filtros en su lugar. Los filtros usan barras verticales (|) como operadores y admiten el encadenamiento de métodos. Especifique los filtros con el formato {{ xxx | filiter1 | filter2 | ... }}. Por ejemplo, {{ blockquote(to_list(alert.labels)) }} equivale a {{ alert.labels | to_list | blockquote }}.

Antes de usar filtros con una función integrada, compruebe que la función admita filtros. La mayoría de las funciones integradas en las nuevas plantillas de alertas son compatibles con filtros. Para obtener más información, consulte Built-in template functions.

La siguiente tabla describe los operadores compatibles. Para obtener más información sobre la prioridad de los operadores, consulte Operator precedence.

Variables de alerta

En las nuevas plantillas de alertas, las variables de alerta utilizan el formato alert.xxx. Por ejemplo, alert.project es una variable de alerta válida. Para obtener más información, consulte Variables in alert templates.

Ejemplos de configuración

• Ejemplo 1: Mostrar información de la alerta según su estado.

  Cuando se activa una alerta, se proporcionan el estado, el nivel de severidad y el resultado. Cuando se resuelve una alerta, solo se proporciona el estado.

  • La siguiente configuración de plantilla no incluye funciones:

    {% 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 siguiente configuración de plantilla incluye funciones:

    Las funciones format_status y format_severity simplifican la configuración de la plantilla:

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

• Ejemplo 2: Mostrar información de la alerta en un formato estructurado.

  Las etiquetas de alerta se convierten en una matriz con formato Markdown.

  • La siguiente configuración de plantilla no incluye funciones:

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

  • La siguiente configuración de plantilla incluye funciones:

    Las funciones to_list y blockquote simplifican la configuración de la plantilla.

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