CloudCastle Grafana Loki API

LiveTail
in package

FinalYes

Живое чтение потока записей (аналог `logcli tail`).

Опрашивает /query_range с нарастающей нижней границей: каждая итерация забирает только записи новее последней увиденной. Не требует WebSocket-соединения, работает через любой HTTP-прокси и балансировщик.

Table of Contents

Constants

DEFAULT_MAX_WINDOW_NS  : mixed = 3600000000000
Окно опроса по умолчанию — 1 час в наносекундах.

Methods

__construct()  : mixed
lastSeenNs()  : int
Наносекундная метка последней увиденной записи.
poll()  : array<int, LogStream>
Один опрос: записи новее последней увиденной.
stream()  : Generator<int, array<int, LogStream>>
Генератор непрерывного чтения: отдаёт непустые результаты опросов.

Constants

DEFAULT_MAX_WINDOW_NS

Окно опроса по умолчанию — 1 час в наносекундах.

public mixed DEFAULT_MAX_WINDOW_NS = 3600000000000

Loki отвергает /query_range шире max_query_length (по умолчанию 721 час) кодом 400. Значение с большим запасом ниже этого предела.

Methods

__construct()

public __construct(QueryClient $client, string $logql, int $lastSeenNs, int $intervalMs, SleeperInterface $sleeper, NanoTime $time[, int $maxWindowNs = self::DEFAULT_MAX_WINDOW_NS ]) : mixed
Parameters
$client : QueryClient

клиент запросов

$logql : string

выражение LogQL

$lastSeenNs : int

начальная граница в наносекундах

$intervalMs : int

пауза между опросами, мс (строго > 0)

$sleeper : SleeperInterface

реализация паузы

$time : NanoTime

источник верхней границы окна («сейчас»)

$maxWindowNs : int = self::DEFAULT_MAX_WINDOW_NS

предельная ширина окна опроса в наносекундах (строго > 0)

Tags
throws
ConfigException

при неположительном интервале или окне

lastSeenNs()

Наносекундная метка последней увиденной записи.

public lastSeenNs() : int
Return values
int

poll()

Один опрос: записи новее последней увиденной.

public poll([int $limit = 1000 ]) : array<int, LogStream>

Нижняя граница окна прижимается к верх − maxWindowNs: без этого при большом since или долгой тишине (lastSeenNs не растёт) окно [lastSeenNs+1 … сейчас] со временем превысило бы max_query_length Loki и сервер ответил бы 400.

Parameters
$limit : int = 1000

максимум записей за опрос

Return values
array<int, LogStream> —

новые потоки (пустой список — новых записей нет)

stream()

Генератор непрерывного чтения: отдаёт непустые результаты опросов.

public stream([int $maxPolls = PHP_INT_MAX ]) : Generator<int, array<int, LogStream>>
Parameters
$maxPolls : int = PHP_INT_MAX

максимум опросов (защита от бесконечного цикла)

Return values
Generator<int, array<int, LogStream>> —

порции новых потоков

On this page

Search results