LokiConfig
in package
Конфигурация клиента Loki.
Неизменяемый объект с безопасными значениями по умолчанию: полная проверка TLS, gzip-сжатие, батчинг, повторы с выдержкой и fail-safe обработка ошибок. Адрес сервера проверяется при создании — некорректный или небезопасный URL отклоняется сразу, а не при первом запросе.
Как корневой объект настройки он намеренно агрегирует все опции клиента именованными параметрами с дефолтами (fluent-конфигурация), поэтому счётчики параметров и связности здесь выше типового метода.
Tags
Table of Contents
Properties
- $auth : AuthInterface
- Способ аутентификации.
- $baseUrl : non-empty-string
- Нормализованный базовый адрес сервера без завершающего слеша.
- $batch : BatchOptions
- Параметры батчинга.
- $compression : Compression
- $errorMode : ErrorMode
- $gzip : GzipOptions
- Параметры gzip-сжатия.
- $hostPolicy : HostPolicy
- $http : HttpOptions
- Параметры HTTP-соединения.
- $labels : array<string, string>
- Глобальные метки, добавляемые ко всем потокам клиента.
- $retry : RetryOptions
- Политика повторов.
- $tenantId : string|null
Methods
- __construct() : mixed
- __debugInfo() : array<string, mixed>
- Представление для дампов: конфигурация без секретов.
- apiUrl() : non-empty-string
- Полный адрес эндпоинта Query API.
- fromArray() : self
- Собирает конфигурацию из ассоциативного массива (секция loki конфига приложения).
- pushUrl() : non-empty-string
- Полный адрес push-эндпоинта.
- requestHeaders() : array<string, string>
- Общие заголовки каждого запроса: аутентификация, арендатор, пользовательские заголовки и User-Agent.
Properties
$auth read-only
Способ аутентификации.
public
AuthInterface
$auth
$baseUrl read-only
Нормализованный базовый адрес сервера без завершающего слеша.
public
non-empty-string
$baseUrl
$batch read-only
Параметры батчинга.
public
BatchOptions
$batch
$compression read-only
public
Compression
$compression
= Compression::Gzip
$errorMode read-only
public
ErrorMode
$errorMode
= ErrorMode::Fallback
$gzip read-only
Параметры gzip-сжатия.
public
GzipOptions
$gzip
$hostPolicy read-only
public
HostPolicy
$hostPolicy
= HostPolicy::AllowAll
$http read-only
Параметры HTTP-соединения.
public
HttpOptions
$http
$labels read-only
Глобальные метки, добавляемые ко всем потокам клиента.
public
array<string, string>
$labels
$retry read-only
Политика повторов.
public
RetryOptions
$retry
$tenantId read-only
public
string|null
$tenantId
= null
Methods
__construct()
public
__construct(string $baseUrl[, AuthInterface|null $auth = null ][, string|null $tenantId = null ][, HttpOptions|null $http = null ][, BatchOptions|null $batch = null ][, RetryOptions|null $retry = null ][, Compression $compression = Compression::Gzip ][, array<string|int, scalar|Stringable|null> $labels = [] ][, ErrorMode $errorMode = ErrorMode::Fallback ][, HostPolicy $hostPolicy = HostPolicy::AllowAll ][, GzipOptions|null $gzip = null ]) : mixed
Parameters
- $baseUrl : string
-
базовый адрес Loki (например, http://loki:3100)
- $auth : AuthInterface|null = null
-
аутентификация (по умолчанию без неё)
- $tenantId : string|null = null
-
арендатор мультитенантного Loki (X-Scope-OrgID)
- $http : HttpOptions|null = null
-
параметры HTTP (по умолчанию безопасные)
- $batch : BatchOptions|null = null
-
параметры батчинга
- $retry : RetryOptions|null = null
-
политика повторов
- $compression : Compression = Compression::Gzip
-
сжатие push-запросов
- $labels : array<string|int, scalar|Stringable|null> = []
-
глобальные метки всех потоков
- $errorMode : ErrorMode = ErrorMode::Fallback
-
поведение при невосстановимой ошибке доставки
- $hostPolicy : HostPolicy = HostPolicy::AllowAll
-
политика хостов адреса Loki (анти-SSRF)
- $gzip : GzipOptions|null = null
-
параметры gzip-сжатия (уровень, порог)
Tags
__debugInfo()
Представление для дампов: конфигурация без секретов.
public
__debugInfo() : array<string, mixed>
Кэш собранных заголовков и учётные данные не раскрываются, арендатор
маскируется — print_r/var_dump/var_export не выдают токен.
Return values
array<string, mixed>apiUrl()
Полный адрес эндпоинта Query API.
public
apiUrl(string $path) : non-empty-string
Parameters
- $path : string
-
путь внутри /loki/api/v1 (например, «query_range»)
Return values
non-empty-stringfromArray()
Собирает конфигурацию из ассоциативного массива (секция loki конфига приложения).
public
static fromArray(GzipOptions|null} $options) : self
Обязателен непустой base_url. Остальные ключи опциональны и мапятся
на именованные параметры конструктора без смены семантики по умолчанию.
Parameters
- $options : GzipOptions|null}
-
сырые опции
Tags
Return values
self —экземпляр конфигурации
pushUrl()
Полный адрес push-эндпоинта.
public
pushUrl() : non-empty-string
Return values
non-empty-stringrequestHeaders()
Общие заголовки каждого запроса: аутентификация, арендатор, пользовательские заголовки и User-Agent.
public
requestHeaders() : array<string, string>
Return values
array<string, string> —карта заголовков