File: log-server.pod

package info (click to toggle)
remstats 1.00a4-8woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,576 kB
  • ctags: 1,020
  • sloc: perl: 11,706; ansic: 2,776; makefile: 944; sh: 869
file content (48 lines) | stat: -rw-r--r-- 1,538 bytes parent folder | download | duplicates (3)
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
=cut

TITLE=log-server
DESCRIPTION=the log-server makes summary information available to the collector machine
KEYWORDS=log-server,logs,server
DOCTOP=index
DOCPREV=servers
DOCNEXT=nt-status-server

=pod

=head1 log-server - providing remote access to log information

=head2 Usage:

=exec ../log-server -h 2>&1

The log-server must be supplied with at least one log-file
to serve.

=head2 Description:

The log-server is queried by the L<log-collector> using a
"protocol" described in the log-collector documentation.
It will provide information from any of the log-files on it's 
command-line, but no others.  It is recommended that you use
the tcp_wrappers or some other form of access-control to 
limit access to this server.  The information may or may not 
be sensitive, according to which log-files you are serving,
but letting anyone query it will mean that you will lose some
data, unless you're sure that they will only query it in test
mode.

The log-server will store context for each log-file
that is served, by default in C</var/tmp/log-server-XXX>,
where C<XXX> is replaced by a munged version of the log-file
name.  If you want this stored somewhere else, use the C<-p>
switch or change the program.

=head2 Notes:

Don't forget to list all the log-files that you want to serve on
the command-line.  If there are too many for your inetd, make a
tiny shell script with the C<log-server> invocation and run that
from inetd.

For details on installation, you'd better look at the 
L<server installation docs|install-servers>.