Code Coverage: vinyl-cache/include/tbl/vsl_tags.h
 
82217aa4fc7094b3610340078afaf78cd95a8ec9
 
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2015 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 *
30
 * Define the tags in the shared memory in a reusable format.
31
 * Whoever includes this get to define what the SLTM macro does.
32
 *
33
 * REMEMBER to update the documentation (especially the vinyllog(1) man
34
 * page) whenever this list changes.
35
 *
36
 * XXX: Please add new entries at the end to not break saved log-segments.
37
 *
38
 * Arguments:
39
 *      Tag-Name
40
 *      Flags
41
 *      Short Description (1 line, max ? chars)
42
 *      Long Description (in RST "definition list" format)
43
 */
44
45
/*lint -save -e525 -e539 */
46
47 1
#define NODEF_NOTICE \
48 1
    "NB: This log record is masked by default, see ``vsl_mask`` parameter.\n\n"
49
50
/*
51
 * REL_20190915 remove after VSLng
52
 * kept for now for VSL binary compatibility
53
 */
54 1
#define NOSUP_NOTICE \
55 1
    "NOTE: This tag is currently not in use in the Vinyl Cache log.\n" \
56 1
    "It is mentioned here to document legacy versions of the log,\n" \
57 1
    "or reserved for possible use in future versions.\n\n"
58
59 1
SLTM(Debug, SLT_F_UNSAFE, "Debug messages",
60 1
        "Debug messages can normally be ignored, but are sometimes"
61 1
        " helpful during trouble-shooting.  Most debug messages must"
62 1
        " be explicitly enabled with parameters.\n\n"
63 1
        "Debug messages may be added, changed or removed without"
64 1
        " prior notice and shouldn't be considered stable.\n\n"
65 1
        NODEF_NOTICE
66 1
)
67
68 1
SLTM(Error, 0, "Error messages",
69 1
        "Error messages are stuff you probably want to know.\n\n"
70 1
)
71
72 1
SLTM(CLI, 0, "CLI communication",
73 1
        "CLI communication between vinyld master and child process.\n\n"
74 1
)
75
76
/*---------------------------------------------------------------------*/
77
78 1
SLTM(SessOpen, 0, "Client connection opened",
79 1
        "The first record for a client connection, with the socket-endpoints"
80 1
        " of the connection.\n\n"
81 1
        "The format is::\n\n"
82 1
        "\t%s %d %s %s %s %f %d\n"
83 1
        "\t|  |  |  |  |  |  |\n"
84 1
        "\t|  |  |  |  |  |  +- File descriptor number\n"
85 1
        "\t|  |  |  |  |  +---- Session start time (unix epoch)\n"
86 1
        "\t|  |  |  |  +------- Local TCP port / 0 for UDS\n"
87 1
        "\t|  |  |  +---------- Local IPv4/6 address / 0.0.0.0 for UDS\n"
88 1
        "\t|  |  +------------- Socket name (from -a argument)\n"
89 1
        "\t|  +---------------- Remote TCP port / 0 for UDS\n"
90 1
        "\t+------------------- Remote IPv4/6 address / 0.0.0.0 for UDS\n"
91 1
        "\n"
92 1
)
93
/*
94
 * XXX generate the list of SC_* reasons:
95
 *
96
 * #include <stdio.h>
97
 * int main(void) {
98
 * #define SESS_CLOSE(e, sc, err, desc)                 \
99
 *      printf("\t\"\\t* ``%s``: %s\\n\"\n", #e, desc);
100
 * #include "include/tbl/sess_close.h"
101
 *      return (0);
102
 * }
103
 */
104
105 1
SLTM(SessClose, 0, "Client connection closed",
106 1
        "SessClose is the last record for any client connection.\n\n"
107 1
        "The format is::\n\n"
108 1
        "\t%s %f\n"
109 1
        "\t|  |\n"
110 1
        "\t|  +- How long the session was open\n"
111 1
        "\t+---- Why the connection closed\n"
112 1
        "\nExplanation of reasons (first column):\n"
113 1
        "\t* ``REM_CLOSE``: Client Closed\n"
114 1
        "\t* ``REQ_CLOSE``: Client requested close\n"
115 1
        "\t* ``REQ_HTTP10``: Proto < HTTP/1.1\n"
116 1
        "\t* ``RX_BAD``: Received bad req/resp\n"
117 1
        "\t* ``RX_BODY``: Failure receiving body\n"
118 1
        "\t* ``RX_JUNK``: Received junk data\n"
119 1
        "\t* ``RX_OVERFLOW``: Received buffer overflow\n"
120 1
        "\t* ``RX_TIMEOUT``: Receive timeout\n"
121 1
        "\t* ``RX_CLOSE_IDLE``: timeout_idle reached\n"
122 1
        "\t* ``TX_PIPE``: Piped transaction\n"
123 1
        "\t* ``TX_ERROR``: Error transaction\n"
124 1
        "\t* ``TX_EOF``: EOF transmission\n"
125 1
        "\t* ``RESP_CLOSE``: Backend/VCL requested close\n"
126 1
        "\t* ``OVERLOAD``: Out of some resource\n"
127 1
        "\t* ``PIPE_OVERFLOW``: Session pipe overflow\n"
128 1
        "\t* ``RANGE_SHORT``: Insufficient data for range\n"
129 1
        "\t* ``REQ_HTTP20``: HTTP2 not accepted\n"
130 1
        "\t* ``VCL_FAILURE``: VCL failure\n"
131 1
        "\t* ``RAPID_RESET``: HTTP2 rapid reset\n"
132 1
        "\n"
133 1
)
134
135
/*---------------------------------------------------------------------*/
136
137 1
SLTM(BackendOpen, 0, "Backend connection opened",
138 1
        "Logged when a new backend connection is opened.\n\n"
139 1
        "The format is::\n\n"
140 1
        "\t%d %s %s %s %s %s %s [ %f %ld ]\n"
141 1
        "\t|  |  |  |  |  |  |    |  |\n"
142 1
        "\t|  |  |  |  |  |  |    |  +--- Connection reuses\n"
143 1
        "\t|  |  |  |  |  |  |    +------ Connection age\n"
144 1
        "\t|  |  |  |  |  |  +----------- \"connect\" or \"reuse\"\n"
145 1
        "\t|  |  |  |  |  +-------------- Local port\n"
146 1
        "\t|  |  |  |  +----------------- Local address\n"
147 1
        "\t|  |  |  +-------------------- Remote port\n"
148 1
        "\t|  |  +----------------------- Remote address\n"
149 1
        "\t|  +-------------------------- Backend display name\n"
150 1
        "\t+----------------------------- Connection file descriptor\n"
151 1
        "\n"
152 1
)
153
154 1
SLTM(BackendClose, 0, "Backend connection closed",
155 1
        "Logged when a backend connection is closed.\n\n"
156 1
        "The format is::\n\n"
157 1
        "\t%d %s %s [ %s ]\n"
158 1
        "\t|  |  |    |\n"
159 1
        "\t|  |  |    +- Optional reason, see SessClose for explanation\n"
160 1
        "\t|  |  +------ \"close\" or \"recycle\"\n"
161 1
        "\t|  +--------- Backend display name\n"
162 1
        "\t+------------ Connection file descriptor\n"
163 1
        "\n"
164 1
)
165
166 1
SLTM(HttpGarbage, SLT_F_UNSAFE, "Unparseable HTTP request",
167 1
        "Logs the content of unparseable HTTP requests.\n\n"
168 1
)
169
170 1
SLTM(Proxy, 0, "PROXY protocol information",
171 1
        "PROXY protocol information.\n\n"
172 1
        "The format is::\n\n"
173 1
        "\t%d %s %d %s %d\n"
174 1
        "\t|  |  |  |  |\n"
175 1
        "\t|  |  |  |  +- server port\n"
176 1
        "\t|  |  |  +---- server ip\n"
177 1
        "\t|  |  +------- client port\n"
178 1
        "\t|  +---------- client ip\n"
179 1
        "\t+------------- PROXY protocol version\n"
180 1
        "\t\n"
181 1
        "\tAll fields are \"local\" for PROXY local connections (command 0x0)\n"
182 1
        "\n"
183 1
)
184
185 1
SLTM(ProxyGarbage, 0, "Unparseable PROXY request",
186 1
        "A PROXY protocol header was unparseable.\n\n"
187 1
)
188
189 1
SLTM(Length, 0, "Size of object body",
190 1
        "Logs the size of a fetch object body.\n\n"
191 1
)
192
193 1
SLTM(FetchError, 0, "Error while fetching object",
194 1
        "Logs the error message of a failed fetch operation.\n\n"
195 1
)
196
197 1
#define SLTH(tag, ind, req, resp, sdesc, ldesc) \
198 8
        SLTM(Req##tag, (req ? 0 : SLT_F_UNUSED), "Client request " sdesc, ldesc)
199 1
#include "tbl/vsl_tags_http.h"
200 1
#undef SLTH
201
202 1
#define SLTH(tag, ind, req, resp, sdesc, ldesc) \
203 8
        SLTM(Resp##tag, (resp ? 0 : SLT_F_UNUSED), "Client response " sdesc, \
204 8
            ldesc)
205 1
#include "tbl/vsl_tags_http.h"
206 1
#undef SLTH
207
208 1
#define SLTH(tag, ind, req, resp, sdesc, ldesc) \
209 8
        SLTM(Bereq##tag, (req ? 0 : SLT_F_UNUSED), "Backend request " sdesc, \
210 8
            ldesc)
211 1
#include "tbl/vsl_tags_http.h"
212 1
#undef SLTH
213
214 1
#define SLTH(tag, ind, req, resp, sdesc, ldesc) \
215 8
        SLTM(Beresp##tag, (resp ? 0 : SLT_F_UNUSED), "Backend response " \
216 8
            sdesc, ldesc)
217 1
#include "tbl/vsl_tags_http.h"
218 1
#undef SLTH
219
220 1
#define SLTH(tag, ind, req, resp, sdesc, ldesc) \
221 8
        SLTM(Obj##tag, (resp ? 0 : SLT_F_UNUSED), "Object " sdesc, ldesc)
222 1
#include "tbl/vsl_tags_http.h"
223 1
#undef SLTH
224
225 1
SLTM(BogoHeader, 0, "Bogus HTTP received",
226 1
        "Contains the first 20 characters of received HTTP headers we could"
227 1
        " not make sense of.  Applies to both req.http and beresp.http.\n\n"
228 1
)
229
230 1
SLTM(LostHeader, 0, "Failed attempt to set HTTP header",
231 1
        "Logs the header name of a failed HTTP header operation due to"
232 1
        " resource exhaustion or configured limits.\n\n"
233 1
)
234
235 1
SLTM(TTL, 0, "TTL set on object",
236 1
        "A TTL record is emitted whenever the ttl, grace or keep"
237 1
        " values for an object is set as well as whether the object is "
238 1
        " cacheable or not.\n\n"
239 1
        "The format is::\n\n"
240 1
        "\t%s %d %d %d %d [ %d %d %u %u ] %s\n"
241 1
        "\t|  |  |  |  |    |  |  |  |    |\n"
242 1
        "\t|  |  |  |  |    |  |  |  |    +- \"cacheable\" or \"uncacheable\"\n"
243 1
        "\t|  |  |  |  |    |  |  |  +------ Max-Age from Cache-Control header\n"
244 1
        "\t|  |  |  |  |    |  |  +--------- Expires header\n"
245 1
        "\t|  |  |  |  |    |  +------------ Date header\n"
246 1
        "\t|  |  |  |  |    +--------------- Age (incl Age: header value)\n"
247 1
        "\t|  |  |  |  +-------------------- Reference time for TTL\n"
248 1
        "\t|  |  |  +----------------------- Keep\n"
249 1
        "\t|  |  +-------------------------- Grace\n"
250 1
        "\t|  +----------------------------- TTL\n"
251 1
        "\t+-------------------------------- \"RFC\", \"VCL\" or \"HFP\"\n"
252 1
        "\n"
253 1
        "The four optional fields are only present in \"RFC\" headers.\n\n"
254 1
        "Examples::\n\n"
255 1
        "\tRFC 60 10 -1 1312966109 1312966109 1312966109 0 60 cacheable\n"
256 1
        "\tVCL 120 10 0 1312966111 uncacheable\n"
257 1
        "\tHFP 2 0 0 1312966113 uncacheable\n"
258 1
        "\n"
259 1
)
260
261 1
SLTM(Fetch_Body, 0, "Body fetched from backend",
262 1
        "Ready to fetch body from backend.\n\n"
263 1
        "The format is::\n\n"
264 1
        "\t%d %s %s\n"
265 1
        "\t|  |  |\n"
266 1
        "\t|  |  +---- 'stream' or '-'\n"
267 1
        "\t|  +------- Text description of body fetch mode\n"
268 1
        "\t+---------- Body fetch mode\n"
269 1
        "\n"
270 1
)
271
272 1
SLTM(VCL_acl, 0, "VCL ACL check results",
273 1
        "ACLs with the `+log` flag emits this record with the result.\n\n"
274 1
        "The format is::\n\n"
275 1
        "\t%s [%s [%s [fixed: %s]]]\n"
276 1
        "\t|   |   |          |\n"
277 1
        "\t|   |   |          +- Fix info (see below)\n"
278 1
        "\t|   |   +------------ Matching entry (only for MATCH)\n"
279 1
        "\t|   +---------------- Name of the ACL for MATCH or NO_MATCH\n"
280 1
        "\t+-------------------- MATCH, NO_MATCH or NO_FAM\n"
281 1
        "\n"
282 1
        "* Fix info: either contains network/mask for non-canonical entries "
283 1
        "(see acl +pedantic flag) or ``folded`` for entries "
284 1
        "which were the result of a fold operation (see acl +fold flag).\n"
285 1
        "* ``MATCH`` denotes an ACL match\n"
286 1
        "* ``NO_MATCH`` denotes that a checked ACL has not matched\n"
287 1
        "* ``NO_FAM`` denotes a missing address family and should not occur.\n"
288 1
        "\n"
289 1
)
290
291 1
SLTM(VCL_call, 0, "VCL method called",
292 1
        "Logs the VCL method name when a VCL method is called.\n\n"
293 1
)
294
295 1
SLTM(VCL_trace, 0, "VCL trace data",
296 1
        "Logs VCL execution trace data.\n\n"
297 1
        "The format is::\n\n"
298 1
        "\t%s %u %u.%u.%u\n"
299 1
        "\t|  |  |  |  |\n"
300 1
        "\t|  |  |  |  +- VCL program line position\n"
301 1
        "\t|  |  |  +---- VCL program line number\n"
302 1
        "\t|  |  +------- VCL program source index\n"
303 1
        "\t|  +---------- VCL trace point index\n"
304 1
        "\t+------------- VCL configname\n"
305 1
        "\n"
306 1
        NODEF_NOTICE
307 1
)
308
309 1
SLTM(VCL_return, 0, "VCL method return value",
310 1
        "Logs the VCL method terminating statement.\n\n"
311 1
)
312
313 1
SLTM(ReqStart, 0, "Client request start",
314 1
        "Start of request processing. Logs the client address, port number "
315 1
        " and listener endpoint name (from the -a command-line argument).\n\n"
316 1
        "The format is::\n\n"
317 1
        "\t%s %s %s\n"
318 1
        "\t|  |  |\n"
319 1
        "\t|  |  +-- Listener name (from -a)\n"
320 1
        "\t|  +----- Client Port number (0 for Unix domain sockets)\n"
321 1
        "\t+-------- Client IP4/6 address (0.0.0.0 for UDS)\n"
322 1
        "\n"
323 1
)
324
325 1
SLTM(Hit, 0, "Hit object in cache",
326 1
        "Object looked up in cache.\n\n"
327 1
        "The format is::\n\n"
328 1
        "\t%u %f %f %f [%u [%u]]\n"
329 1
        "\t|  |  |  |   |   |\n"
330 1
        "\t|  |  |  |   |   +- Content length\n"
331 1
        "\t|  |  |  |   +----- Fetched so far\n"
332 1
        "\t|  |  |  +--------- Keep period\n"
333 1
        "\t|  |  +------------ Grace period\n"
334 1
        "\t|  +--------------- Remaining TTL\n"
335 1
        "\t+------------------ VXID of the object\n"
336 1
        "\n"
337 1
)
338
339 1
SLTM(HitPass, 0, "Hit for pass object in cache.",
340 1
        "Hit-for-pass object looked up in cache.\n\n"
341 1
        "The format is::\n\n"
342 1
        "\t%u %f\n"
343 1
        "\t|  |\n"
344 1
        "\t|  +- Remaining TTL\n"
345 1
        "\t+---- VXID of the object\n"
346 1
        "\n"
347 1
)
348
349 1
SLTM(ExpBan, 0, "Object evicted due to ban",
350 1
        "Logs the VXID when an object is banned.\n\n"
351 1
)
352
353 1
SLTM(ExpKill, 0, "Object expiry event",
354 1
        "Logs events related to object expiry. The events are:\n\n"
355 1
        "EXP_Rearm\n"
356 1
        "\tLogged when the expiry time of an object changes.\n\n"
357 1
        "EXP_Inbox\n"
358 1
        "\tLogged when the expiry thread picks an object from the inbox for"
359 1
        " processing.\n\n"
360 1
        "EXP_Kill\n"
361 1
        "\tLogged when the expiry thread kills an object from the inbox.\n\n"
362 1
        "EXP_When\n"
363 1
        "\tLogged when the expiry thread moves an object on the binheap.\n\n"
364 1
        "EXP_Inspect\n"
365 1
        "\tLogged when the expiry thread inspects the next object scheduled"
366 1
        " to expire.\n\n"
367 1
        "EXP_Expired\n"
368 1
        "\tLogged when the expiry thread expires an object.\n\n"
369 1
        "EXP_Removed\n"
370 1
        "\tLogged when the expiry thread removes an object before expiry.\n\n"
371 1
        "VBF_Superseded\n"
372 1
        "\tLogged when an object supersedes another.\n\n"
373 1
        "LRU_Cand\n"
374 1
        "\tLogged when an object is evaluated for LRU force expiry.\n\n"
375 1
        "LRU\n"
376 1
        "\tLogged when an object is force expired due to LRU.\n\n"
377 1
        "LRU_Fail\n"
378 1
        "\tLogged when no suitable candidate object is found for LRU force"
379 1
        " expiry.\n\n"
380 1
        "The format is::\n\n"
381 1
        "\tEXP_Rearm p=%p E=%f e=%f f=0x%x\n"
382 1
        "\tEXP_Inbox p=%p e=%f f=0x%x\n"
383 1
        "\tEXP_Kill p=%p e=%f f=0x%x\n"
384 1
        "\tEXP_When p=%p e=%f f=0x%x\n"
385 1
        "\tEXP_Inspect p=%p e=%f f=0x%x\n"
386 1
        "\tEXP_Expired x=%u t=%f h=%u\n"
387 1
        "\tEXP_Removed x=%u t=%f h=%u\n"
388 1
        "\tVBF_Superseded x=%u n=%u\n"
389 1
        "\tLRU_Cand p=%p f=0x%x r=%d\n"
390 1
        "\tLRU x=%u\n"
391 1
        "\tLRU_Fail\n"
392 1
        "\t\n"
393 1
        "\tLegend:\n"
394 1
        "\tp=%p         Objcore pointer\n"
395 1
        "\tt=%f         Remaining TTL (s)\n"
396 1
        "\te=%f         Expiry time (unix epoch)\n"
397 1
        "\tE=%f         Old expiry time (unix epoch)\n"
398 1
        "\tf=0x%x       Objcore flags\n"
399 1
        "\tr=%d         Objcore refcount\n"
400 1
        "\tx=%u         Object VXID\n"
401 1
        "\tn=%u         New object VXID\n"
402 1
        "\th=%u         Objcore hits\n"
403 1
        "\n"
404 1
)
405
406 1
SLTM(WorkThread, 0, "Logs thread start/stop events",
407 1
        "Logs worker thread creation and termination events.\n\n"
408 1
        "The format is::\n\n"
409 1
        "\t%p %s\n"
410 1
        "\t|  |\n"
411 1
        "\t|  +- [start|end]\n"
412 1
        "\t+---- Worker struct pointer\n"
413 1
        "\n"
414 1
        NODEF_NOTICE
415 1
)
416
417 1
SLTM(ESI_xmlerror, 0, "ESI parser error or warning message",
418 1
        "An error or warning was generated during parsing of an ESI object."
419 1
        " The log record describes the problem encountered."
420 1
)
421
422 1
SLTM(Hash, SLT_F_UNSAFE, "Value added to hash",
423 1
        "This value was added to the object lookup hash.\n\n"
424 1
        NODEF_NOTICE
425 1
)
426
427
/*
428
 * Probe window bits:
429
 *
430
 * the documentation below could get auto-generated like so:
431
 *
432
 * ( echo '#define PROBE_BITS_DOC \' ; \
433
 *   $CC -D 'BITMAP(n, c, t, b)="\t" #c ": " t "\n" \' \
434
 *       -E ./include/tbl/backend_poll.h | grep -E '^"' ; \
435
 *  echo '""' ) >./include/tbl/backend_poll_doc.h
436
 *
437
 * as this has a hackish feel to it, the documentation is included here as text
438
 * until we find a better solution or the above is accepted
439
 */
440
441 1
SLTM(Backend_health, 0, "Backend health check",
442 1
        "The result of a backend health probe.\n\n"
443 1
        "The format is::\n\n"
444 1
        "\t%s %s %s %s %u %u %u %f %f %s\n"
445 1
        "\t|  |  |  |  |  |  |  |  |  |\n"
446 1
        "\t|  |  |  |  |  |  |  |  |  +- Probe HTTP response / error information\n"
447 1
        "\t|  |  |  |  |  |  |  |  +---- Average response time\n"
448 1
        "\t|  |  |  |  |  |  |  +------- Response time\n"
449 1
        "\t|  |  |  |  |  |  +---------- Probe window size\n"
450 1
        "\t|  |  |  |  |  +------------- Probe threshold level\n"
451 1
        "\t|  |  |  |  +---------------- Number of good probes in window\n"
452 1
        "\t|  |  |  +------------------- Probe window bits\n"
453 1
        "\t|  |  +---------------------- \"healthy\" or \"sick\"\n"
454 1
        "\t|  +------------------------- \"Back\", \"Still\" or \"Went\"\n"
455 1
        "\t+---------------------------- Backend name\n"
456 1
        "\n"
457
458 1
        "Probe window bits are::\n\n"
459 1
        "\t'-': Could not connect\n"
460 1
        "\t'4': Good IPv4\n"
461 1
        "\t'6': Good IPv6\n"
462 1
        "\t'U': Good UNIX\n"
463 1
        "\t'x': Error Xmit\n"
464 1
        "\t'X': Good Xmit\n"
465 1
        "\t'r': Error Recv\n"
466 1
        "\t'R': Good Recv\n"
467 1
        "\t'H': Happy\n"
468 1
        "\n"
469 1
        "When the backend is just created, the window bits for health check\n"
470 1
        "slots that haven't run yet appear as '-' like failures to connect.\n"
471 1
        "\n"
472 1
)
473
474 1
SLTM(VCL_Log, 0, "Log statement from VCL",
475 1
        "User generated log messages insert from VCL through std.log()"
476 1
)
477
478 1
SLTM(VCL_Error, 0, "VCL execution error message",
479 1
        "Logs error messages generated during VCL execution.\n\n"
480 1
)
481
482 1
SLTM(Gzip, 0, "G(un)zip performed on object",
483 1
        "A Gzip record is emitted for each instance of gzip or gunzip"
484 1
        " work performed. Worst case, an ESI transaction stored in"
485 1
        " gzipped objects but delivered gunzipped, will run into many of"
486 1
        " these.\n\n"
487 1
        "The format is::\n\n"
488 1
        "\t%c %c %c %d %d %d %d %d\n"
489 1
        "\t|  |  |  |  |  |  |  |\n"
490 1
        "\t|  |  |  |  |  |  |  +- Bit length of compressed data\n"
491 1
        "\t|  |  |  |  |  |  +---- Bit location of 'last' bit\n"
492 1
        "\t|  |  |  |  |  +------- Bit location of first deflate block\n"
493 1
        "\t|  |  |  |  +---------- Bytes output\n"
494 1
        "\t|  |  |  +------------- Bytes input\n"
495 1
        "\t|  |  +---------------- 'E': ESI, '-': Plain object\n"
496 1
        "\t|  +------------------- 'F': Fetch, 'D': Deliver\n"
497 1
        "\t+---------------------- 'G': Gzip, 'U': Gunzip, 'u': Gunzip-test\n"
498 1
        "\n"
499 1
        "Examples::\n\n"
500 1
        "\tU F E 182 159 80 80 1392\n"
501 1
        "\tG F E 159 173 80 1304 1314\n"
502 1
        "\n"
503 1
)
504
505 1
SLTM(Link, 0, "Links to a child VXID",
506 1
        "Links this VXID to any child VXID it initiates.\n\n"
507 1
        "The format is::\n\n"
508 1
        "\t%s %d %s [%u]\n"
509 1
        "\t|  |  |   |\n"
510 1
        "\t|  |  |   +- Child task sub-level\n"
511 1
        "\t|  |  +----- Reason\n"
512 1
        "\t|  +-------- Child vxid\n"
513 1
        "\t+----------- Child type (\"sess\", \"req\" or \"bereq\")\n"
514 1
        "\n"
515 1
)
516
517 1
SLTM(Begin, 0, "Marks the start of a VXID",
518 1
        "The first record of a VXID transaction.\n\n"
519 1
        "The format is::\n\n"
520 1
        "\t%s %d %s [%u]\n"
521 1
        "\t|  |  |   |\n"
522 1
        "\t|  |  |   +- Task sub-level\n"
523 1
        "\t|  |  +----- Reason\n"
524 1
        "\t|  +-------- Parent vxid\n"
525 1
        "\t+----------- Type (\"sess\", \"req\" or \"bereq\")\n"
526 1
        "\n"
527 1
)
528
529 1
SLTM(End, 0, "Marks the end of a VXID",
530 1
        "The last record of a VXID transaction.\n\n"
531 1
)
532
533 1
SLTM(VSL, 0, "VSL API warnings and error message",
534 1
        "Warnings and error messages generated by the VSL API while"
535 1
        " reading the shared memory log.\n\n"
536 1
)
537
538 1
SLTM(Storage, 0, "Where object is stored",
539 1
        "Type and name of the storage backend the object is stored in.\n\n"
540 1
        "The format is::\n\n"
541 1
        "\t%s %s\n"
542 1
        "\t|  |\n"
543 1
        "\t|  +- Name of storage backend\n"
544 1
        "\t+---- Type (\"malloc\", \"file\", \"persistent\" etc.)\n"
545 1
        "\n"
546 1
)
547
548 1
SLTM(Timestamp, 0, "Timing information",
549 1
        "Contains timing information for the vinyld worker threads.\n\n"
550 1
        "Time stamps are issued by vinyld on certain events,"
551 1
        " and show the absolute time of the event, the time spent since the"
552 1
        " start of the work unit, and the time spent since the last timestamp"
553 1
        " was logged. See the TIMESTAMPS section below for information about"
554 1
        " the individual time stamps.\n\n"
555 1
        "The format is::\n\n"
556 1
        "\t%s: %f %f %f\n"
557 1
        "\t|   |  |  |\n"
558 1
        "\t|   |  |  +- Time since last timestamp\n"
559 1
        "\t|   |  +---- Time since start of work unit\n"
560 1
        "\t|   +------- Absolute time of event\n"
561 1
        "\t+----------- Event label\n"
562 1
        "\n"
563 1
)
564
565 1
SLTM(ReqAcct, 0, "Request handling byte counts",
566 1
        "Contains byte counts for the request handling.\n"
567 1
        "The body bytes count includes transmission overhead"
568 1
        " (ie: chunked encoding).\n"
569 1
        "ESI sub-requests show the body bytes this ESI fragment including"
570 1
        " any subfragments contributed to the top level request.\n"
571 1
        "The format is::\n\n"
572 1
        "\t%d %d %d %d %d %d\n"
573 1
        "\t|  |  |  |  |  |\n"
574 1
        "\t|  |  |  |  |  +- Total bytes transmitted\n"
575 1
        "\t|  |  |  |  +---- Body bytes transmitted\n"
576 1
        "\t|  |  |  +------- Header bytes transmitted\n"
577 1
        "\t|  |  +---------- Total bytes received\n"
578 1
        "\t|  +------------- Body bytes received\n"
579 1
        "\t+---------------- Header bytes received\n"
580 1
        "\n"
581 1
)
582
583 1
SLTM(PipeAcct, 0, "Pipe byte counts",
584 1
        "Contains byte counters for pipe sessions.\n\n"
585 1
        "The format is::\n\n"
586 1
        "\t%d %d %d %d\n"
587 1
        "\t|  |  |  |\n"
588 1
        "\t|  |  |  +------- Piped bytes to client\n"
589 1
        "\t|  |  +---------- Piped bytes from client\n"
590 1
        "\t|  +------------- Backend request headers\n"
591 1
        "\t+---------------- Client request headers\n"
592 1
        "\n"
593 1
)
594
595 1
SLTM(BereqAcct, 0, "Backend request accounting",
596 1
        "Contains byte counters from backend request processing.\n\n"
597 1
        "The format is::\n\n"
598 1
        "\t%d %d %d %d %d %d\n"
599 1
        "\t|  |  |  |  |  |\n"
600 1
        "\t|  |  |  |  |  +- Total bytes received\n"
601 1
        "\t|  |  |  |  +---- Body bytes received\n"
602 1
        "\t|  |  |  +------- Header bytes received\n"
603 1
        "\t|  |  +---------- Total bytes transmitted\n"
604 1
        "\t|  +------------- Body bytes transmitted\n"
605 1
        "\t+---------------- Header bytes transmitted\n"
606 1
        "\n"
607 1
)
608
609 1
SLTM(VfpAcct, 0, "Fetch filter accounting",
610 1
        "Contains name of VFP and statistics.\n\n"
611 1
        "The format is::\n\n"
612 1
        "\t%s %d %d\n"
613 1
        "\t|  |  |\n"
614 1
        "\t|  |  +- Total bytes produced\n"
615 1
        "\t|  +---- Number of calls made\n"
616 1
        "\t+------- Name of filter\n"
617 1
        "\n"
618 1
        NODEF_NOTICE
619 1
)
620
621 1
SLTM(Witness, 0, "Lock order witness records",
622 1
        "Diagnostic recording of locking order.\n"
623 1
)
624
625 1
SLTM(H2RxHdr, SLT_F_BINARY, "Received HTTP2 frame header",
626 1
        "Binary data"
627 1
)
628
629 1
SLTM(H2RxBody, SLT_F_BINARY, "Received HTTP2 frame body",
630 1
        "Binary data"
631 1
)
632
633 1
SLTM(H2TxHdr, SLT_F_BINARY, "Transmitted HTTP2 frame header",
634 1
        "Binary data"
635 1
)
636
637 1
SLTM(H2TxBody, SLT_F_BINARY, "Transmitted HTTP2 frame body",
638 1
        "Binary data"
639 1
)
640
641 1
SLTM(HitMiss, 0, "Hit for miss object in cache.",
642 1
        "Hit-for-miss object looked up in cache.\n\n"
643 1
        "The format is::\n\n"
644 1
        "\t%u %f\n"
645 1
        "\t|  |\n"
646 1
        "\t|  +- Remaining TTL\n"
647 1
        "\t+---- VXID of the object\n"
648 1
        "\n"
649 1
)
650
651 1
SLTM(Filters, 0, "Body filters",
652 1
        "List of filters applied to the body"
653 1
)
654
655 1
SLTM(SessError, 0, "Client connection accept failed",
656 1
        "Accepting a client connection has failed.\n\n"
657 1
        "The format is::\n\n"
658 1
        "\t%s %s %s %d %d %s\n"
659 1
        "\t|  |  |  |  |  |\n"
660 1
        "\t|  |  |  |  |  +- Detailed error message\n"
661 1
        "\t|  |  |  |  +---- Error Number (errno) from accept(2)\n"
662 1
        "\t|  |  |  +------- File descriptor number\n"
663 1
        "\t|  |  +---------- Local TCP port / 0 for UDS\n"
664 1
        "\t|  +------------- Local IPv4/6 address / 0.0.0.0 for UDS\n"
665 1
        "\t+---------------- Socket name (from -a argument)\n"
666 1
        "\n"
667 1
)
668
669 1
SLTM(VCL_use, 0, "VCL in use",
670 1
        "Records the name of the VCL being used.\n\n"
671 1
        "The format is::\n\n"
672 1
        "\t%s [ %s %s ]\n"
673 1
        "\t|    |  |\n"
674 1
        "\t|    |  +- Name of label used to find it\n"
675 1
        "\t|    +---- \"via\"\n"
676 1
        "\t+--------- Name of VCL put in use\n"
677 1
        "\n"
678 1
)
679
680 1
SLTM(Notice, 0, "Informational messages about request handling",
681 1
        "Informational log messages on events occurred during request"
682 1
        " handling.\n\n"
683 1
        "The format is::\n\n"
684 1
        "\t%s: %s\n"
685 1
        "\t|   |\n"
686 1
        "\t|   +- Short description of the notice message\n"
687 1
        "\t+----- Manual page containing the detailed description\n"
688 1
        "\n"
689 1
        "See the NOTICE MESSAGES section below or the individual VMOD manual"
690 1
        " pages for detailed information of notice messages.\n"
691 1
        "\n"
692 1
)
693
694 1
SLTM(VdpAcct, 0, "Deliver filter accounting",
695 1
        "Contains name of VDP and statistics.\n\n"
696 1
        "The format is::\n\n"
697 1
        "\t%s %d %d\n"
698 1
        "\t|  |  |\n"
699 1
        "\t|  |  +- Total bytes produced\n"
700 1
        "\t|  +---- Number of calls made\n"
701 1
        "\t+------- Name of filter\n"
702 1
        "\n"
703 1
        NODEF_NOTICE
704 1
)
705
706 1
SLTM(ReqTarget, 0, "Request target as received",
707 1
        "For HTTP1 connections, this is the *request-target* field from the request\n"
708 1
        "line, which has the format *method* SP *request-target* SP *HTTP-Version*\n"
709 1
        "(SP for space, 0x20)\n\n"
710 1
        NODEF_NOTICE
711 1
)
712
713 1
#undef NOSUP_NOTICE
714 1
#undef NODEF_NOTICE
715 1
#undef SLTM
716
717
/*lint -restore */