Конфигурация SNMP-коллектора

Для редактирования конфигурационного файла выполните команду:

sudo nano /etc/echelon/komrad/komrad-snmp-collector.yaml
tenant_id: 75 (1)
setup_id: komrad-local (2)
sl: 715 (3)
messenger: (4)
    bus-url: nats://localhost:3490 (5)
    cluster-name: polygon (6)
    request-timeout: 50000000000 (7)
    reconnect-timeout: 1000000000 (8)
    wal-flush-timeout: 1000000000 (9)
restart-timeout: 1000000000 (10)
1 идентификатор предприятия;
2 идентификатор установки;
3 метка безопасности, аналог Oracle Security Label;
4 настройка связи с интеграционной шиной;
5 адрес интеграционной шины КОМРАД;
6 имя кластера КОМРАД;
7 таймаут запросов конфигурации в центральном сервере КОМРАД;
8 таймаут перед повторными попытками соединиться с центральным сервером Комрад;
9 таймаут перед выгрузкой накопленных событий в WAL;
10 таймаут между попытками рестарта коллектора во время неустойство сети с центральным сервером КОМРАД;

Настройка пакетного сбора данных

Накопление событий в пакеты для оптимизации скорости передачи информации.

batching:
    timeout: 1000000000 (1)
    limit: 100 (2)
1 предельный интервал времени накопления пакетов, по умолчанию 1 секунда;
2 предельный лимит событий в пакете, по умолчанию - 100;

Настройка write-ahead-log (WAL)

Механизм записи на диск событий в случае разрыва соединения с сетью. События пишутся на диск в сжатом виде, в случае восстановления соединения с сетью сжатые пакеты событий направляются в шину событий КОМРАД. Рекомендуется контролировать объём свободного дискового пространства на узле с коллектором/агентом.

wal:
    path: /var/lib/echelon/komrad/.wal (1)
    no-copy: true (2)
    segment-size: 4MB (3)
    max-length: 0 (4)
1 путь до папки в которой будет храниться конфигурационная информация коллектора/агента. Конфигурация хранится в сжатом, зашифрованном виде. Если путь не указан, будет выбрана папка по умолчанию:

  • для Windows: C:\Program Files\Echelon\komrad\<name>-collector\.wal

  • для Linux: /var/lib/echelon/komrad/<name>-collector/.wal

  • в случае установки нескольких одинаковых коллекторов на один хост необходимо устанавливать раздельные пути до хранилища каждого коллектора, путь к хранилищу одного коллектора не должен быть вложенным в путь до хранилища другого коллектора;
2 true: включает режим оптимизации работы с памятью;
3 размер одного сегмента WAL, по умолчанию 4 Кб;
4 максимальная длина WAL, если равна 0 длина не ограничена;

Настройка выводов логов приложения

Сервис может отправлять логи сразу в несколько целей: файл, системный журнал ОС, консоль, syslog.

log:
- filename: stdout
  format: color
  filter: ""
  levels:
  - all

Включить вывод логов в консоль для режима отладки приложения:

log:
- filename: stdout
  format: color
  filter: ""
  levels: [all]

Включить вывод логов в файл с ротацией:

log:
- filename: "/var/log/echelon/komrad/service.log"
  format: json
  filter: ""
  levels:  [info, error, warn, panic, fatal]

WARNING: старые файлы с логами не удаляются, необходимо производить мониторинг использования диска.

Windowseventlog:

Не рекомендуется включать levels (info, warn, debug, error), это может крайне негативно сказаться на быстродействии и доступности узла.

log:
- filename: windowseventlog
  format: json
  levels:  [panic, fatal]

Настройка дискового хранилища

Конфигурационная информация коллектора/агента

storage:
    path: /var/lib/echelon/komrad/snmp-collector/.storage (1)
    compress: false (2)
    verify-value-checksum: true (3)
    verify-value-checksum-strict: true (4)
    index-cache-size: 0 (5)
    block-cache-size: 0 (6)
    sync-writes: false (7)
1 путь до папки в которой будет храниться конфигурационная информация коллектора/агента. Конфигурация хранится в сжатом, зашифрованном виде. Если путь не указан, будет выбрана папка по умолчанию:

  • для Windows: C:\Program Files\Echelon\komrad\<name>-collector\.wal

  • для Linux: /var/lib/echelon/komrad/<name>-collector/.wal

  • в случае установки нескольких одинаковых коллекторов на один хост необходимо устанавливать раздельные пути до хранилища каждого коллектора, путь к хранилищу одного коллектора не должен быть вложенным в путь до хранилища другого коллектора;
2 сжимать ли сохраняемые данные, по умолчанию нет;
3 проверять ли контрольные суммы на каждом чтении параметра, по умолчанию отключено;
4 проверять ли контрольные суммы на каждой операции, по умолчанию отключено;
5 устанавливает жёсткий лимит для кэша ключей, в инсталяции с ограниченным объёмомпамяти можно устанавливать это значение в байтах;
6 размер кэша для блоков в байтах, рекомендуется устанавливать если включена компрессия даных (флаг compression);
7 включить режим синхронной записи каждого результата на диск, по умолчанию отключено;

Параметры защищённых соединений с источниками событий

auth:
    tls: (1)
        disable: true
        server-name: "" (2)
        trusted-ca: "" (3)
        cert: "" (4)
        cert-key: "" (5)
    ssh:
        private-key: "" (6)
        passphrase: "" (7)
        allow-insecure: false (8)
        timeout: 10 (9)
    vault: (10)
        addr: null (11)
        token: null (12)
        tls: null
1 TLS для создания защищённого соединения с источниками событий;
2 имя сервера;
3 корневой сертификат Центра Сертификации;
4 сертификат TLS;
5 приватный ключ сертификата TLS;
6 путь до файла с приватным ключом сертификата;
7 парольная фраза для авторизации по SSH с помощью сертификата при включённой опции использования парольной фразы. Используется для установки SSH соединения с использованием сертификатов;
8 включение данного флага позволяет игнорировать предупреждения безопасности о незащищённом SSH соединении;
9 таймаут SSH соединения, в секундах, по умолчанию 10;
10 настройки для получения секретов и сертификатов из Hashicorp Vault (в komrad-vault);
11 адрес vault;
12 токен доступа к vault;

Путь к базе данных GeoIP

geo-ip:
  path: /var/lib/echelon/komrad/geoip/db.mmdb
disable-raw-field: false (1)
offline: false (2)
events_file: ""
1 отключить запись исходного текста событий в поле Raw. Большинство регуляторов требуют сохранять текст исходного события. Сохранения иходного текста события влияет на размер БД для хранения событий, возможно повышение требований в разы. Коллекторы WMI, SQL, SNMP, xFLOW всё, что получают от протоколов источников сбора сохраняют в нормализованные поля события. Поля Raw заполняется синтетическими данными - нормализованные поля в формате JSON. Рекуомендуется установить disable-raw-field: true для коллекторов типа WMI, SQL, SNMP, xFLOW. Коллекторы Syslog и File имеют доступ к исходному тексту события, отключать запись в Raw для этих коллекторов невозможно;
2 использовать при работе только в локальном автономном режиме;