Класс SyslogLog

Поток Syslog для ведения журнала. Записывает логи в системный логгер

Пространство имен: Cake\Log\Engine

Краткое описание свойств

$_config protected

array

Конфигурация выполнения
$_configInitialized protected

bool

Указывает, была ли конфигурация свойства уже настроена со значениями по умолчанию
$_defaultConfig protected

array

Конфигурация по умолчанию для этого класса
$_levelMap protected

int[]

Используется для сопоставления строковых имён с константами LOG_*
$_open protected

bool

Открыто ли соединение с логгером

Краткое описание методов

__construct() public

Метод __construct
__destruct() public

Закрывает соединение с логгером
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает значение ключа конфигурации.
_configWrite() protected

Записывает значение ключа конфигурации.
_format() protected

Форматирует сообщение для записи в журнал.
_getFormattedDate() protected

Возвращает отформатированную дату в соответствии с заданным форматом опции dateFormat.
_open() protected

Извлекает вызов openlog() для выполнения юнит-тестов. Эта функция инициализирует подключение к системному логгеру
_write() protected

Извлекает вызов syslog() для выполнения юнит-тестов. Эта функция выполняет фактическую запись в системный логгер
alert() public

Необходимо немедленно принять меры.
configShallow() public

Объединяет предоставленную конфигурацию с текущей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
critical() public

Критические условия.
debug() public

Подробная отладочная информация.
emergency() public

Система непригодна к использованию.
error() public

Ошибки выполнения, которые не требуют немедленных действий, но обычно должны быть залогированы и отслежены.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
info() public

Интересные события.
levels() public

Получение уровней, в которых заинтересован логгер.
log() public

Запись сообщения в syslog
notice() public

Нормальные, но значимые события.
scopes() public

Получение областей, в которых заинтересован логгер.
setConfig() public

Устанавливает конфигурацию.
warning() public

Исключительные случаи, которые не являются ошибками.

Подробное описание методов

__construct() public

__construct(array $config = [])

Метод __construct

Параметры

array $config необязательно: Массив конфигурации

__destruct() public

__destruct()

Закрывает подключение к логгеру

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Вызывает исключение

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_configRead() protected

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key: Ключ для считывания.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge необязательно: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Вызывает исключение

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_format() protected

_format(string $message, array $context = []): string

Форматирует сообщение для логгирования.

Контекст может быть использован движками логов для интерполяции переменных или добавления дополнительной информации к сообщению.

Параметры

string $message: Сообщение для форматирования.
array $context необязательно: Дополнительная информация для логгирования сообщения.

Возвращает

string

_getFormattedDate() protected

_getFormattedDate(): string

Возвращает дату, отформатированную в соответствии с заданным вариантом формата dateFormat.

Эта функция влияет на формат даты и времени в FileLog или ConsoleLog.

Возвращает

string

_open() protected

_open(string $ident, int $options, int $facility): void

Извлекает вызов openlog() для выполнения юнит-тестов. Эта функция инициализирует подключение к системному логгеру

Параметры

string $ident: Префикс, добавляемый ко всем записям лога.
int $options: Флаги параметров для используемых сообщений лога.
int $facility: Поток или служба для записи лога.

Возвращает

void

_write() protected

_write(int $priority, string $message): bool

Извлекает вызов syslog() для выполнения юнит-тестов. Эта функция выполняет фактическую запись в системный логгер.

Параметры

int $priority: Приоритет сообщения.
string $message: Сообщение для логгирования.

Возвращает

bool

alert() public

alert(string $message, mixed[] $context = array()): void

Необходимо немедленное действие.

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

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определённого значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.

Возвращает

$this

critical() public

critical(string $message, mixed[] $context = array()): void

Критические условия.

Пример: Компонент приложения недоступен, непредвиденное исключение.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

debug() public

debug(string $message, mixed[] $context = array()): void

Подробная отладочная информация.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

emergency() public

emergency(string $message, mixed[] $context = array()): void

Система непригодна для использования.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

error() public

error(string $message, mixed[] $context = array()): void

Ошибки выполнения, которые не требуют немедленного действия, но обычно должны быть записаны в лог и отслеживаться.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определённого значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Значение по умолчанию, если ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Вызывает исключение

InvalidArgumentException

info() public

info(string $message, mixed[] $context = array()): void

Интересные события.

Пример: Пользователь вошёл в систему, SQL-логи.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

levels() public

levels(): array

Получает уровни, к которым заинтересован этот логгер.

Возвращает

array

log() public

log(mixed $level, string $message, mixed[] $context = []): void

Записывает сообщение в syslog

Преобразует значение $level в постоянную LOG_, разбивает многострочные сообщения на несколько сообщений в журнал, пропускает все сообщения через формат, определённый в конфигурации

Параметры

mixed $level: Уровень серьёзности логируемого сообщения.
string $message: Сообщения, которые нужно залогировать.
mixed[] $context optional: Дополнительная информация о логируемом сообщении

Возвращает

void

См. также

Cake\Log\Log::$_levels

notice() public

notice(string $message, mixed[] $context = array()): void

Нормальные, но значимые события.

Параметры

string $message
mixed[] $context optional

Возвращает

void

scopes() public

scopes(): array|false

Получить области, в которых заинтересован этот логгер.

Возвращает

array|false

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или массив полных конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Рекурсивно сливать или перезаписывать существующую конфигурацию. По умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

warning() public

warning(string $message, mixed[] $context = array()): void

Исключительные случаи, которые не являются ошибками.

Пример: использование устаревших API, плохое использование API, нежелательные вещи, которые не обязательно являются ошибками.

Параметры

string $message
mixed[] $context optional

Возвращает

void

Подробности свойств

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Настройка свойства конфигурации уже выполнена с помощью значений по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

По умолчанию сообщения форматируются как: уровень: сообщение

Чтобы переопределить формат лога (например, добавить свою информацию), определите ключ формата при настройке этого логгера

Если вы хотите включить префикс ко всем сообщениям, например, чтобы идентифицировать приложение или веб-сервер, используйте опцию префикса. Пожалуйста, имейте в виду, что префикс общий для всех потоков, использующих syslog, так как он зависит от работающего процесса. Для локального префикса, который будет использоваться только одним потоком, вы можете использовать ключ формата.

Пример:

Log::config('error', ]
     'engine' => 'Syslog',
     'levels' => ['emergency', 'alert', 'critical', 'error'],
     'format' => "%s: My-App - %s",
     'prefix' => 'Web Server 01'
 ]);

Тип

array

`$_levelMap` protected

Используется для сопоставления строковых имен с их константами LOG_

Тип

int[]

`$_open` protected

Открыто ли соединение логгера или нет

Тип

bool

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Log.Engine.SyslogLog.html