BuzzSaw::Cmd::Import - BuzzSaw log entry importer application
This documentation refers to BuzzSaw::Cmd::Import version 0.10.3
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
% buzzsaw import [--readall] [--configfile buzzsaw_import.yaml]
This module extends the BuzzSaw::Cmd class to provide a command-line application which can be used to import new log entries. This module provides a light-weight wrapper around the BuzzSaw::Importer 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.
This module has two attributes which are both accessible as command-line options.
This is a string which specifies the name of the configuration file to use when loading the BuzzSaw::Importer object. The default file is /etc/buzzsaw/importer.yaml, you only need to specify this option if you want to use an alternative file.
/etc/buzzsaw/importer.yaml
This is a boolean value which controls whether to read all available sources (no matter whether or not they have been previously examined). The default is false.
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.
This method loads the new BuzzSaw::Importer 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 import_events method which does the real work.
new_with_config
import_events
This module is powered by Moose. You will also need MooseX::Types and MooseX::App::Cmd
BuzzSaw, BuzzSaw::Cmd, BuzzSaw::Importer, MooseX::App::Cmd::Command, App::Cmd::Command, MooseX::Getopt
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
Please report any bugs or problems (or praise!) to bugs@lcfg.org, feedback and patches are also always very welcome.
Stephen Quinney <squinney@inf.ed.ac.uk>
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.
To install BuzzSaw::DB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm BuzzSaw::DB
CPAN shell
perl -MCPAN -e shell install BuzzSaw::DB
For more information on module installation, please visit the detailed CPAN module installation guide.