Class yii\elasticsearch\ElasticsearchTarget
| Inheritance | yii\elasticsearch\ElasticsearchTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0.5 |
| Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ElasticsearchTarget.php |
ElasticsearchTarget stores log messages in a elasticsearch index.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $cacheContext | boolean | If true, context message will cached once it's been created. | yii\elasticsearch\ElasticsearchTarget |
| $categories | array | List of message categories that this target is interested in. | yii\log\Target |
| $db | yii\elasticsearch\Connection|array|string | The elasticsearch connection object or the application component ID of the elasticsearch connection. | yii\elasticsearch\ElasticsearchTarget |
| $enabled | boolean | Whether to enable this log target. | yii\log\Target |
| $except | array | List of message categories that this target is NOT interested in. | yii\log\Target |
| $exportInterval | integer | How many messages should be accumulated before they are exported. | yii\log\Target |
| $includeContext | boolean | If true, context will be included in every message. | yii\elasticsearch\ElasticsearchTarget |
| $index | string | Elasticsearch index name. | yii\elasticsearch\ElasticsearchTarget |
| $levels | integer | The message levels that this target is interested in. | yii\log\Target |
| $logContext | boolean | If true, context will be logged as a separate message after all other messages. | yii\elasticsearch\ElasticsearchTarget |
| $logVars | array | List of the PHP predefined variables that should be logged in a message. | yii\log\Target |
| $messages | array | The messages that are retrieved from the logger so far by this log target. | yii\log\Target |
| $options | array | URL options. | yii\elasticsearch\ElasticsearchTarget |
| $prefix | callable | A PHP callable that returns a string to be prefixed to every exported message. | yii\log\Target |
| $type | string | Elasticsearch type name. | yii\elasticsearch\ElasticsearchTarget |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $_contextMessage | string | Context message cache (can be used multiple times if context is appended to every message) | yii\elasticsearch\ElasticsearchTarget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| collect() | Processes the given log messages. | yii\elasticsearch\ElasticsearchTarget |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| export() | Exports log $messages to a specific destination. | yii\elasticsearch\ElasticsearchTarget |
| filterMessages() | Filters the given messages according to their categories and levels. | yii\log\Target |
| formatMessage() | Formats a log message for display as a string. | yii\log\Target |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getLevels() | yii\log\Target | |
| getMessagePrefix() | Returns a string to be prefixed to the given message. | yii\log\Target |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | This method will initialize the \yii\elasticsearch\elasticsearch property to make sure it refers to a valid Elasticsearch connection. | yii\elasticsearch\ElasticsearchTarget |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| prepareMessage() | Prepares a log message. | yii\elasticsearch\ElasticsearchTarget |
| setLevels() | Sets the message levels that this target is interested in. | yii\log\Target |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getContextMessage() | If $includeContext property is false, returns context message normally. | yii\elasticsearch\ElasticsearchTarget |
Property Details
$_contextMessage protected property
Context message cache (can be used multiple times if context is appended to every message)
protected string $_contextMessage = null
$cacheContext public property
If true, context message will cached once it's been created. Makes sense to use with $includeContext.
public boolean $cacheContext = false
$db public property
The elasticsearch connection object or the application component ID of the elasticsearch connection.
public yii\elasticsearch\Connection|array|string $db = 'elasticsearch'
$includeContext public property
If true, context will be included in every message. This is convenient if you log application errors and analyze them with tools like Kibana.
public boolean $includeContext = false
$index public property
Elasticsearch index name.
public string $index = 'yii'
$logContext public property
If true, context will be logged as a separate message after all other messages.
public boolean $logContext = true
$options public property
URL options.
public array $options = []
$type public property
Elasticsearch type name.
public string $type = 'log'
Method Details
collect() public method
Processes the given log messages.
This method will filter the given messages with $levels and $categories. And if requested, it will also export the filtering result to specific medium (e.g. email). Depending on the $includeContext attribute, a context message will be either created or ignored.
| public void collect ( $messages, $final ) | ||
|---|---|---|
| $messages | array |
Log messages to be processed. See yii\log\Logger::$messages for the structure of each message. |
| $final | boolean |
Whether this method is called at the end of the current application |
export() public method
Exports log $messages to a specific destination.
Child classes must implement this method.
| public void export ( ) |
|---|
getContextMessage() protected method
If $includeContext property is false, returns context message normally.
If $includeContext is true, returns an empty string (so that context message in collect() is not generated), expecting that context will be appended to every message in prepareMessage().
| protected array getContextMessage ( ) | ||
|---|---|---|
| return | array |
The context information |
init() public method
This method will initialize the \yii\elasticsearch\elasticsearch property to make sure it refers to a valid Elasticsearch connection.
| public void init ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
if \yii\elasticsearch\elasticsearch is invalid. |
prepareMessage() public method
Prepares a log message.
| public string prepareMessage ( $message ) | ||
|---|---|---|
| $message | array |
The log message to be formatted. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-elasticsearchtarget.html