Matt Simerson > RTG-Report-1.17 > RTG::Report

Download:
RTG-Report-1.17.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.17   Source  

NAME ^

RTG::Report - RTG reporting and data processing utilities

VERSION ^

1.16

SYNOPSIS ^

Functions shared by the RTG::Report utilities.

FUNCTIONS ^

new

instantiate a new RTG::Report object

formatted_header

generates a CSV file header. The fields are dynamically generated based on the contents of rtgreport.conf.

get_interface_stats

This is the heart of RTGs data reporting. This function:

 * queries the SQL data store, fetching the interface counters for the selected
  interface during the specified reporting period. 
 * sorts the records cronologically
 * iterates over each record, performing calculations on the raw numbers
 * finally, calculating the 95th average rates for the period
 * returns a hashref with bytes transferred, peak rate, average rate, and 95th

get_the_date

returns an array with year, month, day, hours, min, and seconds as scalars

is_arrayref

tests is the argument passed in is an arrayref. Returns true or undef.

should_i_skip_it

Interfaces can be ignored based on their name or description. Great examples of interfaces you might wan to ignore for reporting purposes would be VLAN or port-channel interfaces. This sub chooses which interfaces to ignore based on your settings in rtgreport.conf.

status

prints status functions

timestamp_sanity

runs a few tests to make sure the data we are processing is consistent.

AUTHOR ^

Matt Simerson <msimerson@cpan.org>

LICENSE AND COPYRIGHT ^

Copyright (c) 2008 Layered Technologies, Inc. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

syntax highlighting: