Predefined XML files

Log5F tries to load configuration from these predefined URLs `{bin-dir}/log5f.xml` *or* `{bin-dir}/log5f.properties`. So if Log5F can load `log5f.xml` it can’t try to load `log5f.configuration`, but it try to load `log5f.configuration` if loading `log5f.xml` is fail.

Custom Configuration

Log5F allows to customize configuration through the `Log5FConfigurator` class, that provides API for add URLs of custom configuration files.

Log5FConfigurator API

Log5FConfigurator has next `static` fields:

Log5FConfigurator.ready

A flag that indicates if Log5F is configured and ready to use.

Log5FConfigurator.traceErrors

A flag that indicates if Log5F throw an error messages to trace.

Log5FConfigurator.configure(source:Object, force:Boolean):void;

Allows to add url of an external configuration file, whereupon it will be loaded before loading of the predefined files.
Also it method configures Log5F from the specified in `source` data, if it isn’t a string.

Parameters:

• source Contains a configuration data, can be XML or string. If it is a XML it will used for configuration immediately, if it is a string it will used as an url to load configuration data.
• force Inidicates if need to start loading XML data from specified url in `source` at once.

Example:

Log5FConfigurator.configure("configuration.xml");

Note: If source is not string configuration starts immediately, otherwise configuration starts only when Log5F is really used.

Configuration from XML

From version 1.0 is possibility to configure Log5F from XML, just pass to Log5FConfigurator.configure method XML in first parameter:

var config:XML = 
<configuration xsi:noNamespaceSchemaLocation="log5f.properties.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:log5j="http://log5f.org">
  <root level="ERROR" appenders="firebug"/>
  <logger name="com.example" level="DEBUG" appenders="firebug" />
  <appender name="firebug" class="org.log5f.appenders.FirebugAppender">
	<param name="layout" value="org.log5f.layouts.PatternLayout" type="Class">
	  <param name="conversionPattern" value="%d{ABSOLUTE} %c{1} - %m%n" type="String"/>
	</param>
  </appender>
</configuration>;

Log5FConfigurator.configure(config);

Note: If source is not string configuration starts immediately.

Configuration via FlashVars

From version 1.0 Log5F finds URL to configuration file in FlashVars, see more.

This page on project’s wiki.

<object id="index" classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="100%" height="100%" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0">
    <param name="FlashVars" value="log5f=path_to_config.xml" />
    <param name="src" value="index.swf" />
    <param name="name" value="index" />
    <embed id="index" type="application/x-shockwave-flash" width="100%" height="100%" src="index.swf" name="index" flashvars="log5f=path_to_config.xml"></embed>
</object>

See more about it on a Wiki Page.

http://log5f.googlecode.com/svn/tags/0.5

• create class that extends org.log5f.Appender class;
• override method org.log5f.Appender.append;
• in some place of application call LoggerManager.forceCompile for forced compile your appender;
• modify log5f.properties file to add using your custom appender;

Example

In this example we create an appender that used Flex’s Alert component to show log messages.

Create Class

Creating class with name AlertAppender that extends Log5F’s Appender

package org.log5f.demos.custom.appenders
{
    import org.log5f.Appender;
    
    /**
     * Shows log messages in Alert control.
     */
    public class AlertAppender extends Appender
    {
        //----------------------------------------------------------------------
        //
        //  Constructor
        //
        //----------------------------------------------------------------------
        
        /**
         * Constructor.
         */
        public function AlertAppender()
        {
            super();
        }
    }
}

Override Method

The AlertAppender class uses Alert control, to display log messages. The LogEvent class represents log entry, to convert it in readable form Log5F uses layouts. The Appender class has layout that used to format log entries for this concrete appender (layouts and appenders can be customized in log5f.properties). In this example formatted log entry used as a text of the Alert:

package org.log5f.demos.custom.appenders
{
    import mx.controls.Alert;
    
    import org.log5f.Appender;
    import org.log5f.events.LogEvent;
    
    /**
     * Shows log messages in Alert control.
     */
    public class AlertAppender extends Appender
    {
        //----------------------------------------------------------------------
        //
        //  Constructor
        //
        //----------------------------------------------------------------------
        
        /**
         * Constructor.
         */
        public function AlertAppender()
        {
            super();
        }
        
        //----------------------------------------------------------------------
        //
        //  Overridden methods
        //
        //----------------------------------------------------------------------
        
        /**
         * Shows alert with log message.
         */
        override protected function append(event:LogEvent):void
        {
            Alert.show(this.layout.format(event), event.level.toString(), Alert.OK);
        }
    }
}

Using Forced Compiling

In some place of code of application call LoggerManager.forceCompile method with reference to a AlertAppender class as param, for example in applicationComplete handler:

protected function applicationCompleteHandler(event:FlexEvent):void
{
    LoggerManager.forceCompile(AlertAppender);
}

Modify log5f.properties

<configuration xsi:noNamespaceSchemaLocation="log5f.properties.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:log5j="http://log5f.org">
    
    <root level="ALL" appenders="alert"/>

    <appender name="alert" class="org.log5f.demos.custom.appenders.AlertAppender">
        <param name="layout" value="org.log5f.layouts.PatternLayout" type="Class">
            <param name="conversionPattern" value="%m" type="String" />
        </param>
    </appender>
    
</configuration>

In this example used root logger with level ALL that appends log entries over only one AlertAppender appender.

Demo Project

The demo project for creating custom appender in SVN.

• Fixed issue #6 Compilation error occurs
• Added ANT build file.

See full Change Log

View This Poll

For this You just set parameters connectionName to _mdbtrace and methodName to trace in configuration of this appender.

This is example log5f.properties config:

<configuration xsi:noNamespaceSchemaLocation="log5f.properties.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:log5j="http://log5f.org">
  <root level="ALL" appenders="minidebug"/>
  <appender name="minidebug" class="org.log5f.appenders.LocalConnectionAppender">
    <param name="layout" value="org.log5f.layouts.PatternLayout" type="Class">
      <param name="conversionPattern" value="%d{ABSOLUTE} [%p] %C{0}.%M %m" type="String"/>
    </param>
    <param name="connectionName" value="_mdbtrace" type="String"/>
    <param name="methodName" value="trace" type="String"/>
  </appender>
</configuration>

Now all log messages from application sends to MiniDebug’s based applications, for example this outputs in Flex Console:

Log messages in Flex Console.

]]> http://log5f.wordpress.com/2009/11/24/using-localconnectionappender-with-minidebug-applications/feed/ 0 max.rozdobudko sample-appender-flexconsole