source: xas-logmon/trunk/lib/XAS/Logmon.pm @ e9bcbcd5e0719133b211cebfcb6227915caf28b5

Revision e9bcbcd5e0719133b211cebfcb6227915caf28b5, 3.0 KB checked in by Kevin L. Esteb <kevin@…>, 3 years ago (diff)

updating documentation

  • Property mode set to 100644
Line 
1package XAS::Logmon;
2
3use strict;
4use warnings;
5
6our $VERSION = '0.01';
7
81;
9
10__END__
11 
12=head1 NAME
13
14XAS::Logmon - A set of procedures and modules to monitor files
15
16=head1 DESCRIPTION
17
18Monitoring and extracting information from log files is an important task.
19There is important operational data stored in those files. They detail the
20state of your operations. These modules would compliment a centralized syslog
21gathering operationation. Even thou XAS can write to syslog or create JSON
22formatted log messages and spool them directly, these modules provide a
23framework that can be expanded to include other types of files.
24
25The design of this system is a monitoring process that spawns background jobs
26that do the actual work. Those background jobs are kept alive when file states
27change, such as file rotation or new file creation.
28
29A multi-process system is simpler to design and keep alive. It follows the XAS
30philosophy of small, simple components, that do one thing well.
31
32=head1 UTILITIES
33
34This module provides the following utilities.
35
36=head2 xas-logmon
37
38This is procedure is used to spawn and monitor file monitoring processes. It
39reads a configuration file to determine which files to monitor.
40
41The configuration file is documented here: L<XAS::Apps::Logmon::Monitor|XAS::Apps::Logmon::Monitor>
42
43=over 4
44
45=item B<xas-logmon --help>
46
47This will display a brief help screen on command options.
48
49=item B<xas-logmon --manual>
50
51This will display the utilities man page.
52
53=back
54
55=head2 xas-logs
56
57This procedure monitors XAS log files. It parses them and sends the results
58to a spool directory.
59
60=over 4
61
62=item xas-logs --help
63
64This will display a brief help screen on command options.
65
66=item xas-logs --manual
67
68This will display the utilities man page.
69
70=back
71
72=head1 SEE ALSO
73
74=over 4
75
76=item L<XAS::Docs::Logmon::Installation|XAS::Docs::Logmon::Installation>
77
78=item L<XAS::Apps::Logmon::Monitor|XAS::Apps::Logmon::Monitor>
79
80=item L<XAS::Apps::Logmon::XAS::Process|XAS::Apps::Logmon::XAS::Process>
81
82=item L<XAS::Lib::Regexp::Log::XAS|XAS::Lib::Regexp::Log::XAS>
83
84=item L<XAS::Logmon::Filter::Merge|XAS::Logmon::Filter::Merge>
85
86=item L<XAS::Logmon::Format::Logstash|XAS::Logmon::Format::Logstash>
87
88=item L<XAS::Logmon::Input::File|XAS::Logmon::Input::File>
89
90=item L<XAS::Logmon::Input::Tail|XAS::Logmon::Input::Tail>
91
92=item L<XAS::Logmon::Input::Tail::Default|XAS::Logmon::Input::Tail::Default>
93
94=item L<XAS::Logmon::Input::Tail::Linux|XAS::Logmon::Input::Tail::Linux>
95
96=item L<XAS::Logmon::Input::Tail::Win32|XAS::Logmon::Input::Tail::Win32>
97
98=item L<XAS::Logmon::Output::Spool|XAS::Logmon::Output::Spool>
99
100=item L<XAS::Logmon::Parser::XAS::Logs|XAS::Logmon::Parser::XAS::Logs>
101
102=item L<XAS|XAS>
103
104=back
105
106=head1 AUTHOR
107
108Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt>
109
110=head1 COPYRIGHT AND LICENSE
111
112Copyright (c) 2012-2015 Kevin L. Esteb
113
114This is free software; you can redistribute it and/or modify it under
115the terms of the Artistic License 2.0. For details, see the full text
116of the license at http://www.perlfoundation.org/artistic_license_2_0.
117
118=cut
Note: See TracBrowser for help on using the repository browser.