Класс SyslogLog
Поток Syslog для ведения журнала. Записывает логи в системный логгер
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait -
Cake\Log\Engine\SyslogLog
Краткое описание свойств
-
$_defaultConfigprotectedЗначения конфигурации по умолчанию для данного классаarray -
$_levelMapprotectedИспользуется для сопоставления строковых имён с константами LOG_*array -
$_openprotectedОткрыто ли соединение с логгеромboolean
Унаследованные свойства
Краткое описание методов
- __destruct() publicЗакрывает соединение с логгером
- _open() protected
Извлекает вызов openlog() для проведения юнит-тестирования. Эта функция инициализирует подключение к системному логгеру
- _write() protected
Извлекает вызов syslog() для проведения юнит-тестирования. Эта функция выполняет фактическую запись в системный логгер
- log() publicЗаписывает сообщение в syslog
Подробное описание методов
_open()source protected
_open( string $ident , integer $options , integer $facility )
Извлекает вызов openlog() для проведения юнит-тестирования. Эта функция инициализирует подключение к системному логгеру
Параметры
- строка
$ident - префикс, добавляемый ко всем записываемым сообщениям
- целое число
$options - флаги опций, используемые для записываемых сообщений
- целое число
$facility - поток или объект для записи лога
_write()source protected
_write( integer $priority , string $message )
Извлекает вызов syslog() для проведения юнит-тестирования. Эта функция выполняет фактическую запись в системный логгер
Параметры
- целое число
$priority - Приоритет сообщения.
- строка
$message - Сообщение для записи.
Возвращает
логическое значениеlog()source public
log( string $level , string $message , array $context [] )
Записывает сообщение в syslog
Преобразует $level в константу LOG_, разбивает многострочные сообщения на несколько сообщений, пропускает все сообщения через формат, определенный в конфигурации
Параметры
- строка
$level - Уровень серьезности логирования.
- строка
$message - Сообщение, которое вы хотите записать в журнал.
- массив
$contextнеобязательно [] - Дополнительная информация о записанном сообщении
Возвращает
логическое значениеуспех записи.
Методы, унаследованные от Cake\Log\Engine\BaseLog
__construct()source public
__construct( array $config [] )
Метод __construct
Параметры
- массив
$configнеобязательно [] - Массив конфигурации
_format()source protected
_format( mixed $data , array $context [] )
Преобразует предоставленные данные в строку для последующей записи в журнал. Контекст может быть использован движками журналов для интерполяции переменных или добавления дополнительной информации в записываемое сообщение.
Параметры
- смешанный тип
$data - Данные, которые нужно преобразовать в строку и записать в журнал.
- массив
$contextнеобязательно [] - Дополнительная информация о записи в журнал.
Возвращает
строкаМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionесли происходит попытка перезаписи существующей конфигурации
_configRead()source protected
_configRead( string|null $key )
Чтение переменной конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанный тип_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный тип
$value - Значение для записи.
- булево|строка
$mergeнеобязательно false Истинно для рекурсивного слияния, 'поверхностное' для простого слияния, ложно для перезаписи, по умолчанию ложно.
Исключения
Cake\Core\Exception\Exceptionесли происходит попытка перезаписи существующей конфигурации
config()source public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Использование
Чтение всей конфигурации:
$this->config();
Чтение определённого значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определённого значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или весь массив конфигураций.
- смешанный тип|null
$valueнеобязательно null - Значение для установки.
- булево
$mergeнеобязательно true - Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
смешанный типЗначение конфигурации для чтения, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установки недопустимого ключа.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которое выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определённого значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный тип|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Объект самого себя.
Подробное описание свойств
$_defaultConfigsource
protected array
Конфигурация по умолчанию для этого класса
По умолчанию сообщения форматируются как: уровень: сообщение
Чтобы переопределить формат логов (например, добавить свою информацию), определите ключ формата при конфигурировании этого логгера
Если вы хотите добавить префикс ко всем сообщениям, например, для идентификации приложения или веб-сервера, используйте параметр префикса. Имейте в виду, что префикс общий для всех потоков, использующих syslog, так как он зависит от работающего процесса. Для локального префикса, который будет использоваться только одним потоком, можно использовать ключ формата.
Пример:
Log::config('error', ]
'engine' => 'Syslog',
'levels' => ['emergency', 'alert', 'critical', 'error'],
'format' => "%s: My-App - %s",
'prefix' => 'Web Server 01'
]); [
'levels' => [],
'scopes' => [],
'format' => '%s: %s',
'flag' => LOG_ODELAY,
'prefix' => '',
'facility' => LOG_USER
] $_levelMapsource
protected array
Используется для сопоставления строковых имён с константами LOG_*
[
'emergency' => LOG_EMERG,
'alert' => LOG_ALERT,
'critical' => LOG_CRIT,
'error' => LOG_ERR,
'warning' => LOG_WARNING,
'notice' => LOG_NOTICE,
'info' => LOG_INFO,
'debug' => LOG_DEBUG
]
© 2005–2017 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/3.3/class-Cake.Log.Engine.SyslogLog.html