MicroLog Darius Katz Johan Karlsson Background Johan K. noticed - PowerPoint PPT Presentation

MicroLog Darius Katz Johan Karlsson

Background Johan K. noticed the lack of a good logger for the Java ME environment. So he simply sat down and coded the first version of MicroLog and put it on SourceForge. The rest is history...

Features overview Log4j wannabe Log to the console Log to RMS (accessible with an included midlet) Log to file Log to Form Log over Bluetooth (coming real soon) Log over GPRS (coming soon) Flexible formatting Configurable

Using MicroLog //Init the logger Logger log = Logger.getLogger(); log.configure(properties); ... ... log.info(“Log this text”);

Using MicroLog //Init the logger Logger log = Logger.getLogger(); log.configure( properties ); ... ... log.info(“Log this text”); ?

Properties Properties is a module in MicroLog which helps to set up the Logger. Example: microlog.level=DEBUG microlog.appender=net.sf.microlog.appender.RecordStoreA... microlog.appender.RecordStoreAppender.maxLogEntries=20 microlog.formatter=net.sf.microlog.format.SimpleFormatter Line 2 in all its glory: microlog.appender=net.sf.microlog.appender.RecordStoreAppe nder ; net.sf.microlog.appender.ConsoleAppender note: two Appenders

Property sources 4 different sources today:  Default values  Property file  Application properties (attributes)  Numbered application properties (attributes)

Default values Class is called DefaultValues Hardcoded in the class. Used if not changed by user in another property source. All “system properties” should be included. (In our case everything that MicroLog uses.)

Property file Class is called PropertyFile A file named microlog.properties in the midlet- root contains the properties/values. User can change the default values. User can add own values. Example: microlog.level=DEBUG microlog.appender=net.sf.microlog.appender.RecordStoreA... microlog.appender.RecordStoreAppender.maxLogEntries=20 microlog.formatter=net.sf.microlog.format.SimpleFormatter

Application properties Class is called AppProperty Properties are added in the jad-file or in the manifest-file as usual attributes ( property:value) User can change the default values. User can override the values in the properties file. User can not add own values.

Numbered application props Class is called Numbered AppProperty Properties are added in the jad-file or in the manifest-file as attributes in a special way:  AppProperty_1 : MyProperty=MyValue  AppProperty_2 : MyOtherProperty=MyOtherValue  AppProperty_3 : SomeOtherProperty=SomeOtherValue User can change the default values. User can override the values in the properties file and the values set in application properties. User can add own values.

Repetition Values are read in the following order: 1.DefaultValues 2.PropertyFile 3.AppProperty 4.NumberedAppProperty Each new level overrides the same properties in the previous levels.

Using Properties //Create a new properties in the MIDlet class Properties properties = new Properties(this); ... this is the midlet ... myString = (String)properties.get(“MyProperty”); myString = properties.getString(“MyProperty”); ...

Finally Use Properties in your own mobile applications

Using MicroLog //Init the logger Logger log = Logger.getLogger(); log.configure( properties ); ... ... log.info(“Log this text”); ? X

Using MicroLog, the final cut //Init properties Properties properties = new Properties(this); //Init the logger Logger log = Logger.getLogger(); log.configure(properties); ... ... log.info(“Log this text”); log.error(“Log this error”);

MicroLog building blocks Appenders (“output channels”)  ConsoleAppender (to the console)  FileAppender (to a file via JSR75, FileConnection API)  RecordStoreAppender (to the RMS)  FormAppender (to a form)  BluetoothAppender (under development)  GPRSAppender (to be developed)  more... Formatters (“looks of the output”)  SimpleFormatter (predefined, simple)  ConfigurableFormatter (under development)  more?

Popular Appenders ConsoleAppender  Used in emulators  Used in P900/P910 with a utility RecordStoreAppender  Used in all mobiles  Comes with a MIDlet that views the logs BluetoothAppender  Send logs to the PC  Used with mobiles that support Bluetooth

How to add to your project Download and unpack Copy source-code to your project  (JAR-file in the future when the API is finalized)  copy microlog.properties if needed Set properties  in application properties OR  in microlog.properties file (important: correct CRLF) Add MIDlet to suite  RecordStoreLogViewer (if needed) Add init code  in MIDlet constructor OR  in MIDlet startUp() method Use  don't abuse (might slow down)

Demo Live on stage

How to add to your project Download and unpack Copy source-code to your project  (JAR-file in the future when the API is finalized)  copy microlog.properties if needed Set properties  in application properties OR  in microlog.properties file (important: correct CRLF) Add MIDlet to suite  RecordStoreLogViewer (if needed) Add init code  in MIDlet constructor OR  in MIDlet startUp() method Use  don't abuse (might slow down)

Code help wanted BluetoothAppender (BT-expert needed) GprsAppender More flexible Formatter  perhaps “%d %t %m” etc. Get hold of stacktrace in exception Improve read of microlog.properties file Anything else you'd like Non-coding things:  Design homepage  Tutorials  FAQ  Manuals

Links MicroLog homepage: http://microlog.sourceforge.net Project page on SourceForge: http://sf.net/projects/microlog

Thank you for listening