MetadataClient
in package
uses
NormalizesQueryTime
Метаданные индекса Loki: метки, серии, статистика, паттерны.
Покрывает служебные эндпоинты Query API, включая появившиеся
в Loki 3.x /patterns, /detected_labels и /detected_fields.
Table of Contents
Methods
- __construct() : mixed
- detectedFields() : array<string|int, mixed>
- Обнаруженные поля записей `/detected_fields` (Loki 3.x).
- detectedLabels() : array<string|int, mixed>
- Обнаруженные метки `/detected_labels` (Loki 3.x).
- indexStats() : array<string|int, mixed>
- Статистика индекса `/index/stats`: потоки, чанки, записи, байты.
- labels() : array<int, string>
- Список имён меток `/labels`.
- labelValues() : array<int, string>
- Значения метки `/label/{name}/values`.
- patterns() : array<string|int, mixed>
- Обнаруженные паттерны записей `/patterns` (Loki 3.x).
- series() : array<int, array<string, string>>
- Серии (наборы меток) `/series` по списку селекторов.
- volume() : array<string|int, mixed>
- Объёмы логов по меткам `/index/volume`.
Methods
__construct()
public
__construct(QueryExecutor $executor, ResponseParser $parser, NanoTime $time) : mixed
Parameters
- $executor : QueryExecutor
-
исполнитель GET-запросов
- $parser : ResponseParser
-
разбор ответов
- $time : NanoTime
-
нормализация времени
detectedFields()
Обнаруженные поля записей `/detected_fields` (Loki 3.x).
public
detectedFields(string $query[, DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ]) : array<string|int, mixed>
Parameters
- $query : string
-
селектор потоков
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
Tags
Return values
array<string|int, mixed> —поля с типами и кардинальностью
detectedLabels()
Обнаруженные метки `/detected_labels` (Loki 3.x).
public
detectedLabels([string|null $query = null ][, DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ]) : array<string|int, mixed>
Parameters
- $query : string|null = null
-
селектор потоков
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
Tags
Return values
array<string|int, mixed> —метки с кардинальностью
indexStats()
Статистика индекса `/index/stats`: потоки, чанки, записи, байты.
public
indexStats(string $query[, DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ]) : array<string|int, mixed>
Parameters
- $query : string
-
селектор потоков
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
Tags
Return values
array<string|int, mixed> —статистика индекса
labels()
Список имён меток `/labels`.
public
labels([DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ]) : array<int, string>
Parameters
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
Tags
Return values
array<int, string> —имена меток
labelValues()
Значения метки `/label/{name}/values`.
public
labelValues(string $label[, DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ][, string|null $query = null ]) : array<int, string>
Parameters
- $label : string
-
имя метки
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
- $query : string|null = null
-
селектор потоков для фильтрации
Tags
Return values
array<int, string> —значения метки
patterns()
Обнаруженные паттерны записей `/patterns` (Loki 3.x).
public
patterns(string $query, DateTimeInterface|int|float|string $start, DateTimeInterface|int|float|string $end) : array<string|int, mixed>
Parameters
- $query : string
-
селектор потоков
- $start : DateTimeInterface|int|float|string
-
начало интервала
- $end : DateTimeInterface|int|float|string
-
конец интервала
Tags
Return values
array<string|int, mixed> —паттерны с частотами
series()
Серии (наборы меток) `/series` по списку селекторов.
public
series(array<int, string> $matchers[, DateTimeInterface|int|float|string|null $start = null ][, DateTimeInterface|int|float|string|null $end = null ]) : array<int, array<string, string>>
Parameters
- $matchers : array<int, string>
-
селекторы потоков
- $start : DateTimeInterface|int|float|string|null = null
-
начало интервала
- $end : DateTimeInterface|int|float|string|null = null
-
конец интервала
Tags
Return values
array<int, array<string, string>> —наборы меток серий
volume()
Объёмы логов по меткам `/index/volume`.
public
volume(string $query, DateTimeInterface|int|float|string $start, DateTimeInterface|int|float|string $end) : array<string|int, mixed>
Parameters
- $query : string
-
селектор потоков
- $start : DateTimeInterface|int|float|string
-
начало интервала
- $end : DateTimeInterface|int|float|string
-
конец интервала
Tags
Return values
array<string|int, mixed> —объёмы по меткам