| 1 | package XAS::Collector; | ||
| 2 | |||
| 3 | 1 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | |||
| 6 | 1 | our $VERSION = '0.03'; | |
| 7 | |||
| 8 | 1 | 1; | |
| 9 | |||
| 10 | __END__ | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | XAS::Collector - A set of procedures and modules to retrieve messages and store the results | ||
| 15 | |||
| 16 | =head1 DESCRIPTION | ||
| 17 | |||
| 18 | The collector is the end point of a message queue. L<XAS::Spooler|XAS::Spooler> | ||
| 19 | places messages in the queue and the collector removes those messages and | ||
| 20 | process them. This process is configuration driven. A XAS message type is | ||
| 21 | associated with a queue. A processor is used to process each message type. | ||
| 22 | What happens to that message depends on the processor. Currently there are | ||
| 23 | processors for SQL Databases, Logstash and OpenTSDB data stores. | ||
| 24 | |||
| 25 | The configuration file is documented here: L<XAS::Apps::Collector::Process|XAS::Apps::Collector::Process> | ||
| 26 | |||
| 27 | =head1 UTILITIES | ||
| 28 | |||
| 29 | =head2 xas-collector | ||
| 30 | |||
| 31 | This is the collector procedure. It runs as a service and processes messages | ||
| 32 | based on a configuration file. | ||
| 33 | |||
| 34 | =over 4 | ||
| 35 | |||
| 36 | =item B<xas-collector --help> | ||
| 37 | |||
| 38 | This will display a brief help screen on command options. | ||
| 39 | |||
| 40 | =item B<xas-collector --manual> | ||
| 41 | |||
| 42 | This will display the utilities man page. | ||
| 43 | |||
| 44 | =back | ||
| 45 | |||
| 46 | =head1 SEE ALSO | ||
| 47 | |||
| 48 | =over 4 | ||
| 49 | |||
| 50 | =item L<XAS::Apps::Collector::Process|XAS::Apps::Collector::Process> | ||
| 51 | |||
| 52 | =item L<XAS::Collector::Format::Base|XAS::Collector::Format::Base> | ||
| 53 | |||
| 54 | =item L<XAS::Collector::Format::Alerts|XAS::Collector::Format::Alerts> | ||
| 55 | |||
| 56 | =item L<XAS::Collector::Format::Logs|XAS::Collector::Format::Logs> | ||
| 57 | |||
| 58 | =item L<XAS::Collector::Input::Stomp|XAS::Collector::Input::Stomp> | ||
| 59 | |||
| 60 | =item L<XAS::Collector::Output::Console::Base|XAS::Collector::Output::Console::Base> | ||
| 61 | |||
| 62 | =item L<XAS::Collector::Output::Console::Alerts|XAS::Collector::Output::Console::Alerts> | ||
| 63 | |||
| 64 | =item L<XAS::Collector::Output::Console::Logs|XAS::Collector::Output::Console::Logs> | ||
| 65 | |||
| 66 | =item L<XAS::Collector::Output::Database::Base|XAS::Collector::Output::Database::Base> | ||
| 67 | |||
| 68 | =item L<XAS::Collector::Output::Database::Alerts|XAS::Collector::Output::Database::Alerts> | ||
| 69 | |||
| 70 | =item L<XAS::Collector::Output::Database::Logs|XAS::Collector::Output::Database::Logs> | ||
| 71 | |||
| 72 | =item L<XAS::Collector::Output::Socket::Base|XAS::Collector::Output::Socket::Base> | ||
| 73 | |||
| 74 | =item L<XAS::Collector::Output::Socket::Logstash|XAS::Collector::Output::Socket::Logstash> | ||
| 75 | |||
| 76 | =item L<XAS::Collector::Output::Socket::OpenTSDB|XAS::Collector::Output::Socket::OpenTSDB> | ||
| 77 | |||
| 78 | =item L<XAS::Model::Database::Messaging::Result::Alert|XAS::Model::Database::Messaging::Alert> | ||
| 79 | |||
| 80 | =item L<XAS::Model::Database::Messaging::Result::Log|XAS::Model::Database::Messaging::Result::Log> | ||
| 81 | |||
| 82 | =item L<XAS|XAS> | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | =head1 AUTHOR | ||
| 87 | |||
| 88 | Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt> | ||
| 89 | |||
| 90 | =head1 LICENSE AND COPYRIGHT | ||
| 91 | |||
| 92 | Copyright (c) 2012-2015 Kevin L. Esteb | ||
| 93 | |||
| 94 | This is free software; you can redistribute it and/or modify it under | ||
| 95 | the terms of the Artistic License 2.0. For details, see the full text | ||
| 96 | of the license at http://www.perlfoundation.org/artistic_license_2_0. | ||
| 97 | |||
| 98 | =cut | ||