view release on metacpan or  search on metacpan

lib/App/Spoor.pm  view on Meta::CPAN

package App::Spoor;

use v5.10;
use strict;
use warnings;

=head1 NAME

App::Spoor - A CPanel client for the Spoor service

=head1 VERSION

Version 0.08

=cut

our $VERSION = '0.08';

=head1 SYNOPSIS

This module (for now) only contains code to provide a naive implementation of a client for the
Spoor API that plays nicely with CPanel.

It is built with the following principles in mind:

=over

=item * Minimise the impact of the code on the existing CPanel instance

=item * Minimise the footprint on the host, by keeping the dependencies to a bare minimum

=item * Be as transparent as possible about the data that is being submitted

=back

Within the above context, App::Spoor consists of 3 main parts:

=over

=item * Scripts running under systemd that tail the CPanel access, error and login logs

=item * A transmitter script (also running under systemd) that communicates with the Spoor API

=item * A module that registers functionality for tracking changes to mail forwarding within the CPanel standardised hook framework

=back

=head2 Installing

Before installing the module, you will need to enable the logging of successful logins via WHM. At the time of writing,
this can be found by navigating to Server Configuration -> Tweak Settings -> Logging.

Once you have installed the module run the following from the commandline:

    spoor_installer

It will setup a config file, some persistence directories, a number of systemd unit files and it will also create the
file that will register functionality against CPanel's standardised hooks.

Once it has completed, it will list a number of actions that must be performed (as root)before the installation is complete:

    systemctl enable spoor-access-follower.service
    systemctl enable spoor-error-follower.service
    systemctl enable spoor-login-follower.service
    systemctl enable spoor-transmitter.service
    systemctl start spoor-access-follower.service
    systemctl start spoor-error-follower.service
    systemctl start spoor-login-follower.service
    systemctl start spoor-transmitter.service
    cd /usr/local/cpanel/bin/
    ./manage_hooks add module SpoorForwardHook

The install script will create a number of directories, a config file for Spoor as well as several systemd unit files. 

=head2 Operation

App::Spoor operates on a simple principe of tailing CPanel's access, error and login log files. The follower services 
monitor the log files and if they come across an item of interest, they create a JSON-representation of the event and
write it to /var/lib/spoor/parsed.

The transmitter service monitors /var/lib/spoor/parsed for any changes and sends these to the Spoor API. If a transmission 
recives a response of HTTP 202, the JSON file is moved to /var/lib/spoor/transmitted, otherwise it remains in /var/lib/spoor/parsed and
the transmitter will keep on retrying, pretty much until the end of time.

=head2 Reporting

Spoor provides rudimentary reporting functionality that can be accessed from the commandline. This functionality 
distinguished between reports (a report is created by the Spoor API when data is received) and mailbox events ( a
mailbox event is created once the report has been parsed).

    spoor_report_list #List the most recent reports for the current host
    spoor_mailbox_event_list #List the most recent mailbox events for the current host