| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> |
| |
| <properties> |
| <title>LoggerAppenderGraylog2</title> |
| </properties> |
| |
| <body> |
| <section name="LoggerAppenderGraylog2"> |
| |
| <p><code>LoggerAppenderGraylog2</code> appends log events to a Graylog2 server.</p> |
| |
| <subsection name="Layout"> |
| <p>This appender requires a layout. If no layout is specified in configuration, |
| <code><a href="../layouts/gelf.html">LoggerLayoutGelf</a></code> will be used by default.</p> |
| </subsection> |
| |
| <subsection name="Parameters"> |
| <p>The following parameters are available:</p> |
| |
| <table> |
| <thead> |
| <tr> |
| <th>Parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>host</td> |
| <td>string</td> |
| <td>No</td> |
| <td>localhost</td> |
| <td>Server on which graylog2-server instance is located.</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td>integer</td> |
| <td>No</td> |
| <td>12201</td> |
| <td>Port on which the instance is bound.</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>integer</td> |
| <td>No</td> |
| <td><code>ini_get('default_socket_timeout')</code></td> |
| <td>Timeout in seconds.</td> |
| </tr> |
| <tr> |
| <td>chunkSize</td> |
| <td>integer</td> |
| <td>No</td> |
| <td>8152</td> |
| <td>Message chunk size in bytes.</td> |
| </tr> |
| </tbody> |
| </table> |
| </subsection> |
| |
| <subsection name="Examples"> |
| |
| <p>This example shows how to configure <code>LoggerAppenderGraylog2</code> to log |
| to a remote graylog2 server.</p> |
| |
| <div class="auto-tabs"> |
| <ul> |
| <li>XML</li> |
| <li>PHP</li> |
| </ul> |
| |
| <div class="tab-content" > |
| <div class="tab-pane"> |
| <pre class="prettyprint"><![CDATA[ |
| <configuration xmlns="http://logging.apache.org/log4php/"> |
| <appender name="default" class="LoggerAppenderGraylog2"> |
| <param name="host" value="localhost" /> |
| <param name="port" value="12201" /> |
| <param name="timeout" value="3" /> |
| </appender> |
| <root> |
| <appender_ref ref="default" /> |
| </root> |
| </configuration> |
| ]]></pre> |
| </div> |
| <div class="tab-pane"> |
| <pre class="prettyprint"><![CDATA[ |
| array( |
| 'appenders' => array( |
| 'default' => array( |
| 'class' => 'LoggerAppenderGraylog2', |
| 'params' => array( |
| 'host' => 'localhost', |
| 'port' => 12201, |
| 'timeout' => 3 |
| ), |
| ), |
| ), |
| 'rootLogger' => array( |
| 'appenders' => array('default'), |
| ), |
| ); |
| ]]></pre> |
| </div> |
| </div> |
| </div> |
| </subsection> |
| </section> |
| </body> |
| </document> |
