Настройки для дистрибутивов с открытым исходным кодом
Docker
Docker Compose
.env.
Либо можно явно переопределить настройки в файле docker-compose.yaml, например:
Пример:
Helm
Настройка значений (необязательно)
--set, например:
values.yaml. Чтобы получить значения по умолчанию:
Приложение ClickStack: интерфейс HyperDX
Настройки источника данных
LogsTracesMetricsSessions
Team Settings -> Sources, как показано ниже на примере журналов:
Для каждого из этих источников при создании нужно указать как минимум одну таблицу и набор столбцов, которые позволяют HyperDX выполнять запросы к данным.
Если используется стандартная схема OpenTelemetry (OTel), поставляемая с ClickStack, эти столбцы могут быть автоматически определены для каждого источника. Если схема изменена или используется пользовательская схема, пользователи должны указать и обновлять эти сопоставления вручную.
Стандартная схема ClickHouse, поставляемая с ClickStack, — это схема, создаваемая экспортером ClickHouse для OTel collector. Имена этих столбцов соответствуют официальной спецификации OTel, описанной здесь.
Журналы
Трассировки
Метрики
Сеансы
Materialized views
Большинство этих параметров определяется по схеме представления при выборе целевой таблицы.
Materialized view метаданных
Highlighted Attributes
- Highlighted Attributes — это столбцы или выражения, которые отображаются для каждого лога или спана при просмотре сведений о логе или спане.
- Highlighted Trace Attributes — это столбцы или выражения, которые запрашиваются для каждого лога или спана в трейсе и отображаются над waterfall-диаграммой трассы.
Например, для этого источника трейсов настроены Highlighted Attributes и Highlighted Trace Attributes:
Эти атрибуты отображаются на боковой панели после нажатия на лог или спан:
При нажатии на атрибут появляются варианты использования этого атрибута в качестве значения поиска. Если в конфигурации атрибута задано необязательное выражение Lucene, для поиска будет использоваться именно оно, а не SQL-выражение.
Чтобы включить полную корреляцию между источниками в ClickStack, необходимо настроить коррелированные источники для логов, трассировок, метрик и сеансов. Это позволит HyperDX связывать связанные данные и предоставлять более полный контекст при отображении событий.
Logs: Можно коррелировать с трассировками и метриками.Traces: Можно коррелировать с логами, сеансами и метриками.Metrics: Можно коррелировать с логами.Sessions: Можно коррелировать с трассировками.
Настройки конфигурации приложения
HyperDX в ClickHouse CloudЭти настройки нельзя изменить, если HyperDX работает под управлением ClickHouse Cloud.
-
HYPERDX_API_KEY- По умолчанию: Не задано (обязательно)
- Описание: Ключ аутентификации для API HyperDX.
- Рекомендации:
- Обязательно для телеметрии и логирования
- При локальной разработке может быть любым непустым значением
- Для продакшена используйте безопасный уникальный ключ
- Его можно получить на странице настроек команды после создания аккаунта
-
HYPERDX_LOG_LEVEL- По умолчанию:
info - Описание: Задает уровень подробности логирования.
- Варианты:
debug,info,warn,error - Рекомендации:
- Используйте
debugдля подробной диагностики неполадок - Используйте
infoдля штатной работы - Используйте
warnилиerrorв production, чтобы уменьшить объем логов
- По умолчанию:
-
HYPERDX_API_PORT- По умолчанию:
8000 - Описание: Порт API-сервера HyperDX.
- Рекомендации:
- Убедитесь, что этот порт доступен на вашем хосте
- Измените его при конфликте портов
- Должен совпадать с портом в конфигурации вашего API-клиента
- По умолчанию:
-
HYPERDX_APP_PORT- По умолчанию:
8000 - Описание: Порт для веб-приложения HyperDX.
- Рекомендации:
- Убедитесь, что этот порт свободен на вашем хосте
- Измените его, если этот порт конфликтует с другими
- Должен быть доступен из браузера
- По умолчанию:
-
HYPERDX_APP_URL- По умолчанию:
http://localhost - Описание: Базовый URL интерфейса приложения.
- Рекомендации:
- В production укажите свой домен
- Укажите протокол (http/https)
- Не добавляйте завершающий слеш
- По умолчанию:
-
MONGO_URI- По умолчанию:
mongodb://db:27017/hyperdx - Описание: Строка подключения к MongoDB.
- Рекомендации:
- Используйте значение по умолчанию для локальной разработки с Docker
- Для продакшена используйте безопасную строку подключения
- При необходимости добавьте аутентификацию
- Пример:
mongodb://user:pass@host:port/db
- По умолчанию:
-
MINER_API_URL- По умолчанию:
http://miner:5123 - Описание: URL сервиса анализа шаблонов логов.
- Рекомендации:
- Используйте значение по умолчанию для локальной разработки с Docker
- В продуктивной среде укажите URL вашего сервиса miner
- Должен быть доступен из API-сервиса
- По умолчанию:
-
FRONTEND_URL- По умолчанию:
http://localhost:3000 - Описание: URL интерфейса.
- Рекомендации:
- Используйте значение по умолчанию для локальной разработки
- В продакшене укажите свой домен
- Должен быть доступен из API-сервиса
- По умолчанию:
-
OTEL_SERVICE_NAME- По умолчанию:
hdx-oss-api - Описание: Имя сервиса для инструментирования OpenTelemetry.
- Рекомендации:
- Используйте понятное, описательное имя для сервиса HyperDX. Применимо, если HyperDX инструментирует себя самостоятельно.
- Помогает идентифицировать сервис HyperDX в телеметрических данных
- По умолчанию:
-
NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT- По умолчанию:
http://localhost:4318 - Описание: конечная точка OpenTelemetry Collector.
- Рекомендации:
- Актуально при самоинструментировании HyperDX.
- Используйте значение по умолчанию для локальной разработки
- В production укажите URL вашего коллектора
- Должно быть доступно из сервиса HyperDX
- По умолчанию:
-
USAGE_STATS_ENABLED- По умолчанию:
true - Описание: Включает сбор статистики использования.
- Рекомендации:
- Установите
false, чтобы отключить сбор статистики использования - Полезно для развертываний с повышенными требованиями к конфиденциальности
- Значение по умолчанию —
true, чтобы способствовать улучшению продукта
- По умолчанию:
-
IS_OSS- По умолчанию:
true - Описание: Указывает, работает ли система в режиме OSS.
- Рекомендации:
- Оставьте
trueдля развертываний с открытым исходным кодом - Установите
falseдля корпоративных развертываний - Влияет на доступные возможности
- По умолчанию:
-
IS_LOCAL_MODE- По умолчанию:
false - Описание: Указывает, работает ли приложение в локальном режиме.
- Рекомендации:
- Установите значение
trueдля локальной разработки - Отключает некоторые возможности, используемые в продакшене
- Полезно для тестирования и разработки
- По умолчанию:
-
EXPRESS_SESSION_SECRET- По умолчанию:
hyperdx is cool 👋 - Описание: Секрет для управления сеансами в Express.
- Рекомендации:
- Измените в продакшене
- Используйте надёжную случайную строку
- Храните в секрете и в безопасном месте
- По умолчанию:
-
ENABLE_SWAGGER- По умолчанию:
false - Описание: Включает или отключает документацию Swagger API.
- Рекомендации:
- Установите
true, чтобы включить документацию API - Полезно для разработки и тестирования
- В рабочей среде отключайте
- По умолчанию:
-
BETA_CH_OTEL_JSON_SCHEMA_ENABLED- По умолчанию:
false - Описание: Включает бета-поддержку типа JSON в HyperDX. См. также
OTEL_AGENT_FEATURE_GATE_ARG, чтобы включить поддержку JSON в OTel collector. - Рекомендации:
- Включает возможность в статусе бета. Схемы с типом JSON не рекомендуются для типичных задач обсервабилити. Сравнение и рекомендации по выбору см. в разделе Map vs JSON type.
- Установите
true, чтобы включить поддержку JSON в интерфейсе ClickStack.
- По умолчанию:
Коллектор OpenTelemetry
-
CLICKHOUSE_ENDPOINT- По умолчанию: None (обязательно) для автономного образа. Для дистрибутива All-in-one или Docker Compose это значение задается как адрес встроенного экземпляра ClickHouse.
- Описание: HTTPS URL экземпляра ClickHouse, в который экспортируются данные телеметрии.
- Рекомендации:
- Должна быть указана полная HTTPS конечная точка, включая порт (например,
https://clickhouse.example.com:8443) - Обязательно для отправки данных из коллектора в ClickHouse
- Должна быть указана полная HTTPS конечная точка, включая порт (например,
-
CLICKHOUSE_USER- По умолчанию:
default - Описание: Имя пользователя для аутентификации в экземпляре ClickHouse.
- Рекомендации:
- Убедитесь, что у пользователя есть разрешения
INSERTиCREATE TABLE - Рекомендуется создать отдельного пользователя для ингестии
- Убедитесь, что у пользователя есть разрешения
- По умолчанию:
-
CLICKHOUSE_PASSWORD- По умолчанию: None (обязательно, если включена аутентификация)
- Описание: Пароль для указанного пользователя ClickHouse.
- Рекомендации:
- Обязательно, если для учетной записи пользователя задан пароль
- В production-развертываниях храните его безопасно с помощью secrets
-
HYPERDX_LOG_LEVEL- По умолчанию:
info - Описание: Уровень детализации Log для коллектора.
- Рекомендации:
- Принимает значения
debug,info,warn,error - Используйте
debugпри устранении неполадок
- Принимает значения
- По умолчанию:
-
OPAMP_SERVER_URL- По умолчанию: None (обязательно) для автономного образа. Для дистрибутива All-in-one или Docker Compose это значение указывает на развернутый экземпляр HyperDX.
- Описание: URL сервера OpAMP, используемого для управления коллектором (например, экземпляра HyperDX). По умолчанию используется порт
4320. - Рекомендации:
- Должен указывать на ваш экземпляр HyperDX
- Включает динамическую конфигурацию и безопасную ингестию
- Если значение не указано, безопасная ингестия отключается, если только не задан
OTLP_AUTH_TOKEN.
-
OTLP_AUTH_TOKEN- По умолчанию: None. Используется только для автономного образа.
- Описание: Позволяет указать токен аутентификации OTLP. Если он задан, для всего обмена требуется этот bearer-токен.
- Рекомендации:
- Рекомендуется при использовании автономного образа коллектора в production.
-
HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE- По умолчанию:
default - Описание: База данных ClickHouse, в которую коллектор записывает данные телеметрии.
- Рекомендации:
- Задайте, если используете пользовательское имя базы данных
- Убедитесь, что указанный пользователь имеет доступ к этой базе данных
- По умолчанию:
-
OTEL_AGENT_FEATURE_GATE_ARG- По умолчанию:
<empty string> - Описание: Включает feature flags в коллекторе. Если задано значение
--feature-gates=clickhouse.json, в коллекторе включается бета-поддержка JSON type, что позволяет создавать схемы с этим типом. См. такжеBETA_CH_OTEL_JSON_SCHEMA_ENABLED, чтобы включить поддержку JSON в HyperDX. - Рекомендации:
- Включает бета-возможность. Схемы с типом JSON не рекомендуются для типичных рабочих нагрузок обсервабилити. Сравнение и рекомендации по выбору см. в Map vs JSON type.
- Установите значение
--feature-gates=clickhouse.json, чтобы создавать новые таблицы с использованием типа JSON.
- По умолчанию: