LOG4AIR

Log4AIR is a versatile, industrial-grade ActionScript 3 logging framework based on Apache's Log4j.

It uses a JSON formatted configuration file (instead of the typical XML) to manipulate and customize logging for richer, clearer log files.

The JSON format is easier to read, write, and is less resource-hungry on the AVM than XML. With JSON's conciseness, you can modify your config with ease.

USAGE

The below shows the example config file (located in the bin folder as log4air_config.json):

{
  "appenders": [
    {
      "name": "STDOUT",
      "class": "net.blaxstar.log4air.appenders.ConsoleAppender",
      "layout": {
        "class": "net.blaxstar.log4air.layouts.PatternLayout",
        "pattern": "%date%level%class %msg"
      }
    },
    {
      "name": "FILE",
      "class": "net.blaxstar.log4air.appenders.FileAppender",
      "layout": {
        "class": "net.blaxstar.log4air.layouts.PatternLayout",
        "pattern": "%date%level%class %msg"
      },
      "filepath": "fakefile.log"
    }
  ],
  "loggers": [
    {
      "name": "Main",
      "level": "INFO",
      "appender_ref": "STDOUT"
    }
  ],
  "root": {
    "level": "OFF",
    "appender_ref": "STDOUT"
  }
}

appenders and layouts are extendable, so you can create your own custom configs. currently, there are the base Appender class, ConsoleAppender for writing to standard output, and FileAppender for writing to files. You can use multiple loggers at the same time (stdout and to file at the same time, for example). you can also turn loggers off by setting their level to "OFF". Here is a list of all the logging levels that you can use for your configs, along with their priority levels:

- ALL = int.MIN_VALUE
- SUCCESS = 0
- DEBUG = 10
- INFO = 20
- WARN = 30
- ERROR = 40
- FATAL = 50
- OFF = int.MAX_VALUE

once your config is how you want it, simply reference your appender classes and layouts somewhere in your application so that they are compiled, then get an instance of your logger to start using right away:

import net.blaxstar.log4air.appenders.ConsoleAppender;
import net.blaxstar.log4air.appenders.FileAppender;
import net.blaxstar.log4air.layouts.PatternLayout;
ConsoleAppender;
FileAppender;
PatternLayout;

public class Main extends Sprite {
    private var log:Logger = LoggerFactory.getLogger(Main);
    public function Main() {
        log.info("initializing app...");
        var fairy:Sprite = new Sprite();
        log.debug("Created class: {}", fairy);
        addChild(fairy);
        log.debug("added man to {}", this);
        log.info("main finished");
    }
}
// using the example config, this outputs:
// [2024/04/30 @ 23:09:17.544][INFO][Main] initializing app...
// [2024/04/30 @ 23:10:34.787][INFO][Main] main finished