summaryrefslogtreecommitdiff
path: root/docs/guprecords.pod
blob: d060e11f561c1776e10140d30a726aecd1f4840e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
=head1 NAME

guprecords - Global uptime records

Shows uprecord stats of several hosts at once.

=head2 Synopsis

guprecords [--help] [--total|--all] [--count=i] [--indir=s]

=head2 Parameters

=over

=item --all

Shows every individual uptime of all hosts.

=item --count=i

Show i num of entries. Default is 23.

=item --nofqdn

Don't display the FQDNs

=item --help

Shows the help

=item --indir=s

Read all the *.records files from dir s. Default is ./

=item --total

Aggregates a total uptime for every single host.

=back


=head2 Quick getting started

=head3 Uptimed

Firstival, you need to collect uprecords using the uptimed deaemon. To install it run:

    sudo aptitude install uptimed

Please consult the L<uptimed> and L<uprecords> manpages. Please ensure to understand how it works and what it does.

uptimed collects uprecords to 

  /var/spool/uptimed/records

And this file is used by guprecords for further processing.

=head3 Collect all the uprecords

You may have several hosts with uptimed running already. Collect all the records file to a central repository (e.g. git).  Name each file FQDN.records and run

  guprecords --indir ./

You may automate the collecting of all the uprecords using something like cron or puppet.

=head1 LICENSE

See package description or project website.

=head1 AUTHOR

Paul Buetow - <http://guprecords.buetow.org>

=cut