Stephen Quinney > BuzzSaw-0.12.0 > BuzzSaw::Cmd::Report

Download:
BuzzSaw-0.12.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.12.0   Source  

NAME ^

BuzzSaw::Cmd::Report - BuzzSaw report generator

VERSION ^

This documentation refers to BuzzSaw::Cmd::Report version 0.12.0

SYNOPSIS ^

This module is not designed to be used directly. It is used by App::BuzzSaw to provide a buzzsaw command-line application. The command-line application works like:

% buzzsaw report [--configfile buzzsaw_report.yaml]

DESCRIPTION ^

This module extends the BuzzSaw::Cmd class to provide a command-line application which can be used to generate reports on collected events. This module provides a light-weight wrapper around the BuzzSaw:Reporter module which is what does the actual data processing.

The BuzzSaw project provides a suite of tools for processing log file entries. Entries in files are parsed and filtered into a set of events of interest which are stored in a database. A report generation framework is also available which makes it easy to generate regular reports regarding the events discovered.

ATTRIBUTES ^

This module has one attribute which is accessible as a command-line option.

configfile

This is a string which specifies the name of the configuration file to use when loading the BuzzSaw::Reporter object. The default file is /etc/buzzsaw/reporter.yaml, you only need to specify this option if you want to use an alternative file.

SUBROUTINES/METHODS ^

abstract

This method may be used to return a short string which describes the purpose of the application. The abstract is used when auto-generating help messages.

execute

This method loads the new BuzzSaw::Reporter object using the new_with_config method. It provides the ability to override the values of the attributes which are accessible as command-line options. It then calls the generate_reports method which does the real work.

DEPENDENCIES ^

This module is powered by Moose. You will also need MooseX::Types and MooseX::App::Cmd

SEE ALSO ^

BuzzSaw, BuzzSaw::Cmd, BuzzSaw::Reporter, BuzzSaw::Report, MooseX::App::Cmd::Command, App::Cmd::Command, MooseX::Getopt

PLATFORMS ^

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

ScientificLinux6

BUGS AND LIMITATIONS ^

Please report any bugs or problems (or praise!) to bugs@lcfg.org, feedback and patches are also always very welcome.

AUTHOR ^

    Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT ^

    Copyright (C) 2012 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.

syntax highlighting: