Оформление кода

В этом разделе описаны требования к наименованию переменных, отступам и форматированию, которые должны быть соблюдены для улучшения читаемости кода и уменьшения вероятности ошибок в процессе разработки.

Названия переменных

Названия переменных должны быть логичными и отражать их содержание.

Пример 1. Пример плохого наименования

...
on_event: !vrl |
  x = .source_ip
...

Пример 2. Оптимизированный код

...
on_event: !vrl |
  source_ip_address = .source_ip
...

Отступы и форматирование

Отступы и форматирование должны быть аккуратными и последовательными, что упрощает чтение и понимание кода.

Пример 3. Пример плохого форматирования

if contains(.msg, "error"){state.msg = "Ошибка обнаружена"}

Пример 4. Оптимизированный код

if contains(.msg, "error") {
  state.msg = "Ошибка обнаружена"
}