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

NAME

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

DESCRIPTION

10       tlog-rec-session.conf is a JSON-format configuration file for tlog-rec-
11       session program.  Contrary to the strict JSON specification, both C and
12       C++ style comments 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-session in other ways: through environment  vari‐
18       ables or command line.
19
20

OBJECTS AND FIELDS

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

EXAMPLES

152       A configuration specifying only a shell:
153
154              {
155                  "shell": "/usr/bin/zsh"
156              }
157
158
159       A configuration enabling logging user input:
160
161              {
162                  "log": {
163                      "input": true
164                  }
165              }
166
167
168       A configuration specifying logging to a file:
169
170              {
171                  "writer": "file"
172                  "file" : {
173                      "path": "/var/log/tlog-rec-session.log"
174                  }
175              }
176
177

SEE ALSO

179       tlog-rec-session(8), http://json.org/
180
181

AUTHOR

183       Nikolai Kondrashov <spbnick@gmail.com>
184
185
186
187Tlog                             February 2016        tlog-rec-session.conf(5)