| <?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>LoggerLayoutGelf</title> |
| </properties> |
| |
| <body> |
| <section name="LoggerLayoutGelf" id="LoggerLayoutGelf"> |
| |
| <p>LoggerLayoutGelf formats the log as JSON string according to GELF specification.</p> |
| |
| <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>locationInfo</td> |
| <td>boolean</td> |
| <td>No</td> |
| <td>false</td> |
| <td>If set to true, adds the file name and line number at which the log statement originated.</td> |
| </tr> |
| <tr> |
| <td>host</td> |
| <td>string</td> |
| <td>No</td> |
| <td>Result of gethostname()</td> |
| <td>Name of server on which logs are collected</td> |
| </tr> |
| <tr> |
| <td>shortMessageLength</td> |
| <td>integer</td> |
| <td>No</td> |
| <td>255</td> |
| <td>Maximum length of "short_message" attribute</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| </subsection> |
| |
| <subsection name="Examples"> |
| |
| <p>Configuration:</p> |
| |
| <div class="auto-tabs"> |
| <ul> |
| <li>XML</li> |
| <li>PHP</li> |
| </ul> |
| |
| <div class="tab-content" > |
| <div class="tab-pane"> |
| <pre class="prettyprint linenums"><![CDATA[ |
| <configuration xmlns="http://logging.apache.org/log4php/"> |
| <appender name="default" class="LoggerAppenderEcho"> |
| <layout class="LoggerLayoutGelf"> |
| <param name="locationInfo" value="true" /> |
| <param name="host" value="example.com" /> |
| <param name="shortMessageLength" value="100" /> |
| </layout> |
| </appender> |
| <root> |
| <appender_ref ref="default" /> |
| </root> |
| </configuration> |
| ]]></pre> |
| </div> |
| <div class="tab-pane"> |
| <pre class="prettyprint linenums"><![CDATA[ |
| array( |
| 'appenders' => array( |
| 'default' => array( |
| 'class' => 'LoggerAppenderEcho', |
| 'layout' => array( |
| 'class' => 'LoggerLayoutGelf', |
| ) |
| ) |
| ), |
| 'rootLogger' => array( |
| 'appenders' => array('default') |
| ), |
| ) |
| ]]></pre> |
| </div> |
| </div> |
| </div> |
| |
| <p>Running the following code:</p> |
| |
| <pre class="prettyprint linenums"> |
| Logger::configure("config.xml"); |
| $logger = Logger::getLogger('myLogger'); |
| $logger->info("Lorem ipsum dolor sit amet, consectetur adipiscing elit."); |
| </pre> |
| |
| <p>Produces the following output:</p> |
| |
| <pre> |
| { |
| "version":"1.1", |
| "host":"some-backend.host", |
| "short_message":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.", |
| "full_message":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.", |
| "timestamp":1397928743.1809, |
| "level":6, |
| "_facility":"myLogger", |
| "_thread":"8064", |
| "_file":"NA", |
| "_line":"NA", |
| "_class":"YourClassName", |
| "_method":"YourMethodName", |
| } |
| </pre> |
| |
| </subsection> |
| </section> |
| </body> |
| </document> |
