Logs

Presentation

Main settings:

REMOTE_USER: session attribute used for logging user access
REMOTE_CUSTOM: can be used for logging an another user attribute or a macro (optional)
Hidden attributes: session attributes never displayed or sent.

Changed in version 2.17.0: Since version 2.17.0 hidden attributes parameter supports regular expressions. You can hide attributes by listing them or by providing one or more regexps. By example: _password, _session_id, /^notification_/ /^real\d+$/ _oidcConsents

Attention

Regexp must start and end with a slash / character.

LemonLDAP::NG provides 5 levels of error and has two kinds of logs:

technical logs
user actions logs

Each category can be handle by a different logging framework. You can choose between:

Lemonldap::NG::Common::Logger::Std: standard output (mapped in web server logs, see below)
Lemonldap::NG::Common::Logger::Syslog: syslog logging
Lemonldap::NG::Common::Logger::Apache2: use Apache2 logging, levels are stored in Apache2 logs and the log level is defined by LogLevel Apache parameter
Lemonldap::NG::Common::Logger::Log4perl: use Log4perl framework to log (inspired by Java Log4J)
Lemonldap::NG::Common::Logger::Loki: push logs into a Loki server
Lemonldap::NG::Common::Logger::Sentry (experimental): use Sentry to store logs
Lemonldap::NG::Common::Logger::Dispatch: dispatch logs in other backends depending on log level

Attention

Except for Apache2 and Log4Perl, log level is defined by logLevel parameter set in lemonldap-ng.ini file. Logger configurations are defined in lemonldap-ng.ini. Example:

[all]
logger     = Lemonldap::NG::Common::Logger::Log4perl
userLogger = Lemonldap::NG::Common::Logger::Syslog
logLevel   = notice

You can also modify these values in each lemonldap-ng.ini section to have different values for portal, manager and handlers.

Therefore, LLNG provides a username that can be used by web servers in their access logs. To configure the user identifier to write into access logs, go to Manager, General Parameters > Logging > REMOTE_USER.

User log samples

Note

The user name set in user log messages is set with whatToTrace parameter, except for messages corresponding to failed authentifications, when the user name logged is the login used by the user.

Authentication:

[info] User dwho successfully authenticated at level 2
[info] User dwho connected from LDAP (81.20.13.21)

Failed authentication:

[warn] foo.bar was not found in LDAP directory (81.20.13.21)
[warn] Bad password for dwho (81.20.13.21)

Failed authentication with Combination module:

[warn] All schemes failed for user dwho (81.20.13.21)

Logout:

[notice] User dwho has been disconnected from LDAP (81.20.13.21)

Password change:

[notice] Password changed for dwho (81.20.13.21)

Access to a CAS application non registered in configuration (when CAS server is open):

[notice] User dwho is redirected to https://cas.service.url

Access to a CAS application whose configuration key is app-example:

[notice] User dwho is authorized to access to app-example

Access to an SAML SP whose configuration key is sp-example:

[notice] User dwho is authorized to access to sp-example

Access to an OIDC RP whose configuration key is rp-example:

[notice] User dwho is authorized to access to rp-example

Access to a Get application whose vhost configuration key is host.example.com:

[notice] User dwho is authorized to access to host.example.com

Default loggers

Apache handlers use by default Apache2 logger. This logger can not be used for other LLNG components
Except when launched by LLNG FastCGI server (used by Nginx), Portal and Manager use Std logger by default
All components launched by LLNG FastCGI server use Syslog by default

Log levels

Technical log levels

error is used for problems that must be reported to administrator and needs an action. In this case, some features may not work
warn is used for problems that do not block LLNG features but should be solved
notice is used for actions that must be logged
info displays some technical information
debug generates lot of debugging logs

Logger configuration

Std logger

Nothing to configure except logLevel.

Apache2 logger

The log level can be set with Apache LogLevel parameter. It can be configured globally, or inside a virtual host.

See http://httpd.apache.org/docs/current/mod/core.html#loglevel for more information.

Syslog

You can choose facility in lemonldap-ng.ini file. Default values:

syslogFacility     = daemon
userSyslogFacility = auth

You can also override options. Default values:

syslogOptions      = cons,pid,ndelay
userSyslogOptions  = cons,pid,ndelay

Tip

You can find more information on Syslog options in Sys::Syslog Perl module.

Log4perl

You can define the Log4perl configuration file and classes to use. Default values:

log4perlConfFile   = /etc/log4perl.conf
log4perlLogger     = LLNG
log4perlUserLogger = LLNGuser

Sample log4perl.conf file

log4perl.logger.LLNG = DEBUG, Syslog
log4perl.logger.LLNGuser = INFO, Syslog
log4perl.appender.Syslog = Log::Dispatch::Syslog
log4perl.appender.Syslog.ident = LLNG
log4perl.appender.Syslog.layout = PatternLayout
log4perl.appender.Syslog.layout.ConversionPattern = [%p] %m

For additional information, please read the Log4Perl documentation

New in version 2.0.14: The following special formatters have been added to standard PatternLayout placeholders

%Q{address}: IP address of the request
%Q{user}: Username of the current user
%Q{id}: Session ID of the current user
%E{ENV_VAR}: content of the ENV_VAR variable

New in version 2.17.

%S{mail}: content of the mail session variable

New in version 2.19.

%Q{request_id}: Unique request ID, from UNIQUE_ID environment variable, or generated by LemonLDAP::NG if UNIQUE_ID is not found.

New in version 2.21.0.

Loki

Here are the configuration parameters with their default values:

Parameter	Comment	Default value
`lokiUrl`	URL of Loki API	`http://localhost:3100/loki/api/v1/push`
`lokiLabel`	Value of `label` field	`llng`
`lokiInstance`	Value of `instance` field	(hostname command result)
`lokiEnv`	Value of `env` field	`prod`
`lokiService`	Value of “service” when used as technical logger	`llng`
`lokiUserService`	Value of “service” when used as userLogger	`auth`
`lokiTenant`	Used to populate `X-Scope-OrgID` header
`lokiTenantHeader`	Used to change default tenant header	`X-Scope-OrgID`
`lokiAuthorization`	Set here the whole value to put in the `Authorization` header. For example: `Basic dXNlcjpwYXNzd29yZA==` (Base64 encoding of user:password)

Is it recommended to combine this logger with the auditLogger “Lemonldap::NG::Common::AuditLogger::UserLoggerJSON” to have useful logs for Grafana. Example of lemonldap-ng.ini file:

[ all ]
logger      = Lemonldap::NG::Common::Logger::Loki
auditLogger = Lemonldap::NG::Common::AuditLogger::UserLoggerJSON
lokiUrl     = http://10.1.2.3/loki/api/v1/push

Sentry

You just have to give your DSN:

sentryDsn = https://...

Attention

This experimental logger requires Sentry::Raven Perl module.

Dispatch

Use it to enable more than one logger. Example:

logger               = Lemonldap::NG::Common::Logger::Dispatch
userLogger           = Lemonldap::NG::Common::Logger::Dispatch
logDispatchError     = Lemonldap::NG::Common::Logger::Sentry
logDispatchNotice    = Lemonldap::NG::Common::Logger::Syslog
userLogDispatchError = Lemonldap::NG::Common::Logger::Sentry
; Other parameters
syslogFacility    = daemon
sentryDsn         = https://...

Attention

At least logDispatchError (or userLogDispatchError for user logs) must be defined. All sub level will be dispatched on it, until another lever is declared. In the above example, Sentry collects error and warn levels and all user actions, while syslog stores technical notice, info and debug logs.

Audit logs

New in version 2.19.

beta This feature may change in a future version, event codes and format should not be considered stable.

LemonLDAP::NG user logs (see above) are being replaced with a new facility: Audit logs.

Audit logs are structured logs that are meant to be easier to process than the current log messages.

At the moment, audit logs are transmitted by default to the configured userLogger. But you can plug-in your own custom implementation.

auditLogger=My::Logger::Class

Your logger class can look something like this:

package My::Logger::Class;
use Scalar::Util qw(weaken);

sub new {
    my ( $class, $psgi_or_handler ) = @_;
    my $self = bless {}, $class;

    # Populate $self with options read from $psgi_or_handler
    # ...

    return $self;
}

sub log {
    my ( $self, $req, %fields ) = @_;

    # Your logging actions here. %fields is the structured
    # data from the logging context, which you can enrich with
    # data from the HTTP request ($req).
    # The "code" field generally contains an upper case event code such as
    # AUTHENTICATED or 2FA_REQUIRED

    # my $code = $fields{code};
    # ...
};

1;

Logs

Presentation

User log samples

Default loggers

Log levels

Technical log levels

Log levels for user actions

Logger configuration

Std logger

Apache2 logger

Syslog

Log4perl

Loki

Sentry

Dispatch

Audit logs