Включение сбора телеметрии StarVault

Далее описан процесс сбора данных телеметрии из установленного StarVault.

1. Перед началом

Перед началом работы убедитесь, что выполнены требования:

должен быть установлен и запущен StarVault.
должен быть доступ к файлу [конфигурации StarVault].

2. Шаг 1: Выбор агента агрегации

StarVault использует пакет go-metrics для экспорта телеметрии и поддерживает следующие агенты агрегации для мониторинга временных рядов:

Префикс конфигурации

Название

Компания

circonus

Circonus

dogstatsd

DogStatsD

Datadog

prometheus

Prometheus

Prometheus / Open source

stackdriver

Cloud Operations

Google

statsd

Statsd

Open source

statsite

Statsite

Open source

3. Шаг 2: Включение хотя бы одного устройства аудита

Чтобы включить метрики, связанные с аудитом, вы должны активировать аудит хотя бы на одном устройстве с помощью команды StarVault audit enable. Например, чтобы включить аудит для файлового устройства и сохранять логи в /var/log/starvault_audit.log:

starvault audit enable file file_path=/var/log/starvault_audit.log

4. Шаг 3: Настройка сбора телеметрии

Чтобы настроить сбор телеметрии, обновите раздел телеметрии в конфигурации StarVault с вашими предпочтениями по сбору и деталями агента агрегации.

Например, следующий раздел telemetry настраивает StarVault с использованием стандартных настроек телеметрии и подключает его к агенту Statsite, работающему на порту по умолчанию в корпоративной интрасети по адресу mycompany.statsite:

telemetry {
  usage_gauge_period = "10m"
  maximum_gauge_cardinality = 500
  disable_hostname = false
  enable_hostname_label = false
  lease_metrics_epsilon = "1h"
  num_lease_metrics_buckets = 168
  add_lease_metrics_namespace_labels = false
  filter_default = true

  statsite_address = "mycompany.statsite:8125"
}

Многие решения для работы с метриками взимают плату за каждую метрику. Вы можете установить параметр filter_default в значение false и использовать параметр prefix_filter для включения и исключения определённых значений на основе названия метрики, чтобы избежать оплаты за неактуальную информацию.

Например, чтобы ограничить вашу телеметрию основными метриками токенов плюс количеством аренды, установленными на истечение:

telemetry {
  filter_default = false
  prefix_filter = ["+vault.token", "-vault.expire", "+vault.expire.num_leases"]
}

5. Шаг 4: Выбор решения для сбора/агрегации метрик

Вам необходимо сохранить или переслать ваши данные телеметрии в отдельное решение для сбора/агрегации метрик, анализа и оповещений. Какое решение вам нужно, зависит от набора функций, предоставляемых вашим агентом агрегации, и поддержки протоколов вашей платформой для отчётности.

Популярные решения сбора/агрегации метрик, совместимые с StarVault:

6. Следующие шаги

Ознакомьтесь с руководством по ключевым метрикам для стандартных проверок состояния, чтобы определить, какие метрики вы, возможно, захотите начать отслеживать немедленно.
Ознакомьтесь с полным списком доступных параметров телеметрии.
Ознакомьтесь с руководством по мониторингу телеметрии и данных журналов аудита для общего руководства по мониторингу и шагов по настройке телеметрии StarVault для Splunk с использованием Telegraf и Fluentd.
Ознакомьтесь с руководством по мониторингу телеметрии с использованием Prometheus и Grafana, чтобы настроить телеметрию StarVault для Prometheus и Grafana.