ДОКУМЕНТАЦИЯ

Rebound SDK

Запишите трассировку, структурированный лог или метрику в браузере, скачайте снимок и исследуйте его в демо-панели.

Быстрый старт

Скачайте скрипт и подключите его на странице. Клиент хранит события в памяти текущей вкладки. Скачайте снимок перед перезагрузкой, если хотите сохранить данные.

index.html
<script src="./rebound-sdk.js"></script>
<script>
  const client = Rebound.createClient({ service: 'checkout-api' });
  client.log('info', 'Клиент подключён', { environment: 'demo' });
  // Вызовите из обработчика кнопки, чтобы скачать снимок.
  // client.download();
</script>

Примеры использования

Запустите пример, скачайте снимок и загрузите его через «Импорт JSON» в панели.

Открыть панель

Справочник API

Rebound.createClient({ service })
Создаёт независимый клиент. Имя сервиса записывается в каждый сигнал. По умолчанию используется app.
client.trace(name, callback, options?)
Выполняет синхронный или асинхронный callback, которому передаёт спан. Возвращает Promise с результатом. При исключении помечает спан как error и пробрасывает исключение. Принимает те же параметры, что и startSpan.
client.startSpan(name, { attributes, parent, startTime }?)
Начинает спан для ручного управления. Используйте span.startSpan(name, options?) для дочерней операции, а otherClient.startSpan(name, { parent: span.context }) для связи двух клиентов. Завершайте спан вызовом span.end({ status, timestamp }). Статусы ok и error.
client.log(level, message, attributes?, { traceId, timestamp }?)
Записывает структурированный лог. Уровни debug, info, warn и error. Вызов span.log(level, message, attributes?, options?) автоматически добавляет идентификатор трейса.
client.record(name, value, { unit, attributes, timestamp }?)
Записывает числовое измерение. На панели можно выбрать имя и единицу метрики и посмотреть её значения за период.
client.snapshot() и client.download(filename?)
Возвращают копию снимка в виде объекта и скачивают снимок в JSON соответственно. В снимок попадают завершённые спаны.

Время задаётся в миллисекундах Unix и по умолчанию берётся из Date.now(). Значения атрибутов могут быть строками, конечными числами или логическими значениями.

Формат снимка

Панель принимает JSON версии 1 размером до 10 МБ. Поля spans, logs и metrics обязательны и могут быть пустыми. Импорт обрабатывается в браузере.

rebound-telemetry.json
{
  "version": 1,
  "spans": [],
  "logs": [
    {
      "timestamp": 1795186800000,
      "service": "checkout-api",
      "level": "info",
      "message": "Заказ обработан",
      "traceId": null,
      "attributes": { "order_id": "A-204" }
    }
  ],
  "metrics": []
}