LokiClient
in package
Клиент Grafana Loki: запись и чтение журналов.
Запись — с батчингом, сжатием, повторами, предохранителем и резервным приёмником; чтение — полный Query API с LogQL. Все зависимости заменяемы, значения по умолчанию безопасны и работают из коробки:
$client = new LokiClient(new LokiConfig('http://loki:3100'));
$client->push('приложение запущено', ['app' => 'api']);
$client->flush();
Table of Contents
Methods
- __construct() : mixed
- flush() : void
- Отправляет накопленный буфер на сервер.
- fromArray() : self
- Собирает клиент из ассоциативного массива конфигурации Loki.
- logger() : LokiLogger
- PSR-3 логгер поверх этого клиента.
- metadata() : MetadataClient
- Метаданные индекса: метки, серии, статистика, паттерны.
- pendingCount() : int
- Количество записей, ожидающих отправки в буфере.
- push() : void
- Добавляет запись журнала в буфер отправки.
- pushStream() : void
- Добавляет готовый поток с собственными метками времени записей.
- queries() : QueryClient
- Лог- и метрик-запросы: query, query_range, живой tail.
- runWithFlush() : T
- Выполняет колбэк и гарантированно сбрасывает буфер в finally.
- stats() : array<string, int>
- Снимок внутренних счётчиков клиента.
Methods
__construct()
public
__construct(LokiConfig $config[, TransportInterface|null $transport = null ][, FallbackInterface|null $fallback = null ][, ClockInterface|null $clock = null ][, SanitizerInterface|null $sanitizer = null ]) : mixed
Parameters
- $config : LokiConfig
-
конфигурация клиента
- $transport : TransportInterface|null = null
-
транспорт (по умолчанию автовыбор cURL/потоки)
- $fallback : FallbackInterface|null = null
-
резерв недоставленных записей (по умолчанию error_log)
- $clock : ClockInterface|null = null
-
источник времени (по умолчанию системные часы)
- $sanitizer : SanitizerInterface|null = null
-
маскирование данных (по умолчанию учётные и платёжные)
flush()
Отправляет накопленный буфер на сервер.
public
flush() : void
Tags
fromArray()
Собирает клиент из ассоциативного массива конфигурации Loki.
public
static fromArray(GzipOptions|null} $options) : self
Обёртка над LokiConfig::fromArray() с теми же ключами (base_url,
labels, tenant_id и пр.). Транспорт и прочие зависимости — по умолчанию.
Parameters
- $options : GzipOptions|null}
-
сырые опции секции loki
Tags
Return values
self —клиент с конфигурацией из массива
logger()
PSR-3 логгер поверх этого клиента.
public
logger([array<string, string> $labels = [] ]) : LokiLogger
Parameters
- $labels : array<string, string> = []
-
дополнительные метки потока логгера
Return values
LokiLoggermetadata()
Метаданные индекса: метки, серии, статистика, паттерны.
public
metadata() : MetadataClient
Return values
MetadataClientpendingCount()
Количество записей, ожидающих отправки в буфере.
public
pendingCount() : int
Return values
intpush()
Добавляет запись журнала в буфер отправки.
public
push(string $line[, array<string|int, scalar|Stringable|null> $labels = [] ][, array<string|int, scalar|Stringable|null> $metadata = [] ][, DateTimeInterface|null $time = null ]) : void
Строка маскируется санитайзером и получает строго возрастающую наносекундную метку времени. При достижении лимитов батча буфер уходит на сервер автоматически (режим FlushMode::Auto).
Parameters
- $line : string
-
текст записи
- $labels : array<string|int, scalar|Stringable|null> = []
-
метки потока записи
- $metadata : array<string|int, scalar|Stringable|null> = []
-
структурированные метаданные (Loki 3.x)
- $time : DateTimeInterface|null = null
-
момент события (по умолчанию «сейчас»)
Tags
pushStream()
Добавляет готовый поток с собственными метками времени записей.
public
pushStream(LogStream $stream) : void
Parameters
- $stream : LogStream
-
поток с записями
Tags
queries()
Лог- и метрик-запросы: query, query_range, живой tail.
public
queries() : QueryClient
Return values
QueryClientrunWithFlush()
Выполняет колбэк и гарантированно сбрасывает буфер в finally.
public
runWithFlush(callable(): T $callback) : T
Удобно для CLI-скриптов: логи уходят в Loki даже при исключении.
Parameters
- $callback : callable(): T
-
тело CLI-команды
Tags
Return values
T —результат колбэка
stats()
Снимок внутренних счётчиков клиента.
public
stats() : array<string, int>
Return values
array<string, int> —карта «метрика → значение»