eltex-ecss / chronica

Overview

Chronica is a framework for logging messages for Erlang OTP Applications.

Features

• Faster, lightweight, more flexible!
• Pinning log flows to different outputs (file, tty, network)
• Custom rules (as regexp) and text formatting for output are supported.
• Possibility to define text formatting separately for each backend
• Tools for remote connection allows you to set rule and get back log flow filtered by that rule (grablog)
• Easy migration from lager
• Logging functions which are unused because of current verbose level causes no overhead (deleting unused calls for log level on-the-fly)
• Write on disk in two modes: text and binary
• Custom backends for output logs
• Supports unicode
• Log rotate
• Colored output to terminal
• Change log level and rules in runtime
• Custom tags for easy filtered logs

Usages

In order to add Chronica into your application you will need to add it as Erlang dependency in app file and also set compiler options:

{parse_transform, pt_chronica}

Or add include file in each module if it uses Chronica:

-include_lib("chronica/include/chronica.hrl").

Supported log levels:

(MAX) debug -> trace -> info -> warning -> (MIN) error

And custom tags defines (for easy split on different output flows) as atom in compile time. In all logging messages add service information (module name, line number in source code when located this logging message).

Formats for call log:

log:Level("String"),                 %% log:info("Hello world!")
log:Level("Format", [Args]),         %% log:error("Crush from ~p", [self()])
log:Level(Tag, "Format", [Args]),    %% log:debug(verbose, "Verbose tag", [])
log:Level([Tags], "Format", [Args]), %% log:trace([a, b], "Multiple tag", [])
Tag := atom

Or usage macros: ?DBG, ?TRACE, ?INFO, ?WARN, ?ERR from header file:

-include_lib("chronica/include/chronica_macro.hrl").

Because of function log:Level replace on inner Chronica functions in compile time next example will surprise you:

log:info("My stacktrace: ~p", [erlang:get_stacktrace()])

and replace on

log:info("My stacktrace: %stack", [])

log:todo:

Applies developers instead unused variable:

    garbage() ->
        ...
        TODO_DELETE_THIS_METHOD,
        ...
erlc ...
variable 'TODO_DELETE_THIS_METHOD' is unused

Example:

    garbage() ->
        ...
        log:todo("Delete this method")
        ...
erlc ...
TODO: Delete this method

Configs:

Add default section to sys.config:

{chronica, [
    Rules,
    Flows,
    Formats,
    InternalLogger,
    InternalLoggerFilename,
    LogRoot,
    MaxFileSize,
    MaxFileNum,
    LogIfacePath
   ]}

Example

Options:

Rules:

List rules for filtered log in logging flow. Rule contains name, regexp for filtered message (may be include module, user tags), logging level (error, warning, info, trace, debug) list flow and toggle. Regexp may be contain special character:

• "|" or
• "&" and
• "*" null or more any character
• "?" one ant character
• "!" not

{warning_example1, “*”, warning, [warning_file], off},

this rule include all warning message in warning_file flow but turn off,

{warning_example2, “mysql*&!mysql_ag*”, error, [tty, error], on},

this rule include error message from modules beginning mysql besides mysql_ag and output in tty and error flows

Flows:

Named streams for output process and provided backens (tty, file, udp). Include mode for saving data (binary - lightweight for big intensity and text) and name formats.

For example:

{warning_file, [{file, [{name, "warning.log"}]}]},

Define "warning_file" flow output data in file with "warning.log" filename in default format and text mode.

{warning_file, [{file, [{name, "warning.log",}, {format, binary}]}]},

As previous example but in binary mode

{warning_file, [{tty, [{format, custom_format}]}]},

Flow output in terminal in "custom_format" format

{journald, [{journald, [{format, short}]}]},

Flow output in journald (if exist)

Formats:

Define output format for message. Comprises from service macros beginig in '%'. Default configuration already have one formats: 'default', but you may be override him.

Examples:

 {full, "%Id %Y-%M(%Ml)-%D %H:%Mi:%S:%Ms %PRIORITY %P %Priority %Pid %File %Line %Module %Function %Message %MessageLine\n"}
 {default, "%Y-%M-%D %H:%Mi:%S:%Ms %PRIORITY %Pid [%Module:%Line]: %Message\n"},
 {short, "%Y-%M-%D %H:%Mi:%S:%Ms %P %Pid [%Module:%Line]: %Message\n"}

default flow
{flows, [{screen, [{tty, [{format, default}]}]}]}
Out:
    2015-09-27 14:59:32.012401 WARN  <0.130.0> [testing_chronica_logs:testing_short_warning_file/1:57]: test chronica

Override default:

{flows, [{screen, [{tty, [{format, default}]}]}]},
{formats,[{default, "%H:%Mi:%S.%Ms [%Priority] %Message\n"}]},
Out:
    15:03:15.702088 [warning] test chronica

If you want define custom formatter:

{flows, [{file, [{name, "warning_log"}, {format, my_default}]}]},
{formats, [{my_default, “%Message”}]}

Compilation modes

Chronica supports three compilation modes

• chronica optimization. Optimization mode (Default). In this mode, Chronica allows you to display warnings about variables that are declared in the function body, but are used only in the log:level (...). To avoid receiving warnings, declare variables as \Var_.
• chronica default. Mode with optimization turned off. Early this mode was the default.
• chronica disabled. The mode in which chronica cuts out log:level(...).

Compilation Options

Are used to define the behavior at compile time chronica. The options can be set in two ways

• Using environment variables:
  • CHRONICA_MATCH_IGNORED_VAR
  • CHRONICA_DISABLED
  • CHRONICA_DEFAULT
• Support erlang compile options
  • chronica_match_ignored_var
  • chronica_disabled
  • chronica_default
• Declaring the compile(Option) field in the file
  • chronica_match_ignored_var
  • chronica_disabled
  • chronica_default

CHRONICA_MATCH_IGNORED_VAR || chronica_match_ignored_var

This option is used only in the chronica optimization mode and allows you to display warnings about variables that are declared as \Var_

CHRONICA_DISABLED || chronica_disabled

The options is used to activate the mode chronica disabled

CHRONICA_DEFAULT || chronica_default

The options is used to activate the mode chronica default

Runtime API

For update Chronica configuration in runtime usages:

• chronica_manager:active(false | true)

Toggle chronica

• chronica_manager:update_rule_inwork(name_rule, false | true)

Toggle "name_rule" rule on the fly.

• chronica_manager:add_application(App)

Add new application in list logging application

• chronica_manager:add_rule(Rule, Regexp, Level, Flow)
• chronica_manager:add_rule(Rule, Regexp, Level, Flow, Fun)

Add new rule in list logging rule and activates