Розгортання Docker

Попередні вимоги

• Docker
• Docker Compose v2.0.0+
• Make (опціонально)
• 6 ГБ оперативної памʼяті для застосунку

Отримання та запуск демо

1. Клонуйте репозиторій Demo:

   git clone https://github.com/open-telemetry/opentelemetry-demo.git
   

2. Перейдіть до теки з демо:

   cd opentelemetry-demo/
   

3. Запустіть демо¹:

   • Make
   • Docker

   make start
   

   docker compose up --force-recreate --remove-orphans --detach
   

4. (Опціонально) Увімкніть тестування на основі спостережуваності API¹:

   • Make
   • Docker

   make run-tracetesting
   

   docker compose -f docker-compose-tests.yml run traceBasedTests
   

Перевірка роботи вебмагазину та телеметрії

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

• Вебмагазин: http://localhost:8080/
• Grafana: http://localhost:8080/grafana/
• Інтерфейс користувача генератора навантаження: http://localhost:8080/loadgen/
• Інтерфейс користувача Jaeger: http://localhost:8080/jaeger/ui/
• Інтерфейс користувача Tracetest: http://localhost:11633/, тільки при використанні make run-tracetesting
• Інтерфейс користувача конфігуратора Flagd: http://localhost:8080/feature

Зміна номера основного порту демо

Стандартно, демонстраційний застосунок запустить проксі для всього трафіку з вебоглядача, привʼязаного до порту 8080. Щоб змінити номер порту, встановіть змінну середовища ENVOY_PORT перед запуском демо.

• Наприклад, щоб використовувати порт 8081¹:

  • Make
  • Docker

  ENVOY_PORT=8081 make start
  

  ENVOY_PORT=8081 docker compose up --force-recreate --remove-orphans --detach
  

Використання власного бекенду

Ймовірно, ви хочете використовувати вебмагазин як демонстраційний застосунок для наявного бекенду спостережуваності (наприклад, поточного екземпляра Jaeger, Zipkin або одного з вибраних вами постачальників).

OpenTelemetry Collector можна використовувати для експорту даних телеметрії до кількох бекендів. Стандартно, колектор у демонстраційного застосунку обʼєднає конфігурацію з двох файлів:

• otelcol-config.yml
• otelcol-config-extras.yml

Щоб додати свій бекенд, відкрийте файл src/otelcollector/otelcol-config-extras.yml за допомогою редактора.

• Почніть з додавання нового експортера. Наприклад, якщо ваш бекенд підтримує OTLP через HTTP, додайте наступне:

  exporters:
    otlphttp/example:
      endpoint: <your-endpoint-url>
  

• Потім зробіть перевизначення exporters для телеметричних конвеєрів, які ви хочете використовувати для вашого бекенду.

  service:
    pipelines:
      traces:
        exporters: [spanmetrics, otlphttp/example]
  

Бекенди постачальників можуть вимагати додавання додаткових параметрів для автентифікації, будь ласка, перевірте їх документацію. Деякі бекенди вимагають різних експортерів, ви можете знайти їх і їх документацію на opentelemetry-collector-contrib/exporter.

Після оновлення otelcol-config-extras.yml, запустіть демо, виконавши make start. Через деякий час ви повинні побачити, як трасування надходять до вашого бекенду.