1tlog-rec.conf(5)              File Formats Manual             tlog-rec.conf(5)
2
3
4

NAME

6       tlog-rec.conf - tlog-rec configuration file
7
8

DESCRIPTION

10       tlog-rec.conf is a JSON-format configuration file for tlog-rec program.
11       Contrary to the strict JSON specification, both C and  C++  style  com‐
12       ments are allowed in the file.
13
14       The  file must contain a single JSON object with the objects and fields
15       described below.  Almost all of them are optional and assume a  default
16       value.  However, those that do require a value can still be omitted and
17       specified to tlog-rec in other ways: through environment  variables  or
18       command line.
19
20

OBJECTS AND FIELDS

22   Root object
23       latency (integer)
24              The number of seconds to cache captured data for before logging.
25              The encoded data which does not reach payload size stays in mem‐
26              ory and is not logged until this number of seconds elapses.
27
28              Minimum: 1
29              Default: 10
30
31       payload (integer)
32              The  maximum encoded data (payload) size per message, bytes.  As
33              soon as payload exceeds this number of bytes,  it  is  formatted
34              into a message and logged.
35
36              Minimum: 32
37              Default: 2048
38
39       log (object)
40              Logged data set object, see below.
41
42       limit (object)
43              Logging limit object, see below.
44
45       file (object)
46              File writer object, see below.
47
48       syslog (object)
49              Syslog writer object, see below.
50
51       journal (object)
52              Journal writer object, see below.
53
54       writer (string)
55              The type of "log writer" to use for logging. The writer needs to
56              be configured using its dedicated parameters.
57
58              One of: "journal", "syslog", "file"
59              Default: "file"
60
61   log - Logged data set object
62       input (boolean)
63              If true, user input is logged.
64
65              Default: false
66
67       output (boolean)
68              If true, terminal output is logged.
69
70              Default: true
71
72       window (boolean)
73              If true, terminal window size changes are logged.
74
75              Default: true
76
77   limit - Logging limit object
78       rate (integer)
79              The maximum rate messages could be logged at, bytes/sec.
80
81              Minimum: 0
82              Default: 16384
83
84       burst (integer)
85              The number of bytes by which  logged  messages  are  allowed  to
86              exceed the rate limit momentarily, i.e. "burstiness".
87
88              Minimum: 0
89              Default: 32768
90
91       action (string)
92              The  logging  limit  action.  If set to "pass" no logging limits
93              will be applied.  If set to "delay", logging will be  throttled.
94              If set to "drop", messages exceeding limits will be dropped.
95
96              One of: "pass", "delay", "drop"
97              Default: "pass"
98
99   file - File writer object
100       path (string)
101              The "file" writer log file path.
102
103              No default.
104
105   syslog - Syslog writer object
106       facility (string)
107              The syslog facility "syslog" writer should use for messages.
108
109              One  of:  "auth",  "authpriv",  "cron", "daemon", "ftp", "kern",
110              "local0",  "local1",  "local2",  "local3",  "local4",  "local5",
111              "local6",  "local7",  "lpr",  "mail",  "news", "syslog", "user",
112              "uucp"
113              Default: "authpriv"
114
115       priority (string)
116              The syslog priority "syslog" writer should use for messages.
117
118              One of: "emerg", "alert", "crit",  "err",  "warning",  "notice",
119              "info", "debug"
120              Default: "info"
121
122   journal - Journal writer object
123       priority (string)
124              The  syslog-style  priority "journal" writer should use for mes‐
125              sages.
126
127              One of: "emerg", "alert", "crit",  "err",  "warning",  "notice",
128              "info", "debug"
129              Default: "info"
130
131       augment (boolean)
132              If  true,  the "journal" writer copies the following JSON fields
133              to Journal fields: user -> TLOG_USER, session  ->  TLOG_SESSION,
134              rec -> TLOG_REC, and id -> TLOG_ID.
135
136              Default: true
137
138

EXAMPLES

140       A configuration specifying only a reduced latency:
141
142              {
143                  "latency": 3
144              }
145
146
147       A configuration enabling logging user input:
148
149              {
150                  "log": {
151                      "input": true
152                  }
153              }
154
155
156       A configuration specifying logging to a file:
157
158              {
159                  "writer": "file"
160                  "file" : {
161                      "path": "/var/log/tlog-rec.log"
162                  }
163              }
164
165

SEE ALSO

167       tlog-rec(8), http://json.org/
168
169

AUTHOR

171       Nikolai Kondrashov <spbnick@gmail.com>
172
173
174
175Tlog                               May 2017                   tlog-rec.conf(5)
Impressum