Класс yii\elasticsearch\ElasticsearchTarget
| Наследование | yii\elasticsearch\ElasticsearchTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0.5 |
| Исходный код | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ElasticsearchTarget.php |
ElasticsearchTarget хранит сообщения журнала в индексе elasticsearch.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $cacheContext | boolean | Если true, контекст сообщения будет кэширован после создания. | yii\elasticsearch\ElasticsearchTarget |
| $categories | array | Список категорий сообщений, к которым относится этот целевой объект. | yii\log\Target |
| $db | yii\elasticsearch\Connection|array|string | Объект подключения elasticsearch или идентификатор компонента приложения для подключения elasticsearch. | yii\elasticsearch\ElasticsearchTarget |
| $enabled | boolean | Включить ли этот целевой объект журнала. | yii\log\Target |
| $except | array | Список категорий сообщений, к которым этот целевой объект НЕ относится. | yii\log\Target |
| $exportInterval | integer | Сколько сообщений должно быть накоплено, прежде чем они будут экспортированы. | yii\log\Target |
| $includeContext | boolean | Если true, контекст будет включён в каждое сообщение. | yii\elasticsearch\ElasticsearchTarget |
| $index | string | Имя индекса Elasticsearch. | yii\elasticsearch\ElasticsearchTarget |
| $levels | integer | Уровни сообщений, к которым относится этот целевой объект. | yii\log\Target |
| $logContext | boolean | Если true, контекст будет записан как отдельное сообщение после всех других сообщений. | yii\elasticsearch\ElasticsearchTarget |
| $logVars | array | Список предопределённых переменных PHP, которые должны быть записаны в сообщение. | yii\log\Target |
| $messages | array | Сообщения, полученные из логгера до сих пор этим целевым объектом журнала. | yii\log\Target |
| $options | array | Опции URL. | yii\elasticsearch\ElasticsearchTarget |
| $prefix | callable | Функция PHP, которая возвращает строку, которая будет добавлена в префикс к каждому экспортируемому сообщению. | yii\log\Target |
| $type | string | Имя типа Elasticsearch. | yii\elasticsearch\ElasticsearchTarget |
Защищённые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $_contextMessage | string | Кэшированное сообщение контекста (может быть использовано несколько раз, если контекст добавляется к каждому сообщению) | yii\elasticsearch\ElasticsearchTarget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен демонстрировать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| collect() | Обрабатывает заданные сообщения журнала. | yii\elasticsearch\ElasticsearchTarget |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| export() | Экспортирует сообщения журнала $messages в определенное место назначения. | yii\elasticsearch\ElasticsearchTarget |
| filterMessages() | Фильтрует заданные сообщения в соответствии с их категориями и уровнями. | yii\log\Target |
| formatMessage() | Форматирует сообщение журнала для отображения в виде строки. | yii\log\Target |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, прикрепленные к этому компоненту. | yii\base\Component |
| getLevels() | yii\log\Target | |
| getMessagePrefix() | Возвращает строку, которая будет предварять заданное сообщение. | yii\log\Target |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Этот метод инициализирует свойство \yii\elasticsearch\elasticsearch, чтобы убедиться, что оно ссылается на валидное соединение с Elasticsearch. | yii\elasticsearch\ElasticsearchTarget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| prepareMessage() | Подготавливает сообщение журнала. | yii\elasticsearch\ElasticsearchTarget |
| setLevels() | Устанавливает уровни сообщений, которыми интересуется этот целевой объект. | yii\log\Target |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getContextMessage() | Если свойство $includeContext имеет значение false, возвращает сообщение контекста в обычном режиме. | yii\elasticsearch\ElasticsearchTarget |
Подробности свойств
$_contextMessage защищенное свойство
Кэш сообщения контекста (может быть использован несколько раз, если контекст добавляется к каждому сообщению)
protected string $_contextMessage = null
$cacheContext публичное свойство
Если true, сообщение контекста кэшируется один раз после его создания. Имеет смысл использовать с $includeContext.
public boolean $cacheContext = false
$db публичное свойство
Объект подключения к elasticsearch или идентификатор компонента приложения для подключения к elasticsearch.
public yii\elasticsearch\Connection|array|string $db = 'elasticsearch'
$includeContext публичное свойство
Если true, контекст будет включен в каждое сообщение. Это удобно, если вы регистрируете ошибки приложения и анализируете их с помощью инструментов, таких как Kibana.
public boolean $includeContext = false
$index публичное свойство
Имя индекса Elasticsearch.
public string $index = 'yii'
$logContext публичное свойство
Если true, контекст будет записан как отдельное сообщение после всех других сообщений.
public boolean $logContext = true
$options публичное свойство
Параметры URL.
public array $options = []
$type публичное свойство
Имя типа Elasticsearch.
public string $type = 'log'
Подробности методов
collect() public method
Обрабатывает заданные сообщения журнала.
Этот метод отфильтрует заданные сообщения с помощью $levels и $categories. И при необходимости экспортирует результат фильтрации в определённый носитель (например, почту). В зависимости от атрибута $includeContext сообщение контекста будет создано или проигнорировано.
| public void collect ( $messages, $final ) | ||
|---|---|---|
| $messages | массив |
Сообщения журнала для обработки. См. yii\log\Logger::$messages для структуры каждого сообщения. |
| $final | boolean |
Является ли этот метод вызываемым в конце текущего приложения |
export() public method
Экспортирует сообщения журнала $messages в определённый пункт назначения.
Подклассы должны реализовать этот метод.
| public void export ( ) |
|---|
getContextMessage() protected method
Если свойство $includeContext ложно, возвращает сообщение контекста обычно.
Если $includeContext истинно, возвращает пустую строку (чтобы сообщение контекста в collect() не генерировалось), ожидая, что контекст будет добавлен к каждому сообщению в prepareMessage().
| protected массив getContextMessage ( ) | ||
|---|---|---|
| return | массив |
Информация о контексте |
init() public method
Этот метод инициализирует свойство \yii\elasticsearch\elasticsearch, чтобы убедиться, что оно ссылается на действительное соединение с Elasticsearch.
| public void init ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
если \yii\elasticsearch\elasticsearch недействителен. |
prepareMessage() public method
Подготавливает сообщение журнала.
| public строка prepareMessage ( $message ) | ||
|---|---|---|
| $message | массив |
Сообщения журнала для форматирования. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-elasticsearchtarget.html
