module Netplex_log:Loggerssig
..end
logging
section is inside controller
, e.g.
netplex {
...
controller {
...
logging { ... };
...
}
...
}
The possible types of logging
sections are explained below.
If there are several logging
sections, the messages are sent to
all configured loggers.
Instead of configuring loggers in the config file, one can also
create loggers from config objects like generic_config
.
See also Logging for more documentation.
class type generic_config =object
..end
val channel_logger : Pervasives.out_channel -> Netplex_types.logger
val channel_logger_from_obj : generic_config -> Pervasives.out_channel -> Netplex_types.logger
val stderr_logger_factory : Netplex_types.logger_factory
logging {
type = "stderr";
format = "<format string>";
component = "<name_of_component>";
subchannel = "<name_of_subchannel>";
max_level = "<max_level>";
}
format
: Optional format string. See below.component
: Optional component selector. See below.subchannel
: Optional subchannel selector. See below.max_level
: Optional maximum log level. See below.val file_logger : string -> Netplex_types.logger
val file_logger_from_obj : generic_config -> string -> Netplex_types.logger
val file_logger_factory : Netplex_types.logger_factory
logging {
type = "file";
file = "/path/to/logfile";
format = "<format string>";
component = "<name_of_component>";
subchannel = "<name_of_subchannel>";
max_level = "<max_level>";
}
file
: Log messages are appended to this file.format
: Optional format string. See below.component
: Optional component selector. See below.subchannel
: Optional subchannel selector. See below.max_level
: Optional maximum log level. See below.class type multi_file_config =object
..end
val multi_file_logger : multi_file_config -> Netplex_types.logger
val multi_file_logger_factory : Netplex_types.logger_factory
logging {
type = "multi_file";
directory = "/path/to/logdir";
format = "<format string>";
file {
component = "<name_of_component>";
subchannel = "<name_of_subchannel>";
max_level = "<max_level>";
file = "<logfile>";
format = "<format string>";
};
file { ... }; ...
}
format
: Optional format string. See below.component
: Optional component selector. See below.subchannel
: Optional subchannel selector. See below.max_level
: Optional maximum log level. See below.class type syslog_config =object
..end
val syslog_logger : syslog_config -> Netplex_types.logger
val syslog_logger_factory : Netplex_types.logger_factory
logging {
type = "syslog";
format = "<format string>";
identifier = "<identifier>";
facility = "<facility name>";
component = "<name_of_component>";
subchannel = "<name_of_subchannel>";
max_level = "<max_level>";
}
All parameters except type
are optional:
facility
: The faciltiy like LOCAL0
, USER
, ...identifier
: An identifier prefixing every messageformat
: Optional format string. See below.component
: Optional component selector. See below.subchannel
: Optional subchannel selector. See below.max_level
: Optional maximum log level. See below.val logger_factories : Netplex_types.logger_factory list
val level_weight : Netplex_types.level -> int
val level_of_string : string -> Netplex_types.level
The format string may include variable
parts in the syntax $name
or ${name}
. The following variable
specifications are defined:
timestamp
: the time in standard format (as set in
Netlog.current_formatter
)timestamp:<format>
the time in custom format where <format>
is a
Netdate
format stringtimestamp:unix
: the time in seconds since the epochcomponent
: the name of the component emitting the log messagesubchannel
: the name of the subchannellevel
: the log levelmessage
: the log message
The component
name restricts logging to the given Netplex component.
One can use the wildcard "*".
subchannel
The subchannel
name restricts logging to this subchannel.
One can use the wildcard "*".
max_level
The max_level
specifier restricts logging to messages with at most
this level. Levels are "emerg", "alert", "crit", "err", "warning",
"notice", "info", "debug" (in order of increasing level).