> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-vortex-format.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

> Начало работы с ClickStack и демонстрационным набором данных с журналами, сеансами, трассировками и метриками

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

В этом руководстве демонстрируются как ClickStack с открытым исходным кодом, так и Управляемый ClickStack на примере набора данных.

<Tabs>
  <Tab title="Управляемый ClickStack">
    В этом руководстве предполагается, что вы выполнили [руководство по началу работы с Управляемым ClickStack](/ru/clickstack/deployment/managed) и [сохранили учётные данные для подключения](/ru/clickstack/getting-started/managed#next-steps).

    <Steps>
      <Step title="Выберите сервис" id="select-your-service-managed">
        На главной странице ClickHouse Cloud выберите сервис с Управляемым ClickStack.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/L-EF0vvFAtRNVVu-/images/clickstack/select_service.webp?fit=max&auto=format&n=L-EF0vvFAtRNVVu-&q=85&s=781c454df4b74960d903669a6ce54d02" alt="Выберите сервис" size="lg" width="3600" height="2040" data-path="images/clickstack/select_service.webp" />
      </Step>

      <Step title="Перейдите в интерфейс ClickStack (HyperDX)" id="navigate-to-the-hyperdx-ui-managed">
        Выберите `ClickStack` в левом меню, чтобы перейти в интерфейс ClickStack, где вы будете автоматически авторизованы.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=83450e0056b310e050a142d0a56cd17d" alt="Интерфейс ClickStack" size="lg" width="3430" height="2340" data-path="images/use-cases/observability/hyperdx.webp" />
      </Step>

      <Step title="Скачайте пример данных" id="download-sample-data-managed">
        Чтобы заполнить интерфейс примером данных, скачайте следующий файл:

        [Пример данных](https://storage.googleapis.com/hyperdx/sample.tar.gz)

        ```shell theme={null}
        # curl
        curl -O https://storage.googleapis.com/hyperdx/sample.tar.gz
        # or
        # wget https://storage.googleapis.com/hyperdx/sample.tar.gz
        ```

        Этот файл содержит примеры журналов, метрик и трассировок из нашего публичного [демо-приложения OpenTelemetry](https://github.com/ClickHouse/opentelemetry-demo) — простого интернет-магазина на микросервисах. Скопируйте этот файл в любой каталог по вашему выбору.
      </Step>

      <Step title="Загрузите пример данных" id="load-sample-data-managed">
        Чтобы загрузить эти данные, достаточно отправить их в HTTP-конечную точку развернутого OTel collector OpenTelemetry.

        Выполните следующую команду, чтобы отправить данные в OTel collector:

        ```shell theme={null}
        for filename in $(tar -tf sample.tar.gz); do
          endpoint="http://localhost:4318/v1/${filename%.json}"
          echo "loading ${filename%.json}"
          tar -xOf sample.tar.gz "$filename" | while read -r line; do
            printf '%s\n' "$line" | curl -s -o /dev/null -X POST "$endpoint" \
            -H "Content-Type: application/json" \
            -H "authorization: ${CLICKSTACK_API_KEY}" \
            --data-binary @-
          done
        done
        ```

        Это имитирует отправку данных в OTel collector из OTLP-источников логов, трассировок и метрик. В рабочей среде такими источниками могут быть клиентские библиотеки разных языков или даже другие экземпляры OTel collector.

        Вернувшись к представлению `Search`, вы должны увидеть, что данные начали загружаться (измените временной диапазон на `Last 1 hour`, если данные не отображаются):

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-10.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=9a89d3a7813753deafaef49e1def2b3e" alt="Поиск HyperDX" size="lg" width="3430" height="2340" data-path="images/use-cases/observability/hyperdx-10.webp" />

        Загрузка данных займет несколько минут. Прежде чем переходить к следующим шагам, дождитесь ее завершения.
      </Step>

      <Step title="Изучение сеансов" id="explore-sessions-managed">
        Предположим, нам поступают сообщения о том, что у пользователей возникают проблемы с оплатой товаров. Мы можем просмотреть их действия с помощью функции воспроизведения сеанса в HyperDX.

        Выберите `Client Sessions` в левом меню.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-11.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=7c25bbb58f595c5d9d7e75123ebec3fa" alt="Сеансы" size="lg" width="4852" height="2890" data-path="images/use-cases/observability/hyperdx-11.webp" />

        В этом представлении отображаются фронтенд-сеансы для нашего интернет-магазина. Сеансы остаются Anonymous, пока пользователи не переходят к оформлению заказа и не пытаются завершить покупку.

        Обратите внимание, что некоторые сеансы с адресами электронной почты связаны с ошибкой, что может подтверждать сообщения о неудачных транзакциях.

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

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-12.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=d8af229aee308432da053bbb36f12498" alt="Воспроизведение сеанса" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-12.webp" />

        На записи видно, как пользователь перемещается по сайту и добавляет товары в корзину. При желании можно перейти к более позднему моменту сеанса, где он пытается завершить оплату.

        <Tip>
          Все ошибки помечены на временной шкале красным цветом.
        </Tip>

        Пользователь не смог оформить заказ, при этом явной ошибки не видно. Прокрутите левую панель вниз — в ней показаны сетевые события и события консоли из браузера пользователя. Вы заметите, что при вызове `/api/checkout` возникла ошибка 500.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-13.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=f92124c11b1f88f11975d6b33c935105" alt="Ошибка в сеансе" size="lg" width="4874" height="2892" data-path="images/use-cases/observability/hyperdx-13.webp" />

        Выберите эту ошибку `500`. Ни `Overview`, ни `Column Values` не указывают на источник проблемы, кроме того, что ошибка является неожиданной и приводит к `Internal Error`.
      </Step>

      <Step title="Просмотр трассировок" id="explore-traces-managed">
        Перейдите на вкладку `Trace`, чтобы увидеть полную распределенную трассировку.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-14.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=990794449653453b1b1b3adb9b414388" alt="Трассировка сеанса" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-14.webp" />

        Прокрутите трассировку вниз, чтобы увидеть источник ошибки — спан сервиса `checkout`. Выберите спан сервиса `Payment`.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-15.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=deb9d0e1e99f3dbb613319caf7e2d0fd" alt="Спан" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-15.webp" />

        Выберите вкладку `Column Values` и прокрутите вниз. Мы видим, что проблема связана с переполнением кэша.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-16.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=0ba807a164c0804b2694012abee7be65" alt="Значения столбцов" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-16.webp" />

        Если прокрутить вверх и вернуться к трассировке, видно, что журналы коррелируются со спаном благодаря выполненной ранее настройке. Это дает дополнительный контекст.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-17.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=c3e60ac38f009319d4461496b2f791b7" alt="Скоррелированный журнал" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-17.webp" />

        Мы установили, что в сервисе Payment заполняется кэш, из-за чего платежи не могут завершиться.
      </Step>

      <Step title="Просмотр журналов" id="explore-logs-managed">
        Чтобы узнать больше, можно вернуться к `Search`:

        Выберите `Logs` в списке источников и примените фильтр по сервису `payment`.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-18.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=1d40324604495c6a3e10128b3226545f" alt="Журналы" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-18.webp" />

        Мы видим, что, хотя проблема возникла недавно, количество затронутых платежей велико. Кроме того, похоже, что проблемы вызывает кэш, связанный с платежами Visa.
      </Step>

      <Step title="Метрики диаграммы" id="chart-metrics-managed">
        Хотя в коде явно была внесена ошибка, мы можем использовать метрики, чтобы проверить размер кэша. Перейдите в представление `Chart Explorer`.

        Выберите `Metrics` в качестве источника данных. Настройте диаграмму в конструкторе так, чтобы построить `Maximum` для `visa_validation_cache.size (Gauge)`, и нажмите кнопку play. До достижения максимального размера кэш явно рос, после чего начали возникать ошибки.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-19.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=0895afb852e42675f8afb40c94328ad8" alt="Метрики" size="lg" width="3600" height="1856" data-path="images/use-cases/observability/hyperdx-19.webp" />
      </Step>
    </Steps>
  </Tab>

  <Tab title="ClickStack с открытым исходным кодом">
    В следующем примере предполагается, что вы запустили Open Source ClickStack по [инструкциям для образа all-in-one](/ru/clickstack/getting-started/oss) и подключились к [локальному экземпляру ClickHouse](/ru/clickstack/getting-started/oss#complete-connection-credentials).

    <Steps>
      <Step title="Перейдите в интерфейс ClickStack (HyperDX)" id="navigate-to-the-hyperdx-ui">
        Чтобы открыть интерфейс ClickStack, перейдите по адресу [http://localhost:8080](http://localhost:8080).

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=83450e0056b310e050a142d0a56cd17d" alt="Интерфейс ClickStack" size="lg" width="3430" height="2340" data-path="images/use-cases/observability/hyperdx.webp" />
      </Step>

      <Step title="Скопируйте ключ API для приёма данных" id="copy-ingestion-api-key">
        Перейдите в [`Team Settings`](http://localhost:8080/team) и скопируйте `Ingestion API Key` из раздела `API Keys`. Этот ключ API обеспечивает безопасный приём данных через OpenTelemetry Collector.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/vnt1RXee1wStk7Ew/images/use-cases/observability/copy_api_key.webp?fit=max&auto=format&n=vnt1RXee1wStk7Ew&q=85&s=51517b9adaff77ba368514f2f38932ec" alt="Копирование ключа API" size="lg" width="3600" height="1856" data-path="images/use-cases/observability/copy_api_key.webp" />
      </Step>

      <Step title="Скачайте пример данных" id="download-sample-data">
        Чтобы заполнить интерфейс примером данных, скачайте следующий файл:

        [Пример данных](https://storage.googleapis.com/hyperdx/sample.tar.gz)

        ```shell theme={null}
        # curl
        curl -O https://storage.googleapis.com/hyperdx/sample.tar.gz
        # or
        # wget https://storage.googleapis.com/hyperdx/sample.tar.gz
        ```

        Этот файл содержит примеры журналов, метрик и трассировок из нашего публичного [демо-приложения OpenTelemetry](https://github.com/ClickHouse/opentelemetry-demo) — простого интернет-магазина на микросервисах. Скопируйте этот файл в любой каталог по вашему выбору.
      </Step>

      <Step title="Загрузите пример данных" id="load-sample-data">
        Чтобы загрузить эти данные, просто отправьте их на HTTP-конечную точку развернутого коллектора OpenTelemetry (OTel).

        Сначала экспортируйте API-ключ, скопированный выше.

        ```shell theme={null}
        # export API key
        export CLICKSTACK_API_KEY=<YOUR_INGESTION_API_KEY>
        ```

        Выполните следующую команду, чтобы отправить данные в OTel collector:

        ```shell theme={null}
        for filename in $(tar -tf sample.tar.gz); do
          endpoint="http://localhost:4318/v1/${filename%.json}"
          echo "loading ${filename%.json}"
          tar -xOf sample.tar.gz "$filename" | while read -r line; do
            printf '%s\n' "$line" | curl -s -o /dev/null -X POST "$endpoint" \
            -H "Content-Type: application/json" \
            -H "authorization: ${CLICKSTACK_API_KEY}" \
            --data-binary @-
          done
        done
        ```

        Это имитирует отправку данных в OTel collector из OTLP-источников логов, трассировок и метрик. В рабочей среде такими источниками могут быть клиентские библиотеки разных языков или даже другие экземпляры OTel collector.

        Вернувшись к представлению `Search`, вы должны увидеть, что данные начали загружаться (измените временной диапазон на `Last 1 hour`, если данные не отображаются):

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-10.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=9a89d3a7813753deafaef49e1def2b3e" alt="Поиск HyperDX" size="lg" width="3430" height="2340" data-path="images/use-cases/observability/hyperdx-10.webp" />

        Загрузка данных займет несколько минут. Прежде чем переходить к следующим шагам, дождитесь ее завершения.
      </Step>

      <Step title="Изучение сеансов" id="explore-sessions">
        Предположим, нам поступают сообщения о том, что у пользователей возникают проблемы с оплатой товаров. Мы можем посмотреть, что происходило, с помощью функции воспроизведения сеанса в HyperDX.

        Выберите [`Client Sessions`](http://localhost:8080/sessions?from=1747312320000\&to=1747312920000\&sessionSource=l1324572572) в левом меню.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-11.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=7c25bbb58f595c5d9d7e75123ebec3fa" alt="Сеансы" size="lg" width="4852" height="2890" data-path="images/use-cases/observability/hyperdx-11.webp" />

        В этом представлении можно увидеть фронтенд-сеансы нашего интернет-магазина. Сеансы остаются анонимными, пока пользователи не переходят к оформлению заказа и не пытаются завершить покупку.

        Обратите внимание: у некоторых сеансов, связанных с адресами электронной почты, есть ошибка, что может подтверждать сообщения о неуспешных транзакциях.

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

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-12.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=d8af229aee308432da053bbb36f12498" alt="Воспроизведение сеанса" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-12.webp" />

        На записи видно, как пользователь перемещается по сайту и добавляет товары в корзину. При желании можно перейти к более позднему моменту сеанса, где он пытается завершить оплату.

        <Tip>
          Все ошибки помечены на временной шкале красным цветом.
        </Tip>

        Пользователь не смог оформить заказ, хотя явной ошибки не видно. Прокрутите левую панель вниз — в ней показаны события Network и консоли из браузера пользователя. Вы увидите, что при вызове `/api/checkout` была сгенерирована ошибка 500.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-13.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=f92124c11b1f88f11975d6b33c935105" alt="Ошибка в сеансе" size="lg" width="4874" height="2892" data-path="images/use-cases/observability/hyperdx-13.webp" />

        Выберите эту ошибку `500`. Ни `Overview`, ни `Column Values` не указывают на источник проблемы, кроме того, что ошибка является неожиданной и приводит к `Internal Error`.
      </Step>

      <Step title="Просмотр трассировок" id="explore-traces">
        Перейдите на вкладку `Trace`, чтобы увидеть полную распределенную трассировку.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-14.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=990794449653453b1b1b3adb9b414388" alt="Трассировка сеанса" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-14.webp" />

        Прокрутите трассировку вниз, чтобы увидеть источник ошибки — спан сервиса `checkout`. Выберите спан сервиса `Payment`.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-15.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=deb9d0e1e99f3dbb613319caf7e2d0fd" alt="Спан" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-15.webp" />

        Выберите вкладку `Column Values` и прокрутите вниз. Мы видим, что проблема связана с переполнением кэша.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-16.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=0ba807a164c0804b2694012abee7be65" alt="Значения столбцов" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-16.webp" />

        Если прокрутить вверх и вернуться к трассировке, видно, что журналы коррелируются со спаном благодаря выполненной ранее настройке. Это дает дополнительный контекст.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-17.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=c3e60ac38f009319d4461496b2f791b7" alt="Скоррелированный журнал" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-17.webp" />

        Мы установили, что в сервисе Payment заполняется кэш, из-за чего платежи не могут завершиться.
      </Step>

      <Step title="Просмотр журналов" id="explore-logs">
        Чтобы получить больше сведений, можно вернуться к представлению [`Search`](http://localhost:8080/search):

        В списке источников выберите `Logs` и примените фильтр по сервису `payment`.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-18.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=1d40324604495c6a3e10128b3226545f" alt="Журналы" size="lg" width="4874" height="2890" data-path="images/use-cases/observability/hyperdx-18.webp" />

        Мы видим, что, хотя проблема возникла недавно, число затронутых платежей велико. Кроме того, похоже, проблемы вызывает кэш, связанный с платежами Visa.
      </Step>

      <Step title="Метрики диаграммы" id="chart-metrics">
        Хотя в коде явно была внесена ошибка, мы можем использовать метрики, чтобы проверить размер кэша. Перейдите в представление `Chart Explorer`.

        Выберите `Metrics` в качестве источника данных. Настройте диаграмму в конструкторе так, чтобы построить `Maximum` для `visa_validation_cache.size (Gauge)`, и нажмите кнопку play. До достижения максимального размера кэш явно рос, после чего начали возникать ошибки.

        <Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/iEAgjqwTqSD6ogQ0/images/use-cases/observability/hyperdx-19.webp?fit=max&auto=format&n=iEAgjqwTqSD6ogQ0&q=85&s=0895afb852e42675f8afb40c94328ad8" alt="Метрики" size="lg" width="3600" height="1856" data-path="images/use-cases/observability/hyperdx-19.webp" />
      </Step>
    </Steps>
  </Tab>
</Tabs>
