Spec-Zone.ru › CakePHP 4.3

Класс SyslogLog

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

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

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

  • $_config protected
    array<string, mixed>

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array<string, mixed>

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

  • $_levelMap protected
    array<int>

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

  • $_open protected
    bool

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

  • $formatter protected
    Cake\Log\Formatter\AbstractFormatter

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

  • __construct() public

    Метод __construct

  • __destruct() public

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _format() protected deprecated

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

  • _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

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

  • interpolate() protected

    Заменяет заполнитель в строке сообщения значениями контекста.

  • levels() public

    Получить уровни, которые интересуют этот логгер.

  • log() public

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

  • notice() public

    Обычные, но значимые события.

  • scopes() public

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

  • setConfig() public

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

  • warning() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

__construct(array<string, mixed> $config = [])

Метод __construct

Параметры

array<string, mixed> $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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key

Ключ для записи.

mixed $value

Значение для записи.

string|bool $merge необязательно

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

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

_format() protected 

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

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

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

Параметры

string $message

Сообщение для форматирования.

array $context необязательно

Дополнительная информация для сообщения.

Возвращает

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(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $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

interpolate() protected 

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

Заменяет плейсхолдеры в строке сообщения значениями контекста.

Параметры

string $message

Отформатированная строка

array $context необязательно

Контекст для значений плейсхолдеров.

Возвращает

string

levels() public 

levels(): array<string>

Получить уровни, которые интересуют данный логгер.

Возвращает

array<string>

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<string>|false

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

Возвращает

array<string>|false

setConfig() public 

setConfig(array<string, mixed>|string $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']);

Параметры

array<string, mixed>|string $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<string, mixed>

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

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

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

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

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

Пример:

Log::config('error', ]
     'engine' => 'Syslog',
     'levels' => ['emergency', 'alert', 'critical', 'error'],
     'prefix' => 'Web Server 01'
 ]);

Тип

array<string, mixed>

$_levelMap protected

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

Тип

array<int>

$_open protected

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

Тип

bool

$formatter protected

Тип

Cake\Log\Formatter\AbstractFormatter

© 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.3/class-Cake.Log.Engine.SyslogLog.html

Spec-Zone.ru

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