blob: 02e01f7e538c334d1e1bd64c390040951c78f016 [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>
Willy Tarreau87b09662015-04-03 00:22:06 +020033#include <types/stream.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020034
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[];
Dragan Dosen1322d092015-09-22 16:05:32 +020042
Dragan Dosen0b85ece2015-09-25 19:17:44 +020043extern char default_rfc5424_sd_log_format[];
44
Dragan Dosen59cee972015-09-19 22:09:02 +020045extern char *logheader;
Dragan Dosen1322d092015-09-22 16:05:32 +020046extern char *logheader_rfc5424;
Willy Tarreau18324f52014-06-27 18:10:07 +020047extern char *logline;
Dragan Dosen0b85ece2015-09-25 19:17:44 +020048extern char *logline_rfc5424;
William Lallemand723b73a2012-02-08 16:37:49 +010049
William Lallemandbddd4fd2012-02-27 11:23:10 +010050
Willy Tarreau87b09662015-04-03 00:22:06 +020051int build_logline(struct stream *s, char *dst, size_t maxsize, struct list *list_format);
William Lallemand1d705562012-03-12 12:46:41 +010052
William Lallemandbddd4fd2012-02-27 11:23:10 +010053/*
Willy Tarreau87b09662015-04-03 00:22:06 +020054 * send a log for the stream when we have enough info about it.
William Lallemandbddd4fd2012-02-27 11:23:10 +010055 * Will not log if the frontend has no log defined.
56 */
Willy Tarreau87b09662015-04-03 00:22:06 +020057void strm_log(struct stream *s);
William Lallemandbddd4fd2012-02-27 11:23:10 +010058
William Lallemand723b73a2012-02-08 16:37:49 +010059/*
60 * Parse args in a logformat_var
61 */
62int parse_logformat_var_args(char *args, struct logformat_node *node);
63
64/*
Willy Tarreau8a3f52f2012-12-20 21:23:42 +010065 * Parse a variable '%varname' or '%{args}varname' in log-format
William Lallemand723b73a2012-02-08 16:37:49 +010066 *
67 */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +010068int 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 +010069
70/*
71 * add to the logformat linked list
72 */
William Lallemand1d705562012-03-12 12:46:41 +010073void add_to_logformat_list(char *start, char *end, int type, struct list *list_format);
William Lallemand723b73a2012-02-08 16:37:49 +010074
75/*
76 * Parse the log_format string and fill a linked list.
77 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
78 * You can set arguments using { } : %{many arguments}varname
79 */
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +010080void 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 +020081/*
82 * Displays the message on stderr with the date and pid. Overrides the quiet
83 * mode during startup.
84 */
Willy Tarreau40d25162009-04-03 12:01:47 +020085void Alert(const char *fmt, ...)
86 __attribute__ ((format(printf, 1, 2)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020087
88/*
89 * Displays the message on stderr with the date and pid.
90 */
Willy Tarreau40d25162009-04-03 12:01:47 +020091void Warning(const char *fmt, ...)
92 __attribute__ ((format(printf, 1, 2)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020093
94/*
95 * Displays the message on <out> only if quiet mode is not set.
96 */
Willy Tarreau40d25162009-04-03 12:01:47 +020097void qfprintf(FILE *out, const char *fmt, ...)
98 __attribute__ ((format(printf, 2, 3)));
Willy Tarreaubaaee002006-06-26 02:48:02 +020099
William Lallemand2a4a44f2012-02-06 16:00:33 +0100100/*
101 * This function adds a header to the message and sends the syslog message
102 * using a printf format string
103 */
104void send_log(struct proxy *p, int level, const char *format, ...)
105 __attribute__ ((format(printf, 3, 4)));
106
Willy Tarreaubaaee002006-06-26 02:48:02 +0200107/*
108 * This function sends a syslog message to both log servers of a proxy,
109 * or to global log servers if the proxy is NULL.
110 * It also tries not to waste too much time computing the message header.
111 * It doesn't care about errors nor does it report them.
112 */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200113
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200114void __send_log(struct proxy *p, int level, char *message, size_t size, char *sd, size_t sd_size);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200115
116/*
Dragan Dosen1322d092015-09-22 16:05:32 +0200117 * returns log format for <fmt> or -1 if not found.
118 */
119int get_log_format(const char *fmt);
120
121/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200122 * returns log level for <lev> or -1 if not found.
123 */
124int get_log_level(const char *lev);
125
126/*
127 * returns log facility for <fac> or -1 if not found.
128 */
129int get_log_facility(const char *fac);
130
William Lallemanda1cc3812012-02-08 16:38:44 +0100131/*
132 * Write a string in the log string
William Lallemand5f232402012-04-05 18:02:55 +0200133 * Take cares of quote options
William Lallemanda1cc3812012-02-08 16:38:44 +0100134 *
135 * Return the adress of the \0 character, or NULL on error
136 */
Willy Tarreau2b0108a2012-12-21 19:23:44 +0100137char *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 +0200138
139/*
140 * Write a IP adress to the log string
141 * +X option write in hexadecimal notation, most signifant byte on the left
142 */
143char *lf_ip(char *dst, struct sockaddr *sockaddr, size_t size, struct logformat_node *node);
144
145/*
146 * Write a port to the log
147 * +X option write in hexadecimal notation, most signifant byte on the left
148 */
149char *lf_port(char *dst, struct sockaddr *sockaddr, size_t size, struct logformat_node *node);
150
William Lallemanda1cc3812012-02-08 16:38:44 +0100151
Willy Tarreaubaaee002006-06-26 02:48:02 +0200152#endif /* _PROTO_LOG_H */
153
154/*
155 * Local variables:
156 * c-indent-level: 8
157 * c-basic-offset: 8
158 * End:
159 */