Установка модуля RLOG

Ключевые требования

Для работы модуля RLOG требуется:

  1. ClickHouse. Используется в качестве хранилища для системных метрик, собираемых в процессе обработки логов.

  2. Сarbon-clickhouse. Служит для отправки метрик, формируемых модулем, в ClickHouse в формате Graphite.

  3. Веб-интерфейс Spider версии 4.4 или выше

  4. Компонент Broker версии 1.0.16 или выше

  5. TLS-сертификат и ключ. Обязательны при использовании режима tcptls для обеспечения защищённого соединения.

Установка модуля

Установить пакет:

sudo apt-get install rlog

Открыть для редактирования файл окружения:

sudo nano /opt/rlog/.env

Указать следующие параметры:

## Основные параметры
PROTOCOL=tcp                           # Протокол (tcp|udp|tcptls)
HOST=0.0.0.0                           # Хост для приема сообщений
PORT=514                               # Порт приема сообщений
HTTP_PORT=3003                         # HTTP-порт веб-интерфейса
CERT_FILE=./cert/server.crt            # Путь к TLS-сертификату
KEY_FILE=./cert/server.key             # Путь к TLS-ключу
SPIDER_URL=http://localhost:3000       # URL интерфейса Spider
BROKER_URL=http://localhost:8081       # URL интерфейса Broker
APP_SECRET=YOUR_APP_SECRET             # Ключ приложения из интерфейса .env
RULES_FOLDER=/var/lib/rlog/rules/      # Путь до правил обработки syslog-сообщений ("/" обязателен)

## Параметры дампов
DUMP_FOLDER=./dumps/                   # Директория для хранения дампов
DUMP_MAX_LOGS_IN_FILE=10000            # Максимальное число логов в одном дамп-файле
DUMP_MAX_LOGS_BUFFER_SIZE=5000         # Размер буфера логов перед сбросом в дамп

## Параметры метрик
HOSTNAME=rlog                          # Имя хоста в системе метрик
METRICS_EXPORT_INTERVAL=1              # Интервал отправки метрик (секунды)
METRICS_EXPORT_THRESHOLD=10            # Порог для отправки метрик
CLICKHOUSE_PORT=9000                   # Порт ClickHouse
CLICKHOUSE_HOST=10.25.78.48            # Хост ClickHouse
CLICKHOUSE_DATABASE=default            # Имя базы данных
CLICKHOUSE_USER=default                # Пользователь ClickHouse
CLICKHOUSE_PASSWORD=                   # Пароль
CARBON_CLICKHOUSE_API=10.25.78.48:2003 # Адрес API carbon-clickhouse

## Профилирование
PROFILING=false                        # Включение профилировщика

Для включения определения геолокации IP-адресов источников запросов требуется файл базы данных MaxMind в формате .mmdb. В файл окружения необходимо добавить следующую строку:

MMDB_PATH=./GeoLite2-Country.mmdb      # Путь к mmdb-файлу