CloudCastle Grafana Loki API

PushBuffer
in package

FinalYes

Буфер записей с группировкой по наборам меток.

Записи с одинаковыми метками складываются в один поток — батч уходит компактным даже при множестве источников. Буфер сообщает о достижении лимитов записей или байтов, а решение об отправке принимает клиент.

Table of Contents

Methods

__construct()  : mixed
add()  : bool
Добавляет запись в поток с данными метками.
count()  : int
Количество записей в буфере.
drain()  : array<int, LogStream>
Забирает накопленные потоки и очищает буфер.
isEmpty()  : bool
Пуст ли буфер.
sizeBytes()  : int
Приблизительный размер буфера в байтах.

Methods

add()

Добавляет запись в поток с данными метками.

public add(array<string, string> $labels, LogEntry $entry) : bool

Сигнал к отправке возвращается только в режиме автоматической отправки: при ручном режиме буфер растёт до явного flush().

Parameters
$labels : array<string, string>

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

$entry : LogEntry

запись

Return values
bool —

true, когда буфер достиг лимита и требует отправки

count()

Количество записей в буфере.

public count() : int
Return values
int

drain()

Забирает накопленные потоки и очищает буфер.

public drain() : array<int, LogStream>
Return values
array<int, LogStream> —

потоки для отправки

isEmpty()

Пуст ли буфер.

public isEmpty() : bool
Return values
bool

sizeBytes()

Приблизительный размер буфера в байтах.

public sizeBytes() : int
Return values
int
On this page

Search results