AI-Ops Documentation

Русский English
  • Главная
  • Карта документации
0. С чего начать
  • Что это за продукт
  • Для кого он
  • Как устроена документация
  • Быстрые ссылки
  • Как начать разработку
  • Как найти нужный сервис
  • К кому идти по вопросам
1. Продукт
Обзор продукта
  • Миссия продукта
  • Ценность для бизнеса
  • Основные сценарии
  • Границы системы
Пользователи и персоны
  • Сегменты пользователей
  • Роли пользователей
  • Основные потребности
Пользовательские сценарии
  • Регистрация / логин
  • Основной пользовательский сценарий
  • Оплата / заказ / действие
  • Поддержка и сценарий восстановления
Функции продукта
Фича: Аутентификация
  • Цель
  • Пользовательская история
  • Бизнес-правила
  • Ограничения
  • Метрики успеха
  • Связанные сервисы
  • Связанные события / данные
  • Фича: Профиль
  • Фича: Организации
  • Фича: Топология
  • Фича: Вычислительные ресурсы
  • Фича: Кластеры
  • Фича: Каталог сервисов
Требования
  • Функциональные требования
  • Нефункциональные требования
  • Требования к производительности
  • Требования к безопасности
  • Конфиденциальность и соответствие
  • Доступность
Метрики
  • Ключевая метрика (North Star)
  • Продуктовые KPI
  • Метрики воронки
  • Метрики качества
  • Метрики экспериментов
2. Домены
Домен: Identity
  • Назначение
  • Основные концепции
  • Сущности
  • Бизнес-правила
  • Сервисы домена
  • Данные домена
  • Связанные фичи
  • Домен: Профиль пользователя
  • Домен: Поиск
  • Домен: Заказы / транзакции
  • Домен: Уведомления
  • Домен: Аналитика
  • Домен: Рекомендации
3. Архитектура
Обзор системы
  • Что входит в систему
  • Что не входит
  • Высокоуровневая диаграмма
C4 Model
  • Контекстная диаграмма
  • Диаграмма контейнеров
  • Диаграмма компонентов
  • Диаграмма развёртывания
Интеграционная архитектура
  • Внешние системы
  • Интеграции API
  • Webhooks
  • Сторонние провайдеры
Потоки данных
  • Онлайн-поток данных
  • Пакетный поток данных
  • Поток событий
  • Владение данными
Архитектура безопасности
  • Аутентификация
  • Авторизация
  • Управление секретами
  • Шифрование
  • Аудит и логирование
Надежность и масштабируемость
  • SLA / SLO
  • Планирование мощностей
  • Отказоустойчивость
  • Обратное давление и повторы
  • Восстановление после сбоев
Архитектурные принципы
  • Границы доменов
  • Принципы проектирования API
  • Принципы проектирования событий
  • Принципы контрактов данных
  • Диаграмма: auth микросервисы
Control plane
  • Архитектура компонентов (control plane)
  • Доменная модель v0
  • Протокол v0 (control plane)
  • Примеры (control plane)
Сервисы (control plane)
Сервис control plane
  • API
  • Модель данных
  • События
  • Модули
  • Операции
Сервис execution plane
  • API
  • Модель данных
  • События
  • Модули
  • Операции
Сервис resource catalog
  • API
  • Модель данных
  • События
  • Модули
  • Операции
4. Инженерия
Сервисы
Каталог сервисов
  • Все сервисы списком
  • Владельцы
  • Критичность
  • Уровень / домен / статус
  • Сервис аутентификации
  • Сервис аккаунтов
  • Облачный сервис
  • Сервис учётных данных
  • Herald
  • Сервис идентификации
  • API Gateway
  • Сервис токенов
Фронтенд
  • Обзор фронтенда
  • Структура приложения
  • Routing (фронтенд)
  • State management (фронтенд)
  • Design system (фронтенд)
  • UI components (фронтенд)
  • API контракты фронтенда
  • Обработка ошибок (фронтенд)
  • Performance (фронтенд)
  • Feature flags (фронтенд)
  • Тестирование фронтенда
Бэкенд
  • Обзор бэкенда
  • Паттерны сервисов
  • Рекомендации по API
  • Событийные паттерны
  • Паттерны доступа к БД
  • Кэширование
  • Асинхронные задачи и воркеры
  • Идемпотентность
  • Обработка ошибок
  • Тестирование бэкенда
Данные
  • Обзор данных
  • Системы-источники
  • Контракты данных
  • Каталог схем событий
  • Хранилище данных
  • Витрины данных
  • ETL / ELT-пайплайны
  • Качество данных
  • Происхождение данных
  • Политики хранения
  • Политики доступа
ML / DS
  • Обзор ML/DS
  • Сценарии (ML)
  • Каталог моделей
  • Feature store
  • Training pipelines
  • Inference pipelines
  • Offline evaluation
  • Online evaluation / A-B
  • Мониторинг (ML)
  • ML runbooks
QA / Качество
  • Стратегия качества
  • Пирамида тестов
  • Тестовые окружения
  • Тестовые данные
  • Ручное тестирование
  • Автоматизированное тестирование
  • Нагрузочное тестирование
  • Тестирование безопасности
  • Критерии приёмки релиза
  • Процесс разбора багов
5. Платформа
Инфраструктура
  • Ansible
  • WireGuard
  • Kubernetes
  • Longhorn
  • Ingress
  • PostgreSQL Cluster
  • Redis
  • Kafka
  • Vault
  • MinIO
  • Authentik
  • Monitoring
  • Logging
  • Tracing
  • Nexus
  • SonarQube
  • GlitchTip
  • GitLab Runner
  • Kubernetes Dashboard
  • OLM
  • Deploy
  • Internal DNS
  • Обзор (инфраструктура)
  • Config generator
  • Пример (инфраструктура)
  • Скрипты (инфраструктура)
Окружения
  • Локальное
  • Stage
  • Pre
  • Продакшен (prod)
  • Tech
  • Облако
  • Объектное хранилище
  • CI/CD
  • Секреты и сертификаты
Наблюдаемость
  • Логирование
  • Метрики
  • Трейсинг
  • Алертинг
  • Резервное копирование и восстановление
6. Разработка
  • Быстрый старт
  • Локальная настройка
  • Карта репозиториев
  • Стандарты кода
  • Git-процесс
  • Стратегия ветвления
  • Руководство по код-ревью
  • Критерии готовности
  • Процесс релиза
  • Флаги фич
  • FAQ разработчика
  • Миграция secure auth
7. Эксплуатация
  • Дежурство
  • Управление инцидентами
  • Уровни критичности
  • Политика эскалации
  • Постмортемы
  • Ранбуки
  • Управление изменениями
  • Непрерывность бизнеса
8. Аналитика
  • План трекинга событий
  • Определения KPI
  • Каталог дашбордов
  • Словарь метрик
  • Эксперименты
  • Стандарты отчётности
9. Управление
  • Решения (ADR)
  • Политика статуса контента
  • Changelog обновлений документации
Безопасность и соответствие
  • Модель угроз
  • Безопасная разработка
  • Управление доступом
  • Конфиденциальность
  • Реагирование на инциденты
Ответственность и владельцы
  • Команды
  • Зоны ответственности команд
  • Владельцы сервисов
  • Владельцы доменов
  • Контакты
Глоссарий
  • Бизнес-термины
  • Продуктовые термины
  • Технические термины
  • Сокращения

Обзор бэкенда

Previous Next

Backend платформы AIOps построен как набор микросервисов на Python 3.12+ и Go (версия определяется services/*/go.mod), следующих принципам Clean Architecture, Domain-Driven Design и Event-Driven Architecture.

Статус контента

  • Статус: Stable
  • Проверено: 2026-03-12
  • Примечание: версии библиотек ниже даны как ориентир и валидируются по pyproject.toml сервисов

Архитектурный стиль

Микросервисы

  • Каждый сервис владеет своей БД (Database per Service).
  • Внутренняя коммуникация: gRPC (internal), REST (public API где нужно).
  • Асинхронная коммуникация: Kafka (события).

Clean Architecture (слои)

Все Python-сервисы (Identity, Credential и др.) имеют единую структуру:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
src/<service_name>/
├── core/           # Domain Layer — не зависит ни от чего
│   ├── <aggregate>/
│   │   ├── entities.py      # Pydantic domain entities
│   │   ├── repositories.py  # Repository protocols (ABC)
│   │   ├── services.py      # Domain services
│   │   ├── dto.py
│   │   └── errors.py
├── use_cases/       # Application Layer — зависит только от core
│   └── <verb>_<noun>.py     # Use case implementations
├── infra/          # Infrastructure Layer
│   ├── db/orm/              # SQLAlchemy models
│   ├── repositories/        # Repository implementations
│   ├── kafka/               # Topics, publishers
│   ├── di/                  # Dishka providers
│   └── uow.py               # Unit of Work
└── api/            # Presentation Layer
    └── servicers/v1/        # gRPC servicers

Правило зависимостей: зависимости направлены внутрь. core не импортирует infra или api.

Ключевые паттерны

  • Transactional Outbox — надежная публикация событий в Kafka (at-least-once).
  • Unit of Work — координация транзакций и репозиториев.
  • Repository — абстракция доступа к данным (протокол в core, реализация в infra).
  • Domain Services — бизнес-логика, не привязанная к одной сущности (например, PasswordDomainService для хеширования и валидации паролей).

Технологический стек

Python

  • Runtime: Python 3.12+, asyncio, uvloop (Linux/macOS).
  • Validation: Pydantic 2.x.
  • ORM: SQLAlchemy 2.x (async), asyncpg.
  • DI: Dishka 1.7+.
  • gRPC: grpcio 1.78+, grpc-health-checking, grpc-reflection.
  • Messaging: aiokafka, библиотека omni-box.
  • Security: argon2-cffi (пароли), zxcvbn-python (сложность пароля).
  • Observability: structlog, prometheus-client, OpenTelemetry.
  • Testing: pytest, pytest-asyncio, grpcio-testing, factory-boy, testcontainers.

Go (API Gateway)

  • Control Plane: xDS server для Envoy, file watcher для hot reload.
  • Data Plane: Envoy Proxy (TLS, JWT, rate limiting, RBAC).

Данные

  • PostgreSQL — основное хранилище, партиционирование для outbox.
  • Redis — кеш, rate limiting.
  • Kafka — event streaming (Strimzi Operator в K8s).

Общие библиотеки (libs/python)

Переиспользуемый код вынесен в общие пакеты (физически — в libs/python/common/, communication/, storage/, runtime/; полный список путей — libs/python/README.md):

Библиотека Назначение
grpc-stubs Сгенерированные protobuf/gRPC stubs
omni-box Реализация паттернов Transactional Outbox/Inbox
unit-of-work-kit Базовые классы Unit of Work
sqlalchemy-postgres-kit Сессии, базовые модели для PostgreSQL
grpc-server-kit Lifecycle gRPC сервера
grpc-interceptor-kit Context, tracing, metrics, logging, Sentry
dishka-providers Провайдеры Dishka для DB, Redis, Kafka
pydantic-settings-kit Настройки из env
service-observability Логирование, метрики, трейсинг
kafka-publisher-kit Обертка над Kafka producer
redis-client-kit Redis client

Протоколы и контракты

  • Proto: proto/aiops/identity/v1/, proto/aiops/credential/v1/ — контракты gRPC.
  • Версионирование: все API под суффиксом v1, обратная совместимость обязательна.

Связанные страницы

  • Service Patterns — детали паттернов сервисов
  • Event-Driven Patterns — Outbox, Kafka
  • Database Access Patterns — Repository, UoW
  • API Guidelines — gRPC, ошибки, идемпотентность
  • Identity service — пример реализации
  • Architecture / Data Flow — поток событий
Бэкенд Паттерны сервисов
Меню
Главная Карта документации
0. С чего начать
С чего начать Что это за продукт Для кого он Как устроена документация Быстрые ссылки Как начать разработку Как найти нужный сервис К кому идти по вопросам
1. Продукт
Продукт
2. Домены
Домены Домен: Профиль пользователя Домен: Поиск Домен: Заказы / транзакции Домен: Уведомления Домен: Аналитика Домен: Рекомендации
3. Архитектура
Архитектура Диаграмма: auth микросервисы
4. Инженерия
Инженерия
5. Платформа
Платформа Облако Объектное хранилище CI/CD Секреты и сертификаты Резервное копирование и восстановление
6. Разработка
Разработка Быстрый старт Локальная настройка Карта репозиториев Стандарты кода Git-процесс Стратегия ветвления Руководство по код-ревью Критерии готовности Процесс релиза Флаги фич FAQ разработчика Миграция secure auth
7. Эксплуатация
Эксплуатация Дежурство Управление инцидентами Уровни критичности Политика эскалации Постмортемы Ранбуки Управление изменениями Непрерывность бизнеса
8. Аналитика
Аналитика План трекинга событий Определения KPI Каталог дашбордов Словарь метрик Эксперименты Стандарты отчётности
9. Управление
Управление Решения (ADR) Политика статуса контента Changelog обновлений документации

На странице

Статус контента Архитектурный стиль Микросервисы Clean Architecture (слои) Ключевые паттерны Технологический стек Python Go (API Gateway) Данные Общие библиотеки (libs/python) Протоколы и контракты Связанные страницы