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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
.TH TALLYMAN 1 "August 13, 2019" "TALLYMAN" "Tallyman User Reference"
.SH NAME
tallyman \- health state collector for docker containers
.SH SYNOPSIS
.na
.nh
\fBtallyman\fR\
[\fB\-dq\fR]\
[\fB\-h\fR \fINAME\fR]\
[\fB\-s\fR \fIHOST:PORT\fR]\
[\fB\-v\fR \fIJSON\fR]\
[\fB\-\-connection\-timeout=\fISECONDS\fR]\
[\fB\-\-debug\fR]\
[\fB\-\-execution\-timeout=\fISECONDS\fR]\
[\fB\-\-hostname=\fINAME\fR]\
[\fB\-\-quiet\fR]\
[\fB\-\-server=\fIHOST:PORT\fR]\
[\fB\-\-value=\fIJSON\fR]\
\fISRVID\fR\
\fICOMMAND\fR\
\fIARGS\fR...
.sp
\fBtallyman\fR\
\fB\-?\fR |\
\fB\-\-help\fR |\
\fB\-V\fR |\
\fB\-\-version\fR
.ad
.hy
.SH DESCRIPTION
Runs \fICOMMAND\fR with \fIARGS\fR and sends its return code, standard
output and error to the remote data collector. Exits with the exit
status of \fICOMMAND\fR.
.PP
The program must be configured to run periodically via the
.B HEALTHCHECK CMD
statement in the
.BR Dockerfile .
.PP
The data collector program
.BR stevedore (8)
must be listening at \fIHOST:PORT\fR. See its manual for
details. Container default gateway is the default \fIHOST\fR.
Default port is 8990.
.SH OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Increase debug verbosity.
.TP
\fB\-h\fR, \fB\-\-hostname=\fINAME\fR
Set this server hostname. By default it is determined automatically.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
By default, \fBtallyman\fR would transparently pass \fICOMMAND\fR's
stdout and stderr to the corresponding streams. Single \fB\-q\fR
option suppresses reproducing the stdout. Two \fB\-q\fR options
suppress both stdout and stderr.
.TP
\fB\-s\fR, \fB\-\-server=\fIHOST:PORT\fR
Address and port of the data collector. Default is \fIGW\fR:8990,
where \fIGW\fR is the default gateway of the container.
.TP
\fB\-v\fR, \fB\-\-value=\fIJSON\fR
Add \fIJSON\fR object to each report.
.TP
\fB\-\-connection\-timeout=\fISECONDS\fR
Set timeout for initial connection to the collector. Default is 5 seconds.
.TP
\fB\-\-execution\-timeout=\fISECONDS\fR
Set \fICOMMAND\fR execution timeout. Default is 5 seconds.
.TP
\fB\-?\fR, \fB\-\-help\fR
Display short help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display program version and licensing information and exit.
.SH "SEE ALSO"
.BR stevedore (8).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <gray@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2018\-2019 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end:
|
