blob: 54c51d16c7a47c8db6948ddb73af7f70118659f0 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 include/proto/log.h
3 This file contains definitions of log-related functions, structures,
4 and macros.
5
Willy Tarreauec6c5df2008-07-15 00:22:45 +02006 Copyright (C) 2000-2008 Willy Tarreau - w@1wt.eu
Willy Tarreaubaaee002006-06-26 02:48:02 +02007
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation, version 2.1
11 exclusively.
12
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21*/
22
23#ifndef _PROTO_LOG_H
24#define _PROTO_LOG_H
25
26#include <stdio.h>
27#include <syslog.h>
28
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020029#include <common/config.h>
Willy Tarreau332f8bf2007-05-13 21:36:56 +020030#include <common/memory.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020031#include <types/log.h>
32#include <types/proxy.h>
33#include <types/session.h>
34
Willy Tarreau332f8bf2007-05-13 21:36:56 +020035extern struct pool_head *pool2_requri;
William Lallemanda73203e2012-03-12 12:48:57 +010036extern struct pool_head *pool2_uniqueid;
Willy Tarreau332f8bf2007-05-13 21:36:56 +020037
William Lallemand723b73a2012-02-08 16:37:49 +010038extern char *log_format;
William Lallemandbddd4fd2012-02-27 11:23:10 +010039extern char default_tcp_log_format[];
William Lallemand723b73a2012-02-08 16:37:49 +010040extern char default_http_log_format[];
41extern char clf_http_log_format[];
Willy Tarreaudc2695c2014-06-27 18:10:07 +020042extern char *logline;
William Lallemand723b73a2012-02-08 16:37:49 +010043
William Lallemandbddd4fd2012-02-27 11:23:10 +010044
William Lallemand1d705562012-03-12 12:46:41 +010045int build_logline(struct session *s, char *dst, size_t maxsize, struct list *list_format);
46
William Lallemandbddd4fd2012-02-27 11:23:10 +010047/*
48 * send a log for the session when we have enough info about it.
49 * Will not log if the frontend has no log defined.
50 */
51void sess_log(struct session *s);
52
William Lallemand723b73a2012-02-08 16:37:49 +010053/*
54 * Parse args in a logformat_var
55 */
56int parse_logformat_var_args(char *args, struct logformat_node *node);
57
58/*
Willy Tarreau8a3f52f2012-12-20 21:23:42 +010059 * Parse a variable '%varname' or '%{args}varname' in log-format
William Lallemand723b73a2012-02-08 16:37:49 +010060 *
61 */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +010062int parse_logformat_var(char *arg, int arg_len, char *var, int var_len, struct proxy *curproxy, struct list *list_format, int *defoptions);
William Lallemand723b73a2012-02-08 16:37:49 +010063
64/*
65 * add to the logformat linked list
66 */
William Lallemand1d705562012-03-12 12:46:41 +010067void add_to_logformat_list(char *start, char *end, int type, struct list *list_format);
William Lallemand723b73a2012-02-08 16:37:49 +010068
69/*
70 * Parse the log_format string and fill a linked list.
71 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
72 * You can set arguments using { } : %{many arguments}varname
73 */
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +010074void parse_logformat_string(const char *str, struct proxy *curproxy, struct list *list_format, int options, int cap, const char *file, int line);
Willy Tarreaubaaee002006-06-26 02:48:02 +020075/*
76 * Displays the message on stderr with the date and pid. Overrides the quiet
77 * mode during startup.
78 */
Willy Tarreau40d25162009-04-03 12:01:47 +020079void Alert(const char *fmt, ...)
80 __attribute__ ((format(printf, 1, 2)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020081
82/*
83 * Displays the message on stderr with the date and pid.
84 */
Willy Tarreau40d25162009-04-03 12:01:47 +020085void Warning(const char *fmt, ...)
86 __attribute__ ((format(printf, 1, 2)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020087
88/*
89 * Displays the message on <out> only if quiet mode is not set.
90 */
Willy Tarreau40d25162009-04-03 12:01:47 +020091void qfprintf(FILE *out, const char *fmt, ...)
92 __attribute__ ((format(printf, 2, 3)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020093
William Lallemand2a4a44f2012-02-06 16:00:33 +010094/*
95 * This function adds a header to the message and sends the syslog message
96 * using a printf format string
97 */
98void send_log(struct proxy *p, int level, const char *format, ...)
99 __attribute__ ((format(printf, 3, 4)));
100
Willy Tarreaubaaee002006-06-26 02:48:02 +0200101/*
102 * This function sends a syslog message to both log servers of a proxy,
103 * or to global log servers if the proxy is NULL.
104 * It also tries not to waste too much time computing the message header.
105 * It doesn't care about errors nor does it report them.
106 */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200107
William Lallemand2a4a44f2012-02-06 16:00:33 +0100108void __send_log(struct proxy *p, int level, char *message, size_t size);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200109
110/*
111 * returns log level for <lev> or -1 if not found.
112 */
113int get_log_level(const char *lev);
114
115/*
116 * returns log facility for <fac> or -1 if not found.
117 */
118int get_log_facility(const char *fac);
119
William Lallemanda1cc3812012-02-08 16:38:44 +0100120/*
121 * Write a string in the log string
William Lallemand5f232402012-04-05 18:02:55 +0200122 * Take cares of quote options
William Lallemanda1cc3812012-02-08 16:38:44 +0100123 *
124 * Return the adress of the \0 character, or NULL on error
125 */
Willy Tarreau2b0108a2012-12-21 19:23:44 +0100126char *lf_text_len(char *dst, const char *src, size_t len, size_t size, struct logformat_node *node);
William Lallemand5f232402012-04-05 18:02:55 +0200127
128/*
129 * Write a IP adress to the log string
130 * +X option write in hexadecimal notation, most signifant byte on the left
131 */
132char *lf_ip(char *dst, struct sockaddr *sockaddr, size_t size, struct logformat_node *node);
133
134/*
135 * Write a port to the log
136 * +X option write in hexadecimal notation, most signifant byte on the left
137 */
138char *lf_port(char *dst, struct sockaddr *sockaddr, size_t size, struct logformat_node *node);
139
William Lallemanda1cc3812012-02-08 16:38:44 +0100140
Willy Tarreaubaaee002006-06-26 02:48:02 +0200141#endif /* _PROTO_LOG_H */
142
143/*
144 * Local variables:
145 * c-indent-level: 8
146 * c-basic-offset: 8
147 * End:
148 */