Spec-Zone.ru › CakePHP 2.8

Класс SyslogLog

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

BaseLog реализует CakeLogInterface
Extended by SyslogLog
Пакет: Cake\Log\Engine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Log/Engine/SyslogLog.php

Резюме свойств

  • $_defaults protected
    array

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

  • $_open protected
    boolean
    Соединение логгера открыто или нет
  • $_priorityMap protected
    array
    Используется для сопоставления строковых имен с их константами LOG_*

Унаследованные свойства

  • _config

Резюме методов

  • __construct() public

    Убедитесь, что конфигурация содержит параметр format, по умолчанию он использует номер ошибки и тип в качестве префикса к сообщению

  • __destruct() public
    Закрывает соединение с логгером
  • _open() protected

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

  • _write() protected

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

  • write() public
    Записывает сообщение в syslog

Детали методов

__construct()source public

__construct( array $config array() )

Убедитесь, что конфигурация содержит параметр format, по умолчанию он использует номер ошибки и тип в качестве префикса к сообщению

Параметры

массив $config необязательно массив()
Список опций.

Переопределяет

BaseLog::__construct()

__destruct()source public

__destruct( )

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

_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
Сообщение для ведения журнала.

Возвращаемое значение

boolean

write()source public

write( string $type , string $message )

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

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

Параметры

строка $type
Тип журнала.
строка $message
Сообщение, которое вы хотите записать в журнал.

Возвращаемое значение

boolean
Успешность записи.

Наследованные методы из BaseLog

config()source public

config( array $config array() )

Устанавливает конфигурацию экземпляра. Если $config равно null, возвращает массив конфигурации

Конфигурация

  • types строка или массив, уровни, которые интересуют движок
  • scopes строка или массив, области, которые интересуют движок

Параметры

массив $config необязательно массив()
конфигурация движка

Возвращаемое значение

массив

Детали свойств

$_defaultssource

protected массив

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

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

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

Пример:

CakeLog::config('error', array(
    'engine' => 'Syslog',
    'types' => array('emergency', 'alert', 'critical', 'error'),
    'format' => "%s: My-App - %s",
    'prefix' => 'Web Server 01'
));
array(
    'format' => '%s: %s',
    'flag' => LOG_ODELAY,
    'prefix' => '',
    'facility' => LOG_USER
)

$_opensource

protected boolean

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

false

$_priorityMapsource

protected массив

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

array(
    '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/2.8/class-SyslogLog.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API