Velatrix Cloud Ops | Документация и API

Quickstart

1. Подключение первого окружения

После входа в workspace создайте пространство команды, выберите основной регион и добавьте один из стандартных источников: Prometheus-compatible endpoint, structured logs stream или deploy webhook из CI/CD.

Рекомендация

Для первого запуска достаточно latency, saturation, service ownership labels и deploy annotations. Так первые incident cards будут содержать полезный контекст уже в день интеграции.

Sources

2. Источники телеметрии и единая схема сервисов

Velatrix нормализует входящие данные до общего operational schema, поэтому фильтры, ownership и сервисные связи одинаково работают для логов, метрик, событий deploy и cost snapshots.

telemetry_source:
  kind: prometheus_remote_write
  workspace: core-platform
  labels:
    env: production
    region: eu-central-1
    team: growth-platform
  sampling:
    high_cardinality: drop
    exemplars: keep

Alerts

3. Правила, бюджеты и каналы уведомлений

Алерты собираются по порогам, budget policy и composite-условиям. Платформа может требовать одновременный рост latency и падение success rate, чтобы не шуметь на временных пиках.

alert "api-degradation" {
  when latency_p95_ms > 450 for 5m
  and success_rate < 99.2
  notify ["slack:ops-primary", "email:incident-lead"]
  runbook "/runbooks/api-latency"
}

Runbooks

4. Runbook links и handoff-процессы

У каждой alert policy можно указать runbook, владельца сервиса и handoff note для следующей смены. Это снижает количество устных договоренностей и делает postmortem воспроизводимым.

Практика

Хороший runbook в Velatrix начинается с критериев отката, затем перечисляет временные mitigation-step и завершает чек-листом для фиксации решения в incident timeline.

Rate limits

5. Ограничения API и поведение интеграций

API ориентирован на системные интеграции и ожидает предсказуемый трафик. При burst-нагрузке ответы будут замедляться раньше, чем выдадут hard block, чтобы пайплайн мог мягко повторить запрос.

Тип Ограничение Поведение

Alerts API 120 req/min При превышении возвращается задержка и advisory заголовок для backoff.

Events API 600 req/min Поддерживает batched delivery и idempotency key.

Read APIs 900 req/min Запросы из UI и automation делят лимиты по workspace token.

API Reference

6. Типовой REST API для синхронизации статуса сервисов, метрик и viewer context

Ниже приведен типовой формат запросов для UI-клиента и внутренней automation-обвязки. Demo-интерфейс использует те же endpoint-имена, что и рабочий preview: `/api/status`, `/api/metrics`, `/api/user`.

curl https://velatrix.local/api/metrics \
  -H "X-Workspace: ops-core-demo" \
  -H "X-Region: eu-central-1"

Метод Endpoint Назначение

GET /api/status Статус control plane, active region, ingest lag, release lane и heartbeat summary.

GET /api/metrics CPU, requests, uptime, error budget, replica health и временное окно нагрузки.

GET /api/user Профиль текущего viewer, entitlements, feature flags и привязанный workspace.

Integration notes

Типовая схема подключения workspace

Схема источников данных и routing в Velatrix