1 /*
2 include/proto/log.h
3 This file contains definitions of log-related functions, structures,
4 and macros.
5
6 Copyright (C) 2000-2008 Willy Tarreau - w@1wt.eu
7
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
29 #include <common/config.h>
30 #include <common/memory.h>
31 #include <common/hathreads.h>
32
33 #include <types/log.h>
34 #include <types/proxy.h>
35 #include <types/stream.h>
36
37 #include <proto/stream.h>
38
39 extern struct pool_head *pool_head_requri;
40 extern struct pool_head *pool_head_uniqueid;
41
42 extern char *log_format;
43 extern char default_tcp_log_format[];
44 extern char default_http_log_format[];
45 extern char clf_http_log_format[];
46
47 extern char default_rfc5424_sd_log_format[];
48
49 extern unsigned int dropped_logs;
50
51 extern THREAD_LOCAL char *logheader;
52 extern THREAD_LOCAL char *logheader_rfc5424;
53 extern THREAD_LOCAL char *logline;
54 extern THREAD_LOCAL char *logline_rfc5424;
55
56
57 /*
58 * Test if <idx> index numbered from 0 is in <rg> range with low and high
59 * limits of indexes numbered from 1.
60 */
in_smp_log_range(struct smp_log_range * rg,unsigned int idx)61 static inline int in_smp_log_range(struct smp_log_range *rg, unsigned int idx)
62 {
63 if (idx + 1 <= rg->high && idx + 1 >= rg->low)
64 return 1;
65 return 0;
66 }
67
68 /* Initialize/Deinitialize log buffers used for syslog messages */
69 int init_log_buffers();
70 void deinit_log_buffers();
71
72 /*
73 * Builds a log line.
74 */
75 int sess_build_logline(struct session *sess, struct stream *s, char *dst, size_t maxsize, struct list *list_format);
76
build_logline(struct stream * s,char * dst,size_t maxsize,struct list * list_format)77 static inline int build_logline(struct stream *s, char *dst, size_t maxsize, struct list *list_format)
78 {
79 return sess_build_logline(strm_sess(s), s, dst, maxsize, list_format);
80 }
81
82
83 /*
84 * send a log for the stream when we have enough info about it.
85 * Will not log if the frontend has no log defined.
86 */
87 void strm_log(struct stream *s);
88 void sess_log(struct session *sess);
89
90 /* send a applicative log with custom list of log servers */
91 void app_log(struct list *logsrvs, struct buffer *tag, int level, const char *format, ...)
92 __attribute__ ((format(printf, 4, 5)));
93
94 /*
95 * add to the logformat linked list
96 */
97 int add_to_logformat_list(char *start, char *end, int type, struct list *list_format, char **err);
98
99 /*
100 * Parse the log_format string and fill a linked list.
101 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
102 * You can set arguments using { } : %{many arguments}varname
103 */
104 int parse_logformat_string(const char *str, struct proxy *curproxy, struct list *list_format, int options, int cap, char **err);
105
106 /* Parse "log" keyword and update the linked list. */
107 int parse_logsrv(char **args, struct list *logsrvs, int do_del, char **err);
108
109 /*
110 * Displays the message on stderr with the date and pid. Overrides the quiet
111 * mode during startup.
112 */
113 void ha_alert(const char *fmt, ...)
114 __attribute__ ((format(printf, 1, 2)));
115
116 /*
117 * Displays the message on stderr with the date and pid.
118 */
119 void ha_warning(const char *fmt, ...)
120 __attribute__ ((format(printf, 1, 2)));
121
122 /*
123 * Displays the message on stderr with the date and pid.
124 */
125 void ha_notice(const char *fmt, ...)
126 __attribute__ ((format(printf, 1, 2)));
127
128 /*
129 * Displays the message on <out> only if quiet mode is not set.
130 */
131 void qfprintf(FILE *out, const char *fmt, ...)
132 __attribute__ ((format(printf, 2, 3)));
133
134 /*
135 * This function adds a header to the message and sends the syslog message
136 * using a printf format string
137 */
138 void send_log(struct proxy *p, int level, const char *format, ...)
139 __attribute__ ((format(printf, 3, 4)));
140
141 /*
142 * This function sends a syslog message to both log servers of a proxy,
143 * or to global log servers if the proxy is NULL.
144 * It also tries not to waste too much time computing the message header.
145 * It doesn't care about errors nor does it report them.
146 */
147
148 void __send_log(struct list *logsrvs, struct buffer *tag, int level, char *message, size_t size, char *sd, size_t sd_size);
149
150 /*
151 * returns log format for <fmt> or -1 if not found.
152 */
153 int get_log_format(const char *fmt);
154
155 /*
156 * returns log level for <lev> or -1 if not found.
157 */
158 int get_log_level(const char *lev);
159
160 /*
161 * returns log facility for <fac> or -1 if not found.
162 */
163 int get_log_facility(const char *fac);
164
165 /*
166 * Write a string in the log string
167 * Take cares of quote options
168 *
169 * Return the address of the \0 character, or NULL on error
170 */
171 char *lf_text_len(char *dst, const char *src, size_t len, size_t size, const struct logformat_node *node);
172
173 /*
174 * Write a IP address to the log string
175 * +X option write in hexadecimal notation, most signifant byte on the left
176 */
177 char *lf_ip(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node);
178
179 /*
180 * Write a port to the log
181 * +X option write in hexadecimal notation, most signifant byte on the left
182 */
183 char *lf_port(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node);
184
185
186 #endif /* _PROTO_LOG_H */
187
188 /*
189 * Local variables:
190 * c-indent-level: 8
191 * c-basic-offset: 8
192 * End:
193 */
194