CloudCastle Grafana Loki API

QueryClient
in package
uses NormalizesQueryTime

FinalYes

Лог- и метрик-запросы Query API Loki.

Мгновенные запросы, запросы диапазона и живое чтение (tail). Время принимается в любом удобном виде: объект даты, Unix-секунды, строка наносекунд или относительная строка PHP («-1 hour»).

Table of Contents

Methods

__construct()  : mixed
query()  : QueryResult
Мгновенный запрос `/query`.
queryRange()  : QueryResult
Запрос диапазона `/query_range`.
tail()  : LiveTail
Живое чтение новых записей поверх `/query_range`.

Methods

query()

Мгновенный запрос `/query`.

public query(string $logql[, DateTimeInterface|int|float|string|null $time = null ][, int $limit = 100 ][, Direction $direction = Direction::Backward ]) : QueryResult

Лог-запрос возвращает потоки, метрик-запрос — вектор значений.

Parameters
$logql : string

выражение LogQL

$time : DateTimeInterface|int|float|string|null = null

момент вычисления (по умолчанию «сейчас» на сервере)

$limit : int = 100

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

$direction : Direction = Direction::Backward

направление выдачи

Tags
throws
QueryException

при ошибке сервера или разбора

Return values
QueryResult

queryRange()

Запрос диапазона `/query_range`.

public queryRange(string $logql, DateTimeInterface|int|float|string $start, DateTimeInterface|int|float|string $end[, int $limit = 100 ][, Direction $direction = Direction::Backward ][, string|null $step = null ]) : QueryResult

Лог-запрос возвращает потоки, метрик-запрос — матрицу рядов.

Parameters
$logql : string

выражение LogQL

$start : DateTimeInterface|int|float|string

начало диапазона

$end : DateTimeInterface|int|float|string

конец диапазона

$limit : int = 100

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

$direction : Direction = Direction::Backward

направление выдачи

$step : string|null = null

шаг метрик-запроса (например, «30s»)

Tags
throws
QueryException

при ошибке сервера или разбора

Return values
QueryResult

tail()

Живое чтение новых записей поверх `/query_range`.

public tail(string $logql[, DateTimeInterface|int|float|string $since = '-1 minute' ][, int $intervalMs = 1000 ][, SleeperInterface|null $sleeper = null ][, int $maxWindowSeconds = 3600 ]) : LiveTail

Работает поллингом через обычный HTTP — не требует WebSocket и проходит через любые прокси. Окно каждого опроса ограничено $maxWindowSeconds, чтобы не превысить max_query_length Loki при большом since или долгой тишине потока.

Parameters
$logql : string

выражение LogQL

$since : DateTimeInterface|int|float|string = '-1 minute'

с какого момента читать

$intervalMs : int = 1000

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

$sleeper : SleeperInterface|null = null

реализация паузы (для тестов)

$maxWindowSeconds : int = 3600

ширина окна опроса, с (> 0; по умолчанию 1 ч)

Tags
throws
QueryException

когда $since невозможно разобрать

ConfigException

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

Return values
LiveTail
On this page

Search results