Начало работы с ClickStack с открытым исходным кодом

Запустите ClickStack с открытым исходным кодом локально, отправьте тестовое событие через его OpenTelemetry Collector и убедитесь, что оно доступно в интерфейсе ClickStack. При использовании ClickStack с открытым исходным кодом вы самостоятельно запускаете и управляете серверной частью ClickHouse, интерфейсом ClickStack и конвейером ингестии. Образ «Всё в одном» объединяет эти компоненты с MongoDB в одном контейнере Docker для локальной оценки и тестирования.

Также доступна управляемая версия ClickStack — см. Управляемый ClickStack.

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

Перед началом работы

Установите Docker и убедитесь, что следующие порты свободны:

8080 для интерфейса ClickStack
4317 для OTLP по gRPC
4318 для OTLP по HTTP
8123 для HTTP-интерфейса ClickHouse

Для длительных рабочих нагрузок или использования в продакшне ознакомьтесь с разделами Варианты развертывания с открытым исходным кодом и Переход в продакшн.

Настройка ClickStack с открытым исходным кодом с помощью образа «Всё в одном»

Запустите ClickStack

Запустите образ «Всё в одном»:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest

Контейнер работает на переднем плане. Не закрывайте этот терминал; для выполнения остальных команд из этого руководства используйте второй терминал.

Сохранение данных и настроек

Чтобы сохранить настройки ClickStack, данные и журналы ClickHouse после удаления контейнера, выполните следующую команду:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  -v "$(pwd)/.volumes/db:/data/db" \
  -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
  -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
  clickhouse/clickstack-all-in-one:latest

$(pwd) указывает на текущий каталог. Эта команда сохраняет постоянные файлы в каталоге .volumes в этом месте.

Откройте ClickStack

После запуска ClickStack откройте http://localhost:8080 и создайте аккаунт.ClickStack автоматически подключается к включённому в образ экземпляру ClickHouse и создаёт источники данных для журналов, трассировок, метрик и сеансов.

Скопируйте ключ API для ингестии

В разделе Начало работы в левом меню выберите Add Data, затем скопируйте Ingestion API Key. Телеметрия, отправляемая во включённый OpenTelemetry Collector, должна содержать этот ключ в заголовке authorization.

Отправьте тестовые данные

Во втором терминале экспортируйте ключ API для ингестии:

export CLICKSTACK_API_KEY=<your_ingestion_api_key>

Отправьте журнал OTLP с текущей временной меткой:

NOW_NANO="$(date +%s)000000000"

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  -H "authorization: ${CLICKSTACK_API_KEY}" \
  --data-binary @- <<EOF
{
  "resourceLogs": [{
    "resource": {
      "attributes": [{
        "key": "service.name",
        "value": {"stringValue": "clickstack-docs-test"}
      }]
    },
    "scopeLogs": [{
      "scope": {"name": "clickstack-docs-test"},
      "logRecords": [{
        "timeUnixNano": "${NOW_NANO}",
        "severityText": "INFO",
        "body": {"stringValue": "ClickStack ingestion test"}
      }]
    }]
  }]
}
EOF

При успешном запросе возвращается HTTP/1.1 200 OK.

Проверьте ингестию

Откройте страницу Search в ClickStack и найдите ClickStack ingestion test.В результатах должно отображаться тестовое событие с именем сервиса clickstack-docs-test.

Теперь у вас есть локальный экземпляр ClickStack, работающая конечная точка для ингестии и тестовое событие, которое можно просмотреть в ClickStack.

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

Отправка данных приложений и инфраструктуры

Выберите руководство в зависимости от типа данных, которые хотите отправить в ClickStack:

Инструментирование приложения

Отправляйте трассировки и журналы приложений с помощью поддерживаемого SDK OpenTelemetry.

Сбор журналов хоста

Пересылайте журналы хоста из OpenTelemetry Collector, работающего в роли агента.

Мониторинг Kubernetes

Собирайте журналы, метрики и трассировки из кластера Kubernetes.

Другие интеграции

Найдите руководства по дополнительным приложениям и источникам телеметрии.

Explore демонстрационные данные

Используйте демонстрационный датасет, чтобы ознакомиться с ClickStack на более богатом наборе телеметрических данных:

Демонстрационные журналы, трассировки и метрики

Загрузите данные из общедоступной демонстрации и диагностируйте проблему.

Локальные журналы и метрики

Собирайте данные из локальных файлов и системные метрики в macOS или Linux.

Чтобы ознакомиться с предзагруженными данными без установки Docker, воспользуйтесь размещённой демонстрацией ClickStack.

Генерация синтетических данных

Используйте генератор, чтобы протестировать ингестию без готового приложения или датасета:

Генерация данных с помощью otelgen

Отправьте короткий поток синтетических журналов, трассировок и метрик OTLP.

Генерация данных с помощью telemetrygen

Сгенерируйте настраиваемые сигналы OpenTelemetry для нескольких сервисов.

См. все демонстрационные данные и демонстрации ClickStack.

Подготовка к продакшну

Перед использованием ClickStack для постоянных рабочих нагрузок ознакомьтесь с рекомендациями по развертыванию и эксплуатации в продакшне:

Переход в продакшн

Ознакомьтесь с рекомендациями по учётным данным для ингестии, безопасности, срокам хранения данных и эксплуатации.

Выберите модель развертывания

Сравните варианты развертывания с открытым исходным кодом для вашей среды.

Get started

Features

Managing ClickStack

Guides

Integration partners

Начало работы с ClickStack с открытым исходным кодом

Перед началом работы

Настройка ClickStack с открытым исходным кодом с помощью образа «Всё в одном»

Запустите ClickStack

Откройте ClickStack

Скопируйте ключ API для ингестии

Отправьте тестовые данные

Проверьте ингестию

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

Отправка данных приложений и инфраструктуры

Инструментирование приложения

Сбор журналов хоста

Мониторинг Kubernetes

Другие интеграции

Explore демонстрационные данные

Демонстрационные журналы, трассировки и метрики

Локальные журналы и метрики

Генерация синтетических данных

Генерация данных с помощью otelgen

Генерация данных с помощью telemetrygen

Подготовка к продакшну

Переход в продакшн

Выберите модель развертывания

​Перед началом работы

​Настройка ClickStack с открытым исходным кодом с помощью образа «Всё в одном»

Запустите ClickStack

Откройте ClickStack

​Скопируйте ключ API для ингестии

Отправьте тестовые данные

Проверьте ингестию

​Следующие шаги

​Отправка данных приложений и инфраструктуры

Инструментирование приложения

Сбор журналов хоста

Мониторинг Kubernetes

Другие интеграции

​Explore демонстрационные данные

Демонстрационные журналы, трассировки и метрики

Локальные журналы и метрики

​Генерация синтетических данных

Генерация данных с помощью otelgen

Генерация данных с помощью telemetrygen

​Подготовка к продакшну

Переход в продакшн

Выберите модель развертывания

Перед началом работы

Настройка ClickStack с открытым исходным кодом с помощью образа «Всё в одном»

Скопируйте ключ API для ингестии

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

Отправка данных приложений и инфраструктуры

Explore демонстрационные данные

Генерация синтетических данных

Подготовка к продакшну