Simple Log Service：Sintaks untuk template peringatan baru

Ikhtisar

Sintaks untuk template peringatan baru sepenuhnya kompatibel dan dapat digunakan bersama sintaks untuk template peringatan lama. Namun, sintaks untuk template peringatan baru menggunakan tipe, nilai, dan gaya yang berbeda untuk atribut peringatan dibandingkan sintaks untuk template peringatan lama. Oleh karena itu, kami menyarankan Anda untuk tidak menggunakan kedua sintaks secara bersamaan. Kami merekomendasikan penggunaan sintaks untuk template peringatan baru.

Panduan Cepat

Bagian ini memberikan contoh konten notifikasi yang dapat didefinisikan dalam template peringatan baru.

• Konten Peringatan:

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

• Konfigurasi Template Peringatan:

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

• Hasil Output:

  - 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

Sintaks Dasar

Secara default, ketika Anda menggunakan delimeter untuk menandai awal dan akhir ekspresi, Simple Log Service mengabaikan spasi antara delimeter dan ekspresi di dalam delimeter. Sebagai contoh, Simple Log Service merender baik {{ 23 }} < {{ 45 }} maupun {{23}} < {{45}} menjadi 23 < 45. Namun, Simple Log Service tetap mempertahankan string kosong seperti spasi, tab, dan line feed di luar delimeter. Sebagai contoh, Simple Log Service merender {{ 23 }} < {{ 45 }} menjadi 23 < 45, bukan 23<45.

Alur kondisional digunakan untuk mengevaluasi nilai parameter dan hasil ekspresi logika. Simple Log Service dapat merender data berdasarkan alur kondisional.

• Jika klausa if diikuti oleh konstanta atau variabel biasa, Simple Log Service mengevaluasi konstanta atau nilai variabel biasa menjadi true atau false. Simple Log Service mengevaluasi semua nilai Boolean false, angka 0, string kosong "", nilai kosong null, array kosong [], dan objek kosong {} menjadi false dan mengevaluasi semua nilai lainnya menjadi true.

• Jika klausa if diikuti oleh ekspresi logika, Simple Log Service mengevaluasi hasil ekspresi logika menjadi true atau false. Sebagai contoh, {{ if alert.severity >= 8 }} digunakan untuk mengevaluasi apakah tingkat keparahan peringatan lebih besar dari atau sama dengan 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 %}

Pernyataan loop digunakan untuk melakukan operasi iteratif pada array dan objek. Tabel berikut menjelaskan pernyataan loop yang didukung oleh template peringatan baru.

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

Jika Anda tidak ingin Simple Log Service mem-parsing atau merender string seperti {{ yang terdiri dari karakter khusus, Anda dapat meloloskan string tersebut. Sebagai contoh, konfigurasi template peringatan berikut menentukan untuk mempertahankan semua konten antara {% raw %} dan {% endraw %}:

• Konfigurasi Template Peringatan

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

• Hasil

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

Template peringatan menyediakan fungsi bawaan. Anda dapat menggunakan fungsi bawaan untuk mengonfigurasi format dan gaya notifikasi peringatan secara fleksibel. Untuk informasi lebih lanjut, lihat Fungsi Bawaan dalam Template Peringatan.

Sebagai contoh, jika Anda ingin Simple Log Service mendorong notifikasi peringatan dalam format JSON menggunakan URL webhook, Anda harus menentukan konfigurasi template peringatan berikut:

• Pernyataan kueri dengan baris baru termasuk

  * |
  select count(*) as cnt

• Perbandingan antara konfigurasi template peringatan yang berbeda

  Item	Template Peringatan	Hasil	Catatan
  Tidak ada fungsi yang digunakan	{ "query": "{{ alert.results[0].query }}" }	{ "query": "* | select count(*) as pv" }	Format JSON tidak valid.
  Fungsi quote digunakan	{ "query": {{ quote(alert.results[0].query) }} }	{ "query": "* | \nselect count(*) as pv" }	Format JSON valid.

Jika fungsi bersarang seperti {{ block(to_list(alert.labels)) }} digunakan, pengeditan konten notifikasi menjadi rumit. Dalam situasi ini, Anda dapat menggunakan filter untuk mengedit konten notifikasi. Filter menggunakan tanda vertikal (|) sebagai operator dan dapat dipanggil menggunakan method chaining. Pada sebagian besar kasus, Anda dapat menentukan filter dalam format {{ xxx | filiter1 | filter2 | ... }}. Sebagai contoh, {{ blockquote(to_list(alert.labels)) }} setara dengan {{ alert.labels | to_list | blockquote }}.

Sebelum menentukan filter dalam fungsi bawaan, Anda harus memeriksa apakah fungsi bawaan tersebut mendukung filter. Sebagian besar fungsi bawaan yang tersedia dalam template peringatan baru mendukung filter. Untuk informasi lebih lanjut, lihat Fungsi Bawaan dalam Template Peringatan.

Tabel berikut menjelaskan operator yang didukung oleh template peringatan baru. Untuk informasi lebih lanjut tentang prioritas operator, lihat Prioritas Operator.

Variabel Peringatan

Dalam template peringatan baru, variabel peringatan berada dalam format alert.xxx. Sebagai contoh, variabel alert.project adalah variabel peringatan yang valid. Untuk informasi lebih lanjut, lihat Variabel dalam Template Peringatan (Versi Baru).

Contoh Konfigurasi

• Contoh 1: Menampilkan informasi tentang setiap peringatan berdasarkan status peringatan.

  Setelah peringatan dipicu, informasi seperti status, tingkat keparahan, dan hasil peringatan disediakan. Ketika peringatan dihapus, hanya status peringatan yang disediakan.

  • Konfigurasi template peringatan berikut tidak termasuk fungsi:

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

  • Konfigurasi template peringatan berikut mencakup fungsi:

    Fungsi format_status dan fungsi format_severity digunakan untuk menyederhanakan konfigurasi template peringatan:

    - Status: {{ alert.status | format_status }}
    {% if alert.status == "firing" %}
    - Tingkat Keparahan: {{ alert.severity | format_severity }}
    - Hasil: {{ alert.results | to_json }}
    {% endif %}

• Contoh 2: Menampilkan informasi tentang setiap peringatan dalam format terstruktur.

  Label setiap peringatan dikonversi menjadi array dalam format Markdown.

  • Konfigurasi template peringatan berikut tidak termasuk fungsi:

    - Proyek: {{ alert.project }}
    - Nama Peringatan: {{ alert.alert_name }}
    - Label:
    {%- for key, val in alert.labels.items() %}
    > - {{ key }}: {{ val }}
    {%- endfor %}

  • Konfigurasi template peringatan berikut mencakup fungsi:

    Fungsi to_list dan fungsi blockquote digunakan untuk menyederhanakan konfigurasi template peringatan.

    - Proyek: {{ alert.project }}
    - Nama Peringatan: {{ alert.alert_name }}
    - Label:
    {{ alert.labels | to_list | blockquote }}