Класс 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 - Сообщение для записи.
Возвращает
booleanlog()source public
log( string $level , string $message , array $context [] )
Записывает сообщение в syslog
Преобразует $level в значение LOG_, разбивает многострочные сообщения на несколько сообщений, пропускает все сообщения через формат, определённый в конфигурации
Параметры
- строка
$level - Уровень важности записываемого лога.
- строка
$message - Сообщение, которое требуется записать.
- массив
$contextдополнительно [] - Дополнительная информация о записываемом сообщении
Возвращает
booleanРезультат записи.
Методы, унаследованные от 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 - Значение для записи.
- boolean|строка
$mergeдополнительно false True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию 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 - Значение для установки.
- boolean
$mergeдополнительно true - Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию 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 массив
Конфигурация по умолчанию для данного класса
По умолчанию сообщения форматируются как: уровень: сообщение
Чтобы переопределить формат лога (например, добавить свою информацию) укажите ключ формата при конфигурации этого логгера
Если вы хотите включить префикс ко всем сообщениям, например, для идентификации приложения или веб-сервера, используйте параметр префикса. Помните, что префикс общий для всех потоков, использующих 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 массив
Используется для сопоставления строковых имен с их константами 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–2016 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.
http://api.cakephp.org/3.2/class-Cake.Log.Engine.SyslogLog.html