NAME

BuzzSaw::Cmd::AnonymiseData - BuzzSaw data anonymiser

VERSION

This documentation refers to BuzzSaw::Cmd::AnonymiseData version 0.11.2

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 anonymisedata [--max_age='26 weeks'] [--dry-run] [--db db_conf.yaml]

DESCRIPTION

This module extends the BuzzSaw::Cmd class to provide a command-line application which can be used to anonymise old data. Given a maximum permitted age for the personal information (the default is 26 weeks) this tool will delete information in the raw, message and userid fields of the BuzzSaw event table. It will also delete all extra_info records associated with old events.

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

max_age

This is the maximum permitted age for records containing personal information. The default is 26 weeks, you can use anything which the PostgreSQL interval type supports (e.g. 190 days).

dry_run

If this option is enabled then the tool will not actually change anything in the database. It will just print out some information detailing what records would be altered.

db

This is a string which specifies the name of the configuration file to use when loading the BuzzSaw::DB object. The default file is /etc/buzzsaw/db_writer.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 uses the BuzzSaw::DB module to find all events older than the specified maximum age. Any events which are too old and have values for any of the raw, message or userid fields will be anonymised. Also any extra_info records associated with these old events will be deleted.

DEPENDENCIES

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

SEE ALSO

BuzzSaw, BuzzSaw::Cmd, BuzzSaw::DB, 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) 2013 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.