ALox  V. 2402 R. 0
Home ALox for C++ ALox for C# ALox for Java Download
Overview

Table of Contents

What is ALox?

ALox is a software library that provides an ecosystem to support structured and organized log output.

ALox has three language incarnations:

To reach this goal, ALox is featured by ALib, which is a basic utility library that among other goals provides "source-compatible" types for the three languages. (See ALib for C++, C#, Java.)

Attention
As of library version 1805, the C++ sources of ALox have been moved to an own, dedicated repository. The rationale for this was, that the relationship of ALib and ALox has been reversed: In the C++ world, ALox is now one of several modules of the general purpose library ALib, instead of building on it (as it is still explained above).

ALox attempts to make logging as easy and lightweight as possible. We want you to stop adding temporary debug output lines into your code. Instead, write (with less effort!) short, nice and readable ALox statements that live in your code as if they were comment lines. Let ALox do the rest: Add meta information to the output, format the output, filter output based on Verbosity and based on your current topic of interest (what we call 'Log Domain'). Finally, get it all pruned out of your release executable, same as your source comments.

On the other end of the list, ALox enables release logging for productive applications to collect mission critical metrics from the field.

This is Version 2402 Revision 0, which incorporates only minor changes and fixes on the JAVA and C# side of things. The C++ version that was released a few days earlier, has received many more changes.

We are optimistic that the simple Bauhaus Style architecture of the library allows you to easily use it and even to extend it with logging features you need.

We would be happy to receive your feedback and feature requests.

Features and Limitations

To get an overview about what ALox offers, read 02 - Features and Limitations.

Documentation

ALox comes with a detailed User Manual for in-depth information on various topics. This manual is programming language agnostic.

Language specific documentation is given with:

Note
If the main menu option Home is selected (on the top of this page), the search box on the right side of that menu searches in all three language specific reference documentation sets.
If one of the language specific versions is selected the main menu, then the search box finds results exclusively from the reference documentation of the selected language.

A version history is provided in the Change Log.

All documentation is created with marvelous Doxygen!

FAQ

This is the FAQ - Frequently asked Questions for ALox

How to contribute

If you want to contribute by adding functionality or fixing bugs, please use Github standard procedures. For other types of contribution or questions, please contact alox at a-worx dotcom.

Copyright

ALox is open source software, can be downloaded at Github and sources are published under Boost Software License:

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Thanks

Our thanks go to all supporters to that did and do help realizing this project, especially:

  • To a bunch of good friends giving ideas, motivation and for being brave enough to continuously test our early releases.
  • To just all of these millions of supporters of free software, including
  • Special thanks also to C. Darwin, who created life on earth hundreds of millions of years ago, until he disappiert 1882 - obviously when things became too crazy!

Alternatives

The following alternatives to ALox may be worth mentioning:

For C++:

For C#:

For Java:

Generated by   doxygen 1.8.16