Introduction

ALox is a software library that provides an ecosystem to support structured and well organized log output. ALox is available in C++, C# and JAVA on at least GNU/Linux, Windows, Windows Phone and Android operating systems.

The library attempts to make debug logging as easy and lightweight as possible. One of the goals we want to achieve is that developers, once using the library, just stop to put any temporary debug output statements into their code, but do it all with nice, readable, configurable, reusable logging statements that can be temporarily or long-term switched off and that are furthermore automatically pruned out of release versions of the application.

On the other end of the list, we want to enable release logging for applications in production systems (release versions) to collect mission critical metrics and data from the field. Basic support for release logging is here today already. The introduction of new features and concepts in the area of release logging will also support debug logging aspects of ALox. Therefore the natural path of evolution for the ALox project is "debug features first, release features next".

We hope, the simple Bauhaus Style architecture of the library allows users to easily extend ALox. If you extended ALox by new Loggers or features, you are welcome send us your code so that we might include it to the project. (Of-course, in accordance with the license terms, otherwise please do not send anything).

Attention: But be warned: The concepts of ALox are maybe more complex than what you would expect from a typical logging library. Due to the "orthogonality" of the features, which means you can just omit the complex stuff and don't even notice that it exists in the moment you do not know it, ALox can be used in a very simple fashion though. Therefore, when you are searching for a simple, quick logging library, you have found it. But instead of reading this manual, use the tutorials and just get started. Read the manual only when you want to understand ALox in full!

Next chapter: 02 - Features and Limitations Back to index