Simple Log Service:Sintaxe para novos modelos de alerta

Visão geral

A nova sintaxe é totalmente compatível com a original, mas usa tipos, valores e estilos diferentes para os atributos de alerta. Recomendamos usar apenas a nova sintaxe e evitar misturar as duas.

Início rápido

Os exemplos a seguir mostram o conteúdo da notificação definido nos novos modelos de alerta.

• Conteúdo do 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"
          }
      ]
  }

• Configuração do modelo de alerta:

  - 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 da saída:

  - 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

Sintaxe básica

Por padrão, o Simple Log Service ignora espaços entre um delimitador e a expressão interna. Por exemplo, tanto {{ 23 }} < {{ 45 }} quanto {{23}} < {{45}} são renderizados como 23 < 45. No entanto, caracteres de espaço em branco (espaços, tabulações e quebras de linha) fora dos delimitadores são preservados. Por exemplo, {{ 23 }} < {{ 45 }} é renderizado como 23 < 45, e não como 23<45.

Instruções condicionais avaliam valores de parâmetros e expressões lógicas para controlar a renderização.

• Se a cláusula if for seguida por uma constante ou variável, ela será avaliada como verdadeira ou falsa. O valor booleano false, o número 0, a string vazia "", null, o array vazio [] e o objeto vazio {} são avaliados como falso. Todos os outros valores são avaliados como verdadeiro.

• Caso a cláusula if seja seguida por uma expressão lógica, o resultado da expressão é avaliado como verdadeiro ou falso. Por exemplo, {{ if alert.severity >= 8 }} verifique se a severidade do alerta é 8 ou 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 %}

Instruções de loop iteram sobre arrays e objetos. A tabela a seguir descreve as instruções de loop compatíveis.

{% 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 o Simple Log Service analise strings de caracteres especiais como {{, escape-as. O exemplo a seguir mantém todo o conteúdo entre {% raw %} e {% endraw %} exatamente como está:

• Configuração do modelo de alerta

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

• Resultado

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

Os modelos de alerta fornecem funções integradas para configurar formatos e estilos de notificação de forma flexível. Para obter mais informações, consulte Funções de modelo integradas.

Por exemplo, para enviar notificações de alerta em formato JSON usando uma URL de webhook, utilize a seguinte configuração de modelo:

• Instrução de consulta com quebra de linha incluída

  * |
  select count(*) as cnt

• Comparação entre diferentes configurações de modelo de alerta

  Item	Modelo de alerta	Resultado	Observações
  Nenhuma função utilizada	{ "query": "{{ alert.results[0].query }}" }	{ "query": "* | select count(*) as pv" }	O formato JSON é inválido.
  Função quote utilizada	{ "query": {{ quote(alert.results[0].query) }} }	{ "query": "* | \nselect count(*) as pv" }	O formato JSON é válido.

Quando funções aninhadas como {{ block(to_list(alert.labels)) }} tornam-se difíceis de ler, use filtros. Os filtros usam barras verticais (|) como operadores e suportam encadeamento de métodos. Especifique os filtros no formato {{ xxx | filiter1 | filter2 | ... }}. Por exemplo, {{ blockquote(to_list(alert.labels)) }} equivale a {{ alert.labels | to_list | blockquote }}.

Antes de usar filtros com uma função integrada, verifique se a função oferece suporte a eles. A maioria das funções integradas nos novos modelos de alerta suporta filtros. Para obter mais informações, consulte Funções de modelo integradas.

A tabela a seguir descreve os operadores compatíveis. Para obter mais informações sobre prioridades de operadores, consulte Precedência de operadores.

Variáveis de alerta

Nos novos modelos de alerta, as variáveis de alerta usam o formato alert.xxx. Por exemplo, alert.project é uma variável de alerta válida. Para obter mais informações, consulte Variáveis em modelos de alerta.

Exemplos de configuração

• Exemplo 1: Exibir informações de alerta com base no status do alerta.

  Quando um alerta é disparado, o status, o nível de severidade e o resultado são fornecidos. Quando um alerta é resolvido, apenas o status é fornecido.

  • A seguinte configuração de modelo não inclui funções:

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

  • A seguinte configuração de modelo inclui funções:

    As funções format_status e format_severity simplificam a configuração do modelo:

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

• Exemplo 2: Exibir informações de alerta em formato estruturado.

  Os rótulos de alerta são convertidos em um array formatado em Markdown.

  • A seguinte configuração de modelo não inclui funções:

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

  • A seguinte configuração de modelo inclui funções:

    As funções to_list e blockquote simplificam a configuração do modelo.

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