← На главную

Руководство по эксплуатации

Подключение приложений и типовые сценарии

Этот документ описывает повседневную работу с ObserveAI: подключение приложений, типовые сценарии расследования инцидентов, обслуживание и решение проблем.

Подготовка к работе

  1. Откройте в браузере observeai.kayaniq.ru (либо локальный адрес on-premise установки).
  2. Зарегистрируйте аккаунт через форму регистрации.
  3. Подтвердите адрес электронной почты.
  4. Получите API-ключ в разделе «API-ключи» личного кабинета.
  5. Установите SDK для своего языка программирования (см. ниже).

Установка SDK

Python

pip install observeai
import observeai
observeai.init(api_key="oai_", service_name="my-app")

Node.js

npm install observeai
const observeai = require('observeai');
observeai.init({ apiKey: 'oai_', serviceName: 'my-app' });

Go

go get github.com/kayaniq/observeai-go

C# / .NET

dotnet add package ObserveAI

JavaScript (браузер)

<script src="https://observeai.kayaniq.ru/observeai.js"></script>
<script>
  ObserveAI.init({ apiKey: 'oai_', service: 'frontend' });
</script>

Типовые сценарии работы

1. Расследование инцидента производительности

Сценарий: пользователи жалуются на медленную работу /checkout.

  1. Перейдите в раздел Производительность (APM)
  2. Найдите endpoint /checkout, посмотрите перцентили p50/p95/p99 за последний час
  3. Кликните по endpoint'у — откроется список конкретных трейсов с самой большой задержкой
  4. Откройте проблемный трейс — увидите Gantt-диаграмму всех спанов запроса
  5. Подсвеченный «горячий» спан покажет где именно теряется время — БД, внешний API, бизнес-логика
  6. Перейдите к связанным логам через раздел Корреляция

2. Анализ всплеска ошибок

  1. В разделе Ошибки отсортируйте группы по частоте за период
  2. Откройте группу с наибольшим числом случаев
  3. Изучите stack trace и атрибуты ошибки
  4. После исправления отметьте ошибку как «решена»

3. Настройка алерта

  1. В разделе Оповещения создайте правило
  2. Укажите условие: «когда процент ошибок endpoint /checkout превысит 5% за 5 минут»
  3. Выберите канал: Slack-вебхук, email или произвольный HTTP-вебхук
  4. Активируйте правило — оповещение придёт сразу при срабатывании

4. Поиск конкретной ошибки в логах

  1. В разделе Логи примените фильтры: сервис, уровень ERROR, временное окно
  2. Введите ключевое слово в поиск (например, идентификатор пользователя)
  3. Сохраните запрос как «Сохранённый поиск» для повторного использования
  4. При необходимости экспортируйте результаты в CSV или JSON

5. Просмотр карты сервисов

В разделе Карта сервисов отображается автоматически построенный граф зависимостей. Связи между сервисами рассчитываются на основе trace-данных. Подсветка цветом — по уровню ошибок и задержки.

Журналирование и мониторинг работоспособности

В каждом on-premise экземпляре ведутся журналы:

Регулярно проверяйте:

Обслуживание

Обновление программы

cd /opt/observeai
git pull
docker compose pull
docker compose up -d --build

Резервное копирование

# Создание бэкапа
docker compose exec postgres pg_dumpall -U observeai > backup_$(date +%F).sql

# Восстановление
cat backup_2026-01-15.sql | docker compose exec -T postgres psql -U observeai

Очистка старых данных

Политика хранения данных (retention) настраивается через интерфейс. Очистка старых docker-образов:

docker system prune -af --volumes=false

Решение типовых проблем

Безопасность эксплуатации

Контакты технической поддержки

Электронная почта: [email protected]