Helm

Документация Helm Chart для HyperDX доступна здесь и является рекомендуемым методом для развертывания в продуктивной среде.

По умолчанию Helm Chart развертывает все основные компоненты, включая:

ClickHouse
HyperDX
OpenTelemetry (OTel) collector
MongoDB (для постоянного состояния приложения)

Однако его легко настроить для интеграции с существующим развертыванием ClickHouse - например, одним, размещенным в ClickHouse Cloud.

Chart поддерживает стандартные лучшие практики Kubernetes, включая:

Конфигурацию, специфичную для окружения, через values.yaml
Ограничения ресурсов и масштабирование на уровне подов
Настройку TLS и ingress
Управление секретами и настройку аутентификации

Подходит для

Прототипов
Продукции

Шаги развертывания

Предварительные требования

Helm v3+
Кластер Kubernetes (рекомендуется v1.20+)
kubectl, настроенный для взаимодействия с вашим кластером

Добавить репозиторий Helm HyperDX

Добавьте репозиторий Helm HyperDX:

helm repo add hyperdx https://hyperdxio.github.io/helm-charts
helm repo update

Установка HyperDX

Чтобы установить Chart HyperDX с настройками по умолчанию:

helm install my-hyperdx hyperdx/hdx-oss-v2

Проверка установки

Проверьте установку:

kubectl get pods -l "app.kubernetes.io/name=hdx-oss-v2"

Когда все поды будут готовы, продолжайте.

Перенаправление портов

Перенаправление портов позволяет нам получить доступ и настроить HyperDX. Пользователи, разворачивающие в продуктивной среде, должны вместо этого открыть сервис через ingress или балансировщик нагрузки, чтобы обеспечить правильный сетевой доступ, завершение TLS и масштабируемость. Перенаправление портов лучше всего подходит для локальной разработки или одноразовых административных задач, а не для долгосрочных или сред высокодоступности.

kubectl port-forward \
  pod/$(kubectl get pod -l app.kubernetes.io/name=hdx-oss-v2 -o jsonpath='{.items[0].metadata.name}') \
  8080:3000

Переход к интерфейсу

Посетите http://localhost:8080, чтобы получить доступ к интерфейсу HyperDX.

Создайте пользователя, предоставив имя пользователя и пароль, соответствующие требованиям.

При нажатии Create будут созданы источники данных для экземпляра ClickHouse, развернутого с помощью Helm chart.

Переопределение соединения по умолчанию

Вы можете переопределить соединение с интегрированным экземпляром ClickHouse. Для получения дополнительных сведений смотрите “Использование ClickHouse Cloud”.

Для примера использования альтернативного экземпляра ClickHouse смотрите “Создать соединение с ClickHouse Cloud”.

Настройка значений (необязательно)

Вы можете настроить параметры, используя флаги --set. Например:

helm install my-hyperdx hyperdx/hdx-oss-v2 --set key=value

Alternatively, edit the `values.yaml`. To retrieve the default values:

```shell
helm show values hyperdx/hdx-oss-v2 > values.yaml

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

replicaCount: 2
resources:
  limits:
    cpu: 500m
    memory: 512Mi
  requests:
    cpu: 250m
    memory: 256Mi
ingress:
  enabled: true
  annotations:
    kubernetes.io/ingress.class: nginx
  hosts:
    - host: hyperdx.example.com
      paths:
        - path: /
          pathType: ImplementationSpecific

helm install my-hyperdx hyperdx/hdx-oss-v2 -f values.yaml

Использование секретов (необязательно)

Для обработки конфиденциальных данных, таких как ключи API или учетные данные базы данных, используйте секреты Kubernetes. Helm Charts HyperDX предоставляют шаблоны секретов по умолчанию, которые вы можете изменить и применить к вашему кластеру.

Использование преднастроенных секретов

Helm chart включает шаблон секрета по умолчанию, расположенный в charts/hdx-oss-v2/templates/secrets.yaml. Этот файл предоставляет базовую структуру для управления секретами.

Если вам нужно вручную применить секрет, измените и примените предоставленный шаблон secrets.yaml:

apiVersion: v1
kind: Secret
metadata:
  name: hyperdx-secret
  annotations:
    "helm.sh/resource-policy": keep
type: Opaque
data:
  API_KEY: <base64-encoded-api-key>

Примените секрет к вашему кластеру:

kubectl apply -f secrets.yaml

Создание пользовательского секрета

При желании вы можете создать пользовательский секрет Kubernetes вручную:

kubectl create secret generic hyperdx-secret \
  --from-literal=API_KEY=my-secret-api-key

Ссылка на секрет

Чтобы сослаться на секрет в values.yaml:

hyperdx:
  apiKey:
    valueFrom:
      secretKeyRef:
        name: hyperdx-secret
        key: API_KEY

Использование ClickHouse Cloud

Если вы используете ClickHouse Cloud, пользователи отключают экземпляр ClickHouse, развернутый с помощью Helm chart, и указывают учетные данные Cloud:


# specify ClickHouse Cloud credentials
export CLICKHOUSE_URL=<CLICKHOUSE_CLOUD_URL> # full https url
export CLICKHOUSE_USER=<CLICKHOUSE_USER>
export CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>


# how to overwrite default connection
helm install myrelease hyperdx-helm --set clickhouse.enabled=false --set clickhouse.persistence.enabled=false --set otel.clickhouseEndpoint=${CLICKHOUSE_URL} --set clickhouse.config.users.otelUser=${CLICKHOUSE_USER} --set clickhouse.config.users.otelUserPassword=${CLICKHOUSE_PASSWORD}

В качестве альтернативы используйте файл values.yaml:

clickhouse:
  enabled: false
  persistence:
    enabled: false
  config:
    users:
      otelUser: ${CLICKHOUSE_USER}
      otelUserPassword: ${CLICKHOUSE_PASSWORD}

otel:
  clickhouseEndpoint: ${CLICKHOUSE_URL}

hyperdx:
  defaultConnections: |
    [
      {
        "name": "External ClickHouse",
        "host": "http://your-clickhouse-server:8123",
        "port": 8123,
        "username": "your-username",
        "password": "your-password"
      }
    ]

helm install my-hyperdx hyperdx/hdx-oss-v2 -f values.yaml

# or if installed...

# helm upgrade my-hyperdx hyperdx/hdx-oss-v2 -f values.yaml

Заметки по продуктивному развертыванию

По умолчанию этот chart также устанавливает ClickHouse и OTel collector. Однако для продуктивного развертывания рекомендуется управлять ClickHouse и OTel collector отдельно.

Чтобы отключить ClickHouse и OTel collector, установите следующие значения:

helm install myrelease hyperdx-helm --set clickhouse.enabled=false --set clickhouse.persistence.enabled=false --set otel.enabled=false

Конфигурация задач

По умолчанию в настройках chart есть одна задача, настроенная как cronjob, отвечающая за проверку необходимости срабатывания оповещений. Вот ее параметры конфигурации:

Параметр	Описание	Значение по умолчанию
`tasks.enabled`	Включить/выключить cron задачи в кластере. По умолчанию изображение HyperDX будет запускать cron задачи в процессе. Измените на true, если хотите использовать отдельную cron задачу в кластере.	`false`
`tasks.checkAlerts.schedule`	Расписание cron для задачи проверки оповещений	`/1 * * *`
`tasks.checkAlerts.resources`	Запросы и ограничения ресурсов для задачи проверки оповещений	Смотрите `values.yaml`

Обновление chart

Чтобы обновить до новой версии:

helm upgrade my-hyperdx hyperdx/hdx-oss-v2 -f values.yaml

Чтобы проверить доступные версии chart:

helm search repo hyperdx

Удаление HyperDX

Чтобы удалить развертывание:

helm uninstall my-hyperdx

Это удалит все ресурсы, связанные с релизом, но постоянные данные (если таковые имеются) могут остаться.

Устранение неполадок

Проверка журналов

kubectl logs -l app.kubernetes.io/name=hdx-oss-v2

Отладка неудачной установки

helm install my-hyperdx hyperdx/hdx-oss-v2 --debug --dry-run

Проверка развертывания

kubectl get pods -l app.kubernetes.io/name=hdx-oss-v2

Поддержка типа JSON

Beta feature. Learn more.

ClickStack имеет бета-поддержку типа JSON с версии 2.0.4.

Для получения преимуществ этого типа смотрите Преимущества типа JSON.

Чтобы включить поддержку типа JSON, пользователи должны установить следующие переменные окружения:

OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' - включает поддержку в OTel collector, гарантируя, что схемы создаются с использованием типа JSON.
BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true - включает поддержку в приложении HyperDX, позволяя запрашивать данные в формате JSON.

Пользователи могут устанавливать эти переменные окружения как через параметры, так и в values.yaml, например.

values.yaml

hyperdx:
  ...
  env:
    - name: BETA_CH_OTEL_JSON_SCHEMA_ENABLED
      value: "true"

otel:
  ...
  env:
    - name: OTEL_AGENT_FEATURE_GATE_ARG
      value: "--feature-gates=clickhouse.json"

или через --set:

helm install myrelease hyperdx-helm --set "hyperdx.env[0].name=BETA_CH_OTEL_JSON_SCHEMA_ENABLED" \
  --set "hyperdx.env[0].value=true" \
  --set "otel.env[0].name=OTEL_AGENT_FEATURE_GATE_ARG" \
  --set "otel.env[0].value=--feature-gates=clickhouse.json"

Подходит для​

Шаги развертывания​

Предварительные требования​

Добавить репозиторий Helm HyperDX​

Установка HyperDX​

Проверка установки​

Перенаправление портов​

Переход к интерфейсу​

Настройка значений (необязательно)​

Использование секретов (необязательно)​

Использование преднастроенных секретов​

Создание пользовательского секрета​

Ссылка на секрет​

Использование ClickHouse Cloud​

Заметки по продуктивному развертыванию​

Конфигурация задач​

Обновление chart​

Удаление HyperDX​

Устранение неполадок​

Проверка журналов​

Отладка неудачной установки​

Проверка развертывания​

Поддержка типа JSON​