Spec-Zone.ru › CakePHP 2.10

Класс SyslogLog

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

BaseLog реализует CakeLogInterface
Extended by SyslogLog
Пакет: Cake\Журнал\Двигатель
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: 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 необязательно array()
Список опций.

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

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 необязательно array()
конфигурация движка

Возвращает

массив

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

$_defaultssource

protected массив

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

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

Если вы хотите добавить префикс ко всем сообщениям, например, для идентификации приложения или веб-сервера, используйте опцию префикса. Помните, что префикс общий для всех потоков, использующих 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–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/2.10/class-SyslogLog.html

Spec-Zone.ru

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