CloudCastle Grafana Loki API

QueryResult
in package

FinalYes

Результат запроса чтения Loki.

Хранит типизированные данные всех трёх видов результата и статистику выполнения. Акцессоры строгие: обращение к потокам у метрик-результата бросает исключение, а не возвращает пустоту — перепутанный тип запроса обнаруживается сразу.

Table of Contents

Properties

$stats  : array<string|int, mixed>
$type  : ResultType

Methods

__construct()  : mixed
count()  : int
Суммарное количество элементов результата.
entries()  : array<int, LogEntry>
Все записи всех потоков одним плоским списком.
matrix()  : array<int, SeriesSample>
Матрица временных рядов метрик-запроса.
scalar()  : Sample
Скалярное значение метрик-запроса.
streams()  : array<int, LogStream>
Потоки записей лог-запроса.
vector()  : array<int, Sample>
Вектор мгновенных значений метрик-запроса.

Properties

$stats read-only

public array<string|int, mixed> $stats = []

Methods

__construct()

public __construct(ResultType $type[, array<int, LogStream> $streams = [] ][, array<int, Sample> $vector = [] ][, array<int, SeriesSample> $matrix = [] ][, array<string|int, mixed> $stats = [] ][, Sample|null $scalar = null ]) : mixed
Parameters
$type : ResultType

тип результата

$streams : array<int, LogStream> = []

потоки (для Streams)

$vector : array<int, Sample> = []

вектор значений (для Vector)

$matrix : array<int, SeriesSample> = []

матрица рядов (для Matrix)

$stats : array<string|int, mixed> = []

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

$scalar : Sample|null = null

скалярное значение (для Scalar)

count()

Суммарное количество элементов результата.

public count() : int
Return values
int

entries()

Все записи всех потоков одним плоским списком.

public entries() : array<int, LogEntry>
Tags
throws
QueryException

когда тип результата не Streams

Return values
array<int, LogEntry> —

записи

matrix()

Матрица временных рядов метрик-запроса.

public matrix() : array<int, SeriesSample>
Tags
throws
QueryException

когда тип результата не Matrix

Return values
array<int, SeriesSample> —

ряды

scalar()

Скалярное значение метрик-запроса.

public scalar() : Sample
Tags
throws
QueryException

когда тип результата не Scalar

Return values
Sample

streams()

Потоки записей лог-запроса.

public streams() : array<int, LogStream>
Tags
throws
QueryException

когда тип результата не Streams

Return values
array<int, LogStream> —

потоки

vector()

Вектор мгновенных значений метрик-запроса.

public vector() : array<int, Sample>
Tags
throws
QueryException

когда тип результата не Vector

Return values
array<int, Sample> —

значения

On this page

Search results