NAME

Mojolicious::Plugin::Log::Access - Provide access logging

SYNOPSIS

  # Mojolicious
  $self->plugin('Log::Access');

  # Mojolicious::Lite
  plugin 'Log::Access';

DESCRIPTION

Mojolicious::Plugin::Log::Access is a Mojolicious plugin for adding access logging to your web application.

USAGE

Simply add the plugin as shown above. Whenever the app is in log levels 'debug' or 'info', it will log each page access as an 'info' message.

Alternatively, if you only want info-level access logging when in 'production' mode, you can restrict the plugin for only that mode.

  sub startup {
    my $self = shift;
    $self->plugin('Log::Access') if $self->mode eq 'production';

Currently the log entry format is hard-coded.

  [info] <ip address> <page> <status code>

TIMESTAMPS

If you want custom timestamps (irrespective of access logging) this plugin combines seamlessly with Mojar::Log.

  # Mojolicious
  use Mojar::Log;
  $self->plugin('Log::Access');
  $self->log(Mojar::Log->new(pattern => '%y%m%d %X'));

  # Mojolicious::Lite
  use Mojar::Log;
  plugin 'Log::Access';
  app->log(Mojar::Log->new(pattern => '%y%m%d %X'));

This is illustrated in test/99-play.pl.

METHODS

Mojolicious::Plugin::Log::Access inherits all methods from Mojolicious::Plugin.

register

  $plugin->register(Mojolicious->new);

Register plugin in Mojolicious application.

RATIONALE

It is fairly typical that in a production environment web apps will run in 'production' mode and use a log level of 'info'. Often the administrators will expect page hits to be logged in a similar style to the likes of apache and nginx, showing ip address and resulting status code.

This solves an unrelated problem for me. Sometimes when migrating legacy css or js, it is important to monitor and catch all 404s; these indicate migration work yet unfinished. It can be difficult to see them at log level 'debug'.

Sebastian suggested using an after_dispatch hook in a plugin, so here it is. When needing to solve the second problem I can develop in log level 'info' since production-style access logging is exactly what I need.

COPYRIGHT AND LICENSE

Everything here (incl tools and ideas) was provided by Sebastian Riedel. It was packaged by Nic Sandfield.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

SEE ALSO

Mojar::Log, Mojolicious, Mojolicious::Guides, http://mojolicio.us.