/* * General logging functions. * * Copyright 2000-2008 Willy Tarreau * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version * 2 of the License, or (at your option) any later version. * */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include struct log_fmt { char *name; struct { struct buffer sep1; /* first pid separator */ struct buffer sep2; /* second pid separator */ } pid; }; static const struct log_fmt log_formats[LOG_FORMATS] = { [LOG_FORMAT_RFC3164] = { .name = "rfc3164", .pid = { .sep1 = { .area = "[", .data = 1 }, .sep2 = { .area = "]: ", .data = 3 } } }, [LOG_FORMAT_RFC5424] = { .name = "rfc5424", .pid = { .sep1 = { .area = " ", .data = 1 }, .sep2 = { .area = " - ", .data = 3 } } }, [LOG_FORMAT_SHORT] = { .name = "short", .pid = { .sep1 = { .area = "", .data = 0 }, .sep2 = { .area = " ", .data = 1 }, } }, [LOG_FORMAT_RAW] = { .name = "raw", .pid = { .sep1 = { .area = "", .data = 0 }, .sep2 = { .area = "", .data = 0 }, } }, }; /* * This map is used with all the FD_* macros to check whether a particular bit * is set or not. Each bit represents an ACSII code. ha_bit_set() sets those * bytes which should be escaped. When ha_bit_test() returns non-zero, it means * that the byte should be escaped. Be careful to always pass bytes from 0 to * 255 exclusively to the macros. */ long rfc5424_escape_map[(256/8) / sizeof(long)]; long hdr_encode_map[(256/8) / sizeof(long)]; long url_encode_map[(256/8) / sizeof(long)]; long http_encode_map[(256/8) / sizeof(long)]; const char *log_facilities[NB_LOG_FACILITIES] = { "kern", "user", "mail", "daemon", "auth", "syslog", "lpr", "news", "uucp", "cron", "auth2", "ftp", "ntp", "audit", "alert", "cron2", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" }; const char *log_levels[NB_LOG_LEVELS] = { "emerg", "alert", "crit", "err", "warning", "notice", "info", "debug" }; const char sess_term_cond[16] = "-LcCsSPRIDKUIIII"; /* normal, Local, CliTo, CliErr, SrvTo, SrvErr, PxErr, Resource, Internal, Down, Killed, Up, -- */ const char sess_fin_state[8] = "-RCHDLQT"; /* cliRequest, srvConnect, srvHeader, Data, Last, Queue, Tarpit */ /* log_format */ struct logformat_type { char *name; int type; int mode; int lw; /* logwait bitsfield */ int (*config_callback)(struct logformat_node *node, struct proxy *curproxy); const char *replace_by; /* new option to use instead of old one */ }; int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy); /* log_format variable names */ static const struct logformat_type logformat_keywords[] = { { "o", LOG_FMT_GLOBAL, PR_MODE_TCP, 0, NULL }, /* global option */ /* please keep these lines sorted ! */ { "B", LOG_FMT_BYTES, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from server to client */ { "CC", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL }, /* client cookie */ { "CS", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL }, /* server cookie */ { "H", LOG_FMT_HOSTNAME, PR_MODE_TCP, LW_INIT, NULL }, /* Hostname */ { "ID", LOG_FMT_UNIQUEID, PR_MODE_TCP, LW_BYTES, NULL }, /* Unique ID */ { "ST", LOG_FMT_STATUS, PR_MODE_TCP, LW_RESP, NULL }, /* status code */ { "T", LOG_FMT_DATEGMT, PR_MODE_TCP, LW_INIT, NULL }, /* date GMT */ { "Ta", LOG_FMT_Ta, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time active (tr to end) */ { "Tc", LOG_FMT_TC, PR_MODE_TCP, LW_BYTES, NULL }, /* Tc */ { "Th", LOG_FMT_Th, PR_MODE_TCP, LW_BYTES, NULL }, /* Time handshake */ { "Ti", LOG_FMT_Ti, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time idle */ { "Tl", LOG_FMT_DATELOCAL, PR_MODE_TCP, LW_INIT, NULL }, /* date local timezone */ { "Tq", LOG_FMT_TQ, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tq=Th+Ti+TR */ { "Tr", LOG_FMT_Tr, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tr */ { "TR", LOG_FMT_TR, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time to receive a valid request */ { "Td", LOG_FMT_TD, PR_MODE_TCP, LW_BYTES, NULL }, /* Td = Tt - (Tq + Tw + Tc + Tr) */ { "Ts", LOG_FMT_TS, PR_MODE_TCP, LW_INIT, NULL }, /* timestamp GMT */ { "Tt", LOG_FMT_TT, PR_MODE_TCP, LW_BYTES, NULL }, /* Tt */ { "Tw", LOG_FMT_TW, PR_MODE_TCP, LW_BYTES, NULL }, /* Tw */ { "U", LOG_FMT_BYTES_UP, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from client to server */ { "ac", LOG_FMT_ACTCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* actconn */ { "b", LOG_FMT_BACKEND, PR_MODE_TCP, LW_INIT, NULL }, /* backend */ { "bc", LOG_FMT_BECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* beconn */ { "bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source ip */ { "bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source port */ { "bq", LOG_FMT_BCKQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* backend_queue */ { "ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client ip */ { "cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client port */ { "f", LOG_FMT_FRONTEND, PR_MODE_TCP, LW_INIT, NULL }, /* frontend */ { "fc", LOG_FMT_FECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* feconn */ { "fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend ip */ { "fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend port */ { "ft", LOG_FMT_FRONTEND_XPRT, PR_MODE_TCP, LW_INIT, NULL }, /* frontend with transport mode */ { "hr", LOG_FMT_HDRREQUEST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request */ { "hrl", LOG_FMT_HDRREQUESTLIST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request list */ { "hs", LOG_FMT_HDRRESPONS, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response */ { "hsl", LOG_FMT_HDRRESPONSLIST, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response list */ { "HM", LOG_FMT_HTTP_METHOD, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP method */ { "HP", LOG_FMT_HTTP_PATH, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP path */ { "HQ", LOG_FMT_HTTP_QUERY, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP query */ { "HU", LOG_FMT_HTTP_URI, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP full URI */ { "HV", LOG_FMT_HTTP_VERSION, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP version */ { "lc", LOG_FMT_LOGCNT, PR_MODE_TCP, LW_INIT, NULL }, /* log counter */ { "ms", LOG_FMT_MS, PR_MODE_TCP, LW_INIT, NULL }, /* accept date millisecond */ { "pid", LOG_FMT_PID, PR_MODE_TCP, LW_INIT, NULL }, /* log pid */ { "r", LOG_FMT_REQ, PR_MODE_HTTP, LW_REQ, NULL }, /* request */ { "rc", LOG_FMT_RETRIES, PR_MODE_TCP, LW_BYTES, NULL }, /* retries */ { "rt", LOG_FMT_COUNTER, PR_MODE_TCP, LW_REQ, NULL }, /* request counter (HTTP or TCP session) */ { "s", LOG_FMT_SERVER, PR_MODE_TCP, LW_SVID, NULL }, /* server */ { "sc", LOG_FMT_SRVCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_conn */ { "si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination ip */ { "sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination port */ { "sq", LOG_FMT_SRVQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_queue */ { "sslc", LOG_FMT_SSL_CIPHER, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL ciphers */ { "sslv", LOG_FMT_SSL_VERSION, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL protocol version */ { "t", LOG_FMT_DATE, PR_MODE_TCP, LW_INIT, NULL }, /* date */ { "tr", LOG_FMT_tr, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request */ { "trg",LOG_FMT_trg, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, GMT */ { "trl",LOG_FMT_trl, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, local */ { "ts", LOG_FMT_TERMSTATE, PR_MODE_TCP, LW_BYTES, NULL },/* termination state */ { "tsc", LOG_FMT_TERMSTATE_CK, PR_MODE_TCP, LW_INIT, NULL },/* termination state */ /* The following tags are deprecated and will be removed soon */ { "Bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource, "bi" }, /* backend source ip */ { "Bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource, "bp" }, /* backend source port */ { "Ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL, "ci" }, /* client ip */ { "Cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL, "cp" }, /* client port */ { "Fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL, "fi" }, /* frontend ip */ { "Fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL, "fp" }, /* frontend port */ { "Si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL, "si" }, /* server destination ip */ { "Sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL, "sp" }, /* server destination port */ { "cc", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL, "CC" }, /* client cookie */ { "cs", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL, "CS" }, /* server cookie */ { "st", LOG_FMT_STATUS, PR_MODE_HTTP, LW_RESP, NULL, "ST" }, /* status code */ { 0, 0, 0, 0, NULL } }; char default_http_log_format[] = "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r"; // default format char clf_http_log_format[] = "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"; char default_tcp_log_format[] = "%ci:%cp [%t] %ft %b/%s %Tw/%Tc/%Tt %B %ts %ac/%fc/%bc/%sc/%rc %sq/%bq"; char *log_format = NULL; /* Default string used for structured-data part in RFC5424 formatted * syslog messages. */ char default_rfc5424_sd_log_format[] = "- "; /* total number of dropped logs */ unsigned int dropped_logs = 0; /* This is a global syslog header, common to all outgoing messages in * RFC3164 format. It begins with time-based part and is updated by * update_log_hdr(). */ THREAD_LOCAL char *logheader = NULL; THREAD_LOCAL char *logheader_end = NULL; /* This is a global syslog header for messages in RFC5424 format. It is * updated by update_log_hdr_rfc5424(). */ THREAD_LOCAL char *logheader_rfc5424 = NULL; THREAD_LOCAL char *logheader_rfc5424_end = NULL; /* This is a global syslog message buffer, common to all outgoing * messages. It contains only the data part. */ THREAD_LOCAL char *logline = NULL; /* A global syslog message buffer, common to all RFC5424 syslog messages. * Currently, it is used for generating the structured-data part. */ THREAD_LOCAL char *logline_rfc5424 = NULL; /* A global buffer used to store all startup alerts/warnings. It will then be * retrieve on the CLI. */ static struct ring *startup_logs = NULL; struct logformat_var_args { char *name; int mask; }; struct logformat_var_args var_args_list[] = { // global { "M", LOG_OPT_MANDATORY }, { "Q", LOG_OPT_QUOTE }, { "X", LOG_OPT_HEXA }, { "E", LOG_OPT_ESC }, { 0, 0 } }; /* return the name of the directive used in the current proxy for which we're * currently parsing a header, when it is known. */ static inline const char *fmt_directive(const struct proxy *curproxy) { switch (curproxy->conf.args.ctx) { case ARGC_ACL: return "acl"; case ARGC_STK: return "stick"; case ARGC_TRK: return "track-sc"; case ARGC_LOG: return "log-format"; case ARGC_LOGSD: return "log-format-sd"; case ARGC_HRQ: return "http-request"; case ARGC_HRS: return "http-response"; case ARGC_UIF: return "unique-id-format"; case ARGC_RDR: return "redirect"; case ARGC_CAP: return "capture"; case ARGC_SRV: return "server"; case ARGC_SPOE: return "spoe-message"; case ARGC_UBK: return "use_backend"; default: return "undefined(please report this bug)"; /* must never happen */ } } /* * callback used to configure addr source retrieval */ int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy) { curproxy->options2 |= PR_O2_SRC_ADDR; return 0; } /* * Parse args in a logformat_var. Returns 0 in error * case, otherwise, it returns 1. */ int parse_logformat_var_args(char *args, struct logformat_node *node, char **err) { int i = 0; int end = 0; int flags = 0; // 1 = + 2 = - char *sp = NULL; // start pointer if (args == NULL) { memprintf(err, "internal error: parse_logformat_var_args() expects non null 'args'"); return 0; } while (1) { if (*args == '\0') end = 1; if (*args == '+') { // add flag sp = args + 1; flags = 1; } if (*args == '-') { // delete flag sp = args + 1; flags = 2; } if (*args == '\0' || *args == ',') { *args = '\0'; for (i = 0; sp && var_args_list[i].name; i++) { if (strcmp(sp, var_args_list[i].name) == 0) { if (flags == 1) { node->options |= var_args_list[i].mask; break; } else if (flags == 2) { node->options &= ~var_args_list[i].mask; break; } } } sp = NULL; if (end) break; } args++; } return 1; } /* * Parse a variable '%varname' or '%{args}varname' in log-format. The caller * must pass the args part in the pointer with its length in , * and varname with its length in and respectively. is * ignored when arg_len is 0. Neither nor may be null. * Returns false in error case and err is filled, otherwise returns true. */ int parse_logformat_var(char *arg, int arg_len, char *var, int var_len, struct proxy *curproxy, struct list *list_format, int *defoptions, char **err) { int j; struct logformat_node *node = NULL; for (j = 0; logformat_keywords[j].name; j++) { // search a log type if (strlen(logformat_keywords[j].name) == var_len && strncmp(var, logformat_keywords[j].name, var_len) == 0) { if (logformat_keywords[j].mode != PR_MODE_HTTP || curproxy->mode == PR_MODE_HTTP) { node = calloc(1, sizeof(*node)); if (!node) { memprintf(err, "out of memory error"); goto error_free; } node->type = logformat_keywords[j].type; node->options = *defoptions; if (arg_len) { node->arg = my_strndup(arg, arg_len); if (!parse_logformat_var_args(node->arg, node, err)) goto error_free; } if (node->type == LOG_FMT_GLOBAL) { *defoptions = node->options; free(node->arg); free(node); } else { if (logformat_keywords[j].config_callback && logformat_keywords[j].config_callback(node, curproxy) != 0) { goto error_free; } curproxy->to_log |= logformat_keywords[j].lw; LIST_ADDQ(list_format, &node->list); } if (logformat_keywords[j].replace_by) ha_warning("parsing [%s:%d] : deprecated variable '%s' in '%s', please replace it with '%s'.\n", curproxy->conf.args.file, curproxy->conf.args.line, logformat_keywords[j].name, fmt_directive(curproxy), logformat_keywords[j].replace_by); return 1; } else { memprintf(err, "format variable '%s' is reserved for HTTP mode", logformat_keywords[j].name); goto error_free; } } } j = var[var_len]; var[var_len] = 0; memprintf(err, "no such format variable '%s'. If you wanted to emit the '%%' character verbatim, you need to use '%%%%'", var); var[var_len] = j; error_free: if (node) { free(node->arg); free(node); } return 0; } /* * push to the logformat linked list * * start: start pointer * end: end text pointer * type: string type * list_format: destination list * * LOG_TEXT: copy chars from start to end excluding end. * */ int add_to_logformat_list(char *start, char *end, int type, struct list *list_format, char **err) { char *str; if (type == LF_TEXT) { /* type text */ struct logformat_node *node = calloc(1, sizeof(*node)); if (!node) { memprintf(err, "out of memory error"); return 0; } str = calloc(1, end - start + 1); strncpy(str, start, end - start); str[end - start] = '\0'; node->arg = str; node->type = LOG_FMT_TEXT; // type string LIST_ADDQ(list_format, &node->list); } else if (type == LF_SEPARATOR) { struct logformat_node *node = calloc(1, sizeof(*node)); if (!node) { memprintf(err, "out of memory error"); return 0; } node->type = LOG_FMT_SEPARATOR; LIST_ADDQ(list_format, &node->list); } return 1; } /* * Parse the sample fetch expression and add a node to upon * success. At the moment, sample converters are not yet supported but fetch arguments * should work. The curpx->conf.args.ctx must be set by the caller. If an end pointer * is passed in , it will be updated with the pointer to the first character * not part of the sample expression. * * In error case, the function returns 0, otherwise it returns 1. */ int add_sample_to_logformat_list(char *text, char *arg, int arg_len, struct proxy *curpx, struct list *list_format, int options, int cap, char **err, char **endptr) { char *cmd[2]; struct sample_expr *expr = NULL; struct logformat_node *node = NULL; int cmd_arg; cmd[0] = text; cmd[1] = ""; cmd_arg = 0; expr = sample_parse_expr(cmd, &cmd_arg, curpx->conf.args.file, curpx->conf.args.line, err, &curpx->conf.args, endptr); if (!expr) { memprintf(err, "failed to parse sample expression <%s> : %s", text, *err); goto error_free; } node = calloc(1, sizeof(*node)); if (!node) { memprintf(err, "out of memory error"); goto error_free; } node->type = LOG_FMT_EXPR; node->expr = expr; node->options = options; if (arg_len) { node->arg = my_strndup(arg, arg_len); if (!parse_logformat_var_args(node->arg, node, err)) goto error_free; } if (expr->fetch->val & cap & SMP_VAL_REQUEST) node->options |= LOG_OPT_REQ_CAP; /* fetch method is request-compatible */ if (expr->fetch->val & cap & SMP_VAL_RESPONSE) node->options |= LOG_OPT_RES_CAP; /* fetch method is response-compatible */ if (!(expr->fetch->val & cap)) { memprintf(err, "sample fetch <%s> may not be reliably used here because it needs '%s' which is not available here", text, sample_src_names(expr->fetch->use)); goto error_free; } /* check if we need to allocate an http_txn struct for HTTP parsing */ /* Note, we may also need to set curpx->to_log with certain fetches */ curpx->http_needed |= !!(expr->fetch->use & SMP_USE_HTTP_ANY); /* FIXME: temporary workaround for missing LW_XPRT and LW_REQ flags * needed with some sample fetches (eg: ssl*). We always set it for * now on, but this will leave with sample capabilities soon. */ curpx->to_log |= LW_XPRT; if (curpx->http_needed) curpx->to_log |= LW_REQ; LIST_ADDQ(list_format, &node->list); return 1; error_free: release_sample_expr(expr); if (node) { free(node->arg); free(node); } return 0; } /* * Parse the log_format string and fill a linked list. * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname * You can set arguments using { } : %{many arguments}varname. * The curproxy->conf.args.ctx must be set by the caller. * * fmt: the string to parse * curproxy: the proxy affected * list_format: the destination list * options: LOG_OPT_* to force on every node * cap: all SMP_VAL_* flags supported by the consumer * * The function returns 1 in success case, otherwise, it returns 0 and err is filled. */ int parse_logformat_string(const char *fmt, struct proxy *curproxy, struct list *list_format, int options, int cap, char **err) { char *sp, *str, *backfmt; /* start pointer for text parts */ char *arg = NULL; /* start pointer for args */ char *var = NULL; /* start pointer for vars */ int arg_len = 0; int var_len = 0; int cformat; /* current token format */ int pformat; /* previous token format */ struct logformat_node *tmplf, *back; sp = str = backfmt = strdup(fmt); if (!str) { memprintf(err, "out of memory error"); return 0; } curproxy->to_log |= LW_INIT; /* flush the list first. */ list_for_each_entry_safe(tmplf, back, list_format, list) { LIST_DEL(&tmplf->list); release_sample_expr(tmplf->expr); free(tmplf->arg); free(tmplf); } for (cformat = LF_INIT; cformat != LF_END; str++) { pformat = cformat; if (!*str) cformat = LF_END; // preset it to save all states from doing this /* The principle of the two-step state machine below is to first detect a change, and * second have all common paths processed at one place. The common paths are the ones * encountered in text areas (LF_INIT, LF_TEXT, LF_SEPARATOR) and at the end (LF_END). * We use the common LF_INIT state to dispatch to the different final states. */ switch (pformat) { case LF_STARTVAR: // text immediately following a '%' arg = NULL; var = NULL; arg_len = var_len = 0; if (*str == '{') { // optional argument cformat = LF_STARG; arg = str + 1; } else if (*str == '[') { cformat = LF_STEXPR; var = str + 1; // store expr in variable name } else if (isalpha((unsigned char)*str)) { // variable name cformat = LF_VAR; var = str; } else if (*str == '%') cformat = LF_TEXT; // convert this character to a literal (useful for '%') else if (isdigit((unsigned char)*str) || *str == ' ' || *str == '\t') { /* single '%' followed by blank or digit, send them both */ cformat = LF_TEXT; pformat = LF_TEXT; /* finally we include the previous char as well */ sp = str - 1; /* send both the '%' and the current char */ memprintf(err, "unexpected variable name near '%c' at position %d line : '%s'. Maybe you want to write a single '%%', use the syntax '%%%%'", *str, (int)(str - backfmt), fmt); goto fail; } else cformat = LF_INIT; // handle other cases of literals break; case LF_STARG: // text immediately following '%{' if (*str == '}') { // end of arg cformat = LF_EDARG; arg_len = str - arg; *str = 0; // used for reporting errors } break; case LF_EDARG: // text immediately following '%{arg}' if (*str == '[') { cformat = LF_STEXPR; var = str + 1; // store expr in variable name break; } else if (isalnum((unsigned char)*str)) { // variable name cformat = LF_VAR; var = str; break; } memprintf(err, "parse argument modifier without variable name near '%%{%s}'", arg); goto fail; case LF_STEXPR: // text immediately following '%[' /* the whole sample expression is parsed at once, * returning the pointer to the first character not * part of the expression, which MUST be the trailing * angle bracket. */ if (!add_sample_to_logformat_list(var, arg, arg_len, curproxy, list_format, options, cap, err, &str)) goto fail; if (*str == ']') { // end of arg, go on with next state cformat = pformat = LF_EDEXPR; sp = str; } else { char c = *str; *str = 0; if (isprint((unsigned char)c)) memprintf(err, "expected ']' after '%s', but found '%c'", var, c); else memprintf(err, "missing ']' after '%s'", var); } break; case LF_VAR: // text part of a variable name var_len = str - var; if (!isalnum((unsigned char)*str)) cformat = LF_INIT; // not variable name anymore break; default: // LF_INIT, LF_TEXT, LF_SEPARATOR, LF_END, LF_EDEXPR cformat = LF_INIT; } if (cformat == LF_INIT) { /* resynchronize state to text/sep/startvar */ switch (*str) { case '%': cformat = LF_STARTVAR; break; case ' ': cformat = LF_SEPARATOR; break; case 0 : cformat = LF_END; break; default : cformat = LF_TEXT; break; } } if (cformat != pformat || pformat == LF_SEPARATOR) { switch (pformat) { case LF_VAR: if (!parse_logformat_var(arg, arg_len, var, var_len, curproxy, list_format, &options, err)) goto fail; break; case LF_STEXPR: if (!add_sample_to_logformat_list(var, arg, arg_len, curproxy, list_format, options, cap, err, &sp)) goto fail; break; case LF_TEXT: case LF_SEPARATOR: if (!add_to_logformat_list(sp, str, pformat, list_format, err)) goto fail; break; } sp = str; /* new start of text at every state switch and at every separator */ } } if (pformat == LF_STARTVAR || pformat == LF_STARG || pformat == LF_STEXPR) { memprintf(err, "truncated line after '%s'", var ? var : arg ? arg : "%"); goto fail; } free(backfmt); return 1; fail: free(backfmt); return 0; } /* * Parse the first range of indexes from a string made of a list of comma separated * ranges of indexes. Note that an index may be considered as a particular range * with a high limit to the low limit. */ int get_logsrv_smp_range(unsigned int *low, unsigned int *high, char **arg, char **err) { char *end, *p; *low = *high = 0; p = *arg; end = strchr(p, ','); if (!end) end = p + strlen(p); *high = *low = read_uint((const char **)&p, end); if (!*low || (p != end && *p != '-')) goto err; if (p == end) goto done; p++; *high = read_uint((const char **)&p, end); if (!*high || *high <= *low || p != end) goto err; done: if (*end == ',') end++; *arg = end; return 1; err: memprintf(err, "wrong sample range '%s'", *arg); return 0; } /* * Returns 1 if the range defined by and overlaps * one of them in array of ranges with the size of this * array, 0 if not. */ int smp_log_ranges_overlap(struct smp_log_range *rgs, size_t sz, unsigned int low, unsigned int high, char **err) { size_t i; for (i = 0; i < sz; i++) { if ((low >= rgs[i].low && low <= rgs[i].high) || (high >= rgs[i].low && high <= rgs[i].high)) { memprintf(err, "ranges are overlapping"); return 1; } } return 0; } int smp_log_range_cmp(const void *a, const void *b) { const struct smp_log_range *rg_a = a; const struct smp_log_range *rg_b = b; if (rg_a->high < rg_b->low) return -1; else if (rg_a->low > rg_b->high) return 1; return 0; } /* * Parse "log" keyword and update list accordingly. * * When is set, it means the "no log" line was parsed, so all log * servers in are released. * * Otherwise, we try to parse the "log" line. First of all, when the list is not * the global one, we look for the parameter "global". If we find it, * global.logsrvs is copied. Else we parse each arguments. * * The function returns 1 in success case, otherwise, it returns 0 and err is * filled. */ int parse_logsrv(char **args, struct list *logsrvs, int do_del, char **err) { struct sockaddr_storage *sk; struct logsrv *logsrv = NULL; int port1, port2; int cur_arg; /* * "no log": delete previous herited or defined syslog * servers. */ if (do_del) { struct logsrv *back; if (*(args[1]) != 0) { memprintf(err, "'no log' does not expect arguments"); goto error; } list_for_each_entry_safe(logsrv, back, logsrvs, list) { LIST_DEL(&logsrv->list); free(logsrv); } return 1; } /* * "log global": copy global.logrsvs linked list to the end of logsrvs * list. But first, we check (logsrvs != global.logsrvs). */ if (*(args[1]) && *(args[2]) == 0 && !strcmp(args[1], "global")) { if (logsrvs == &global.logsrvs) { memprintf(err, "'global' is not supported for a global syslog server"); goto error; } list_for_each_entry(logsrv, &global.logsrvs, list) { struct logsrv *node; list_for_each_entry(node, logsrvs, list) { if (node->ref == logsrv) goto skip_logsrv; } node = malloc(sizeof(*node)); memcpy(node, logsrv, sizeof(struct logsrv)); node->ref = logsrv; LIST_INIT(&node->list); LIST_ADDQ(logsrvs, &node->list); skip_logsrv: continue; } return 1; } /* * "log
...: parse a syslog server line */ if (*(args[1]) == 0 || *(args[2]) == 0) { memprintf(err, "expects
and %s as arguments", ((logsrvs == &global.logsrvs) ? "" : "or global")); goto error; } /* take care of "stdout" and "stderr" as regular aliases for fd@1 / fd@2 */ if (strcmp(args[1], "stdout") == 0) args[1] = "fd@1"; else if (strcmp(args[1], "stderr") == 0) args[1] = "fd@2"; logsrv = calloc(1, sizeof(*logsrv)); if (!logsrv) { memprintf(err, "out of memory"); goto error; } /* skip address for now, it will be parsed at the end */ cur_arg = 2; /* just after the address, a length may be specified */ logsrv->maxlen = MAX_SYSLOG_LEN; if (strcmp(args[cur_arg], "len") == 0) { int len = atoi(args[cur_arg+1]); if (len < 80 || len > 65535) { memprintf(err, "invalid log length '%s', must be between 80 and 65535", args[cur_arg+1]); goto error; } logsrv->maxlen = len; cur_arg += 2; } if (logsrv->maxlen > global.max_syslog_len) global.max_syslog_len = logsrv->maxlen; /* after the length, a format may be specified */ if (strcmp(args[cur_arg], "format") == 0) { logsrv->format = get_log_format(args[cur_arg+1]); if (logsrv->format < 0) { memprintf(err, "unknown log format '%s'", args[cur_arg+1]); goto error; } cur_arg += 2; } if (strcmp(args[cur_arg], "sample") == 0) { unsigned low, high; char *p, *beg, *end, *smp_sz_str; struct smp_log_range *smp_rgs = NULL; size_t smp_rgs_sz = 0, smp_sz = 0, new_smp_sz; p = args[cur_arg+1]; smp_sz_str = strchr(p, ':'); if (!smp_sz_str) { memprintf(err, "Missing sample size"); goto error; } *smp_sz_str++ = '\0'; end = p + strlen(p); while (p != end) { if (!get_logsrv_smp_range(&low, &high, &p, err)) goto error; if (smp_rgs && smp_log_ranges_overlap(smp_rgs, smp_rgs_sz, low, high, err)) goto error; smp_rgs = my_realloc2(smp_rgs, (smp_rgs_sz + 1) * sizeof *smp_rgs); if (!smp_rgs) { memprintf(err, "out of memory error"); goto error; } smp_rgs[smp_rgs_sz].low = low; smp_rgs[smp_rgs_sz].high = high; smp_rgs[smp_rgs_sz].sz = high - low + 1; smp_rgs[smp_rgs_sz].curr_idx = 0; if (smp_rgs[smp_rgs_sz].high > smp_sz) smp_sz = smp_rgs[smp_rgs_sz].high; smp_rgs_sz++; } if (smp_rgs == NULL) { memprintf(err, "no sampling ranges given"); goto error; } beg = smp_sz_str; end = beg + strlen(beg); new_smp_sz = read_uint((const char **)&beg, end); if (!new_smp_sz || beg != end) { memprintf(err, "wrong sample size '%s' for sample range '%s'", smp_sz_str, args[cur_arg+1]); goto error; } if (new_smp_sz < smp_sz) { memprintf(err, "sample size %zu should be greater or equal to " "%zu the maximum of the high ranges limits", new_smp_sz, smp_sz); goto error; } smp_sz = new_smp_sz; /* Let's order array. */ qsort(smp_rgs, smp_rgs_sz, sizeof(struct smp_log_range), smp_log_range_cmp); logsrv->lb.smp_rgs = smp_rgs; logsrv->lb.smp_rgs_sz = smp_rgs_sz; logsrv->lb.smp_sz = smp_sz; cur_arg += 2; } HA_SPIN_INIT(&logsrv->lock); /* parse the facility */ logsrv->facility = get_log_facility(args[cur_arg]); if (logsrv->facility < 0) { memprintf(err, "unknown log facility '%s'", args[cur_arg]); goto error; } cur_arg++; /* parse the max syslog level (default: debug) */ logsrv->level = 7; if (*(args[cur_arg])) { logsrv->level = get_log_level(args[cur_arg]); if (logsrv->level < 0) { memprintf(err, "unknown optional log level '%s'", args[cur_arg]); goto error; } cur_arg++; } /* parse the limit syslog level (default: emerg) */ logsrv->minlvl = 0; if (*(args[cur_arg])) { logsrv->minlvl = get_log_level(args[cur_arg]); if (logsrv->minlvl < 0) { memprintf(err, "unknown optional minimum log level '%s'", args[cur_arg]); goto error; } cur_arg++; } /* Too many args */ if (*(args[cur_arg])) { memprintf(err, "cannot handle unexpected argument '%s'", args[cur_arg]); goto error; } /* now, back to the address */ logsrv->type = LOG_TARGET_DGRAM; if (strncmp(args[1], "ring@", 5) == 0) { struct sink *sink = sink_find(args[1] + 5); if (!sink || sink->type != SINK_TYPE_BUFFER) { memprintf(err, "cannot find ring buffer '%s'", args[1] + 5); goto error; } logsrv->addr.ss_family = AF_UNSPEC; logsrv->type = LOG_TARGET_BUFFER; logsrv->ring = sink->ctx.ring; goto done; } if (strncmp(args[1], "fd@", 3) == 0) logsrv->type = LOG_TARGET_FD; sk = str2sa_range(args[1], NULL, &port1, &port2, err, NULL, NULL, 1); if (!sk) goto error; logsrv->addr = *sk; if (sk->ss_family == AF_INET || sk->ss_family == AF_INET6) { if (port1 != port2) { memprintf(err, "port ranges and offsets are not allowed in '%s'", args[1]); goto error; } logsrv->addr = *sk; if (!port1) set_host_port(&logsrv->addr, SYSLOG_PORT); } done: LIST_ADDQ(logsrvs, &logsrv->list); return 1; error: free(logsrv); return 0; } /* Generic function to display messages prefixed by a label */ static void print_message(const char *label, const char *fmt, va_list argp) { struct tm tm; char *head, *msg; head = msg = NULL; get_localtime(date.tv_sec, &tm); memprintf(&head, "[%s] %03d/%02d%02d%02d (%d) : ", label, tm.tm_yday, tm.tm_hour, tm.tm_min, tm.tm_sec, (int)getpid()); memvprintf(&msg, fmt, argp); if (global.mode & MODE_STARTING) { if (unlikely(!startup_logs)) startup_logs = ring_new(STARTUP_LOG_SIZE); if (likely(startup_logs)) { struct ist m[2]; m[0] = ist(head); m[1] = ist(msg); /* trim the trailing '\n' */ if (m[1].len > 0 && m[1].ptr[m[1].len - 1] == '\n') m[1].len--; ring_write(startup_logs, ~0, 0, 0, m, 2); } } fprintf(stderr, "%s%s", head, msg); fflush(stderr); free(head); free(msg); } /* * Displays the message on stderr with the date and pid. Overrides the quiet * mode during startup. */ void ha_alert(const char *fmt, ...) { va_list argp; if (!(global.mode & MODE_QUIET) || (global.mode & (MODE_VERBOSE | MODE_STARTING))) { if (!(warned & WARN_EXEC_PATH)) { const char *path = get_exec_path(); warned |= WARN_EXEC_PATH; ha_notice("haproxy version is %s\n", haproxy_version); if (path) ha_notice("path to executable is %s\n", path); } va_start(argp, fmt); print_message("ALERT", fmt, argp); va_end(argp); } } /* * Displays the message on stderr with the date and pid. */ void ha_warning(const char *fmt, ...) { va_list argp; warned |= WARN_ANY; if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) { va_start(argp, fmt); print_message("WARNING", fmt, argp); va_end(argp); } } /* * Displays the message on stderr with the date and pid. */ void ha_notice(const char *fmt, ...) { va_list argp; if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) { va_start(argp, fmt); print_message("NOTICE", fmt, argp); va_end(argp); } } /* * Displays the message on only if quiet mode is not set. */ void qfprintf(FILE *out, const char *fmt, ...) { va_list argp; if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) { va_start(argp, fmt); vfprintf(out, fmt, argp); fflush(out); va_end(argp); } } /* * returns log format for or -1 if not found. */ int get_log_format(const char *fmt) { int format; format = LOG_FORMATS - 1; while (format >= 0 && strcmp(log_formats[format].name, fmt)) format--; return format; } /* * returns log level for or -1 if not found. */ int get_log_level(const char *lev) { int level; level = NB_LOG_LEVELS - 1; while (level >= 0 && strcmp(log_levels[level], lev)) level--; return level; } /* * returns log facility for or -1 if not found. */ int get_log_facility(const char *fac) { int facility; facility = NB_LOG_FACILITIES - 1; while (facility >= 0 && strcmp(log_facilities[facility], fac)) facility--; return facility; } /* * Encode the string. * * When using the +E log format option, it will try to escape '"\]' * characters with '\' as prefix. The same prefix should not be used as * . */ static char *lf_encode_string(char *start, char *stop, const char escape, const long *map, const char *string, struct logformat_node *node) { if (node->options & LOG_OPT_ESC) { if (start < stop) { stop--; /* reserve one byte for the final '\0' */ while (start < stop && *string != '\0') { if (!ha_bit_test((unsigned char)(*string), map)) { if (!ha_bit_test((unsigned char)(*string), rfc5424_escape_map)) *start++ = *string; else { if (start + 2 >= stop) break; *start++ = '\\'; *start++ = *string; } } else { if (start + 3 >= stop) break; *start++ = escape; *start++ = hextab[(*string >> 4) & 15]; *start++ = hextab[*string & 15]; } string++; } *start = '\0'; } } else { return encode_string(start, stop, escape, map, string); } return start; } /* * Encode the chunk. * * When using the +E log format option, it will try to escape '"\]' * characters with '\' as prefix. The same prefix should not be used as * . */ static char *lf_encode_chunk(char *start, char *stop, const char escape, const long *map, const struct buffer *chunk, struct logformat_node *node) { char *str, *end; if (node->options & LOG_OPT_ESC) { if (start < stop) { str = chunk->area; end = chunk->area + chunk->data; stop--; /* reserve one byte for the final '\0' */ while (start < stop && str < end) { if (!ha_bit_test((unsigned char)(*str), map)) { if (!ha_bit_test((unsigned char)(*str), rfc5424_escape_map)) *start++ = *str; else { if (start + 2 >= stop) break; *start++ = '\\'; *start++ = *str; } } else { if (start + 3 >= stop) break; *start++ = escape; *start++ = hextab[(*str >> 4) & 15]; *start++ = hextab[*str & 15]; } str++; } *start = '\0'; } } else { return encode_chunk(start, stop, escape, map, chunk); } return start; } /* * Write a string in the log string * Take cares of quote and escape options * * Return the address of the \0 character, or NULL on error */ char *lf_text_len(char *dst, const char *src, size_t len, size_t size, const struct logformat_node *node) { if (size < 2) return NULL; if (node->options & LOG_OPT_QUOTE) { *(dst++) = '"'; size--; } if (src && len) { if (++len > size) len = size; if (node->options & LOG_OPT_ESC) { char *ret; ret = escape_string(dst, dst + len, '\\', rfc5424_escape_map, src); if (ret == NULL || *ret != '\0') return NULL; len = ret - dst; } else { len = strlcpy2(dst, src, len); } size -= len; dst += len; } else if ((node->options & (LOG_OPT_QUOTE|LOG_OPT_MANDATORY)) == LOG_OPT_MANDATORY) { if (size < 2) return NULL; *(dst++) = '-'; } if (node->options & LOG_OPT_QUOTE) { if (size < 2) return NULL; *(dst++) = '"'; } *dst = '\0'; return dst; } static inline char *lf_text(char *dst, const char *src, size_t size, const struct logformat_node *node) { return lf_text_len(dst, src, size, size, node); } /* * Write a IP address to the log string * +X option write in hexadecimal notation, most significant byte on the left */ char *lf_ip(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node) { char *ret = dst; int iret; char pn[INET6_ADDRSTRLEN]; if (node->options & LOG_OPT_HEXA) { unsigned char *addr = NULL; switch (sockaddr->sa_family) { case AF_INET: addr = (unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_addr.s_addr; iret = snprintf(dst, size, "%02X%02X%02X%02X", addr[0], addr[1], addr[2], addr[3]); break; case AF_INET6: addr = (unsigned char *)&((struct sockaddr_in6 *)sockaddr)->sin6_addr.s6_addr; iret = snprintf(dst, size, "%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X", addr[0], addr[1], addr[2], addr[3], addr[4], addr[5], addr[6], addr[7], addr[8], addr[9], addr[10], addr[11], addr[12], addr[13], addr[14], addr[15]); break; default: return NULL; } if (iret < 0 || iret > size) return NULL; ret += iret; } else { addr_to_str((struct sockaddr_storage *)sockaddr, pn, sizeof(pn)); ret = lf_text(dst, pn, size, node); if (ret == NULL) return NULL; } return ret; } /* * Write a port to the log * +X option write in hexadecimal notation, most significant byte on the left */ char *lf_port(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node) { char *ret = dst; int iret; if (node->options & LOG_OPT_HEXA) { const unsigned char *port = (const unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_port; iret = snprintf(dst, size, "%02X%02X", port[0], port[1]); if (iret < 0 || iret > size) return NULL; ret += iret; } else { ret = ltoa_o(get_host_port((struct sockaddr_storage *)sockaddr), dst, size); if (ret == NULL) return NULL; } return ret; } /* Re-generate time-based part of the syslog header in RFC3164 format at * the beginning of logheader once a second and return the pointer to the * first character after it. */ static char *update_log_hdr(const time_t time) { static THREAD_LOCAL long tvsec; static THREAD_LOCAL struct buffer host = { }; static THREAD_LOCAL int sep = 0; if (unlikely(time != tvsec || logheader_end == NULL)) { /* this string is rebuild only once a second */ struct tm tm; int hdr_len; tvsec = time; get_localtime(tvsec, &tm); if (unlikely(global.log_send_hostname != host.area)) { host.area = global.log_send_hostname; host.data = host.area ? strlen(host.area) : 0; sep = host.data ? 1 : 0; } hdr_len = snprintf(logheader, global.max_syslog_len, "<<<<>%s %2d %02d:%02d:%02d %.*s%*s", monthname[tm.tm_mon], tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec, (int)host.data, host.area, sep, ""); /* WARNING: depending upon implementations, snprintf may return * either -1 or the number of bytes that would be needed to store * the total message. In both cases, we must adjust it. */ if (hdr_len < 0 || hdr_len > global.max_syslog_len) hdr_len = global.max_syslog_len; logheader_end = logheader + hdr_len; } logheader_end[0] = 0; // ensure we get rid of any previous attempt return logheader_end; } /* Re-generate time-based part of the syslog header in RFC5424 format at * the beginning of logheader_rfc5424 once a second and return the pointer * to the first character after it. */ static char *update_log_hdr_rfc5424(const time_t time) { static THREAD_LOCAL long tvsec; const char *gmt_offset; if (unlikely(time != tvsec || logheader_rfc5424_end == NULL)) { /* this string is rebuild only once a second */ struct tm tm; int hdr_len; tvsec = time; get_localtime(tvsec, &tm); gmt_offset = get_gmt_offset(time, &tm); hdr_len = snprintf(logheader_rfc5424, global.max_syslog_len, "<<<<>1 %4d-%02d-%02dT%02d:%02d:%02d%.3s:%.2s %s ", tm.tm_year+1900, tm.tm_mon+1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec, gmt_offset, gmt_offset+3, global.log_send_hostname ? global.log_send_hostname : hostname); /* WARNING: depending upon implementations, snprintf may return * either -1 or the number of bytes that would be needed to store * the total message. In both cases, we must adjust it. */ if (hdr_len < 0 || hdr_len > global.max_syslog_len) hdr_len = global.max_syslog_len; logheader_rfc5424_end = logheader_rfc5424 + hdr_len; } logheader_rfc5424_end[0] = 0; // ensure we get rid of any previous attempt return logheader_rfc5424_end; } /* * This function sends the syslog message using a printf format string. It * expects an LF-terminated message. */ void send_log(struct proxy *p, int level, const char *format, ...) { va_list argp; int data_len; if (level < 0 || format == NULL || logline == NULL) return; va_start(argp, format); data_len = vsnprintf(logline, global.max_syslog_len, format, argp); if (data_len < 0 || data_len > global.max_syslog_len) data_len = global.max_syslog_len; va_end(argp); __send_log((p ? &p->logsrvs : NULL), (p ? &p->log_tag : NULL), level, logline, data_len, default_rfc5424_sd_log_format, 2); } /* * This function sends a syslog message to . * is the string to be used for the PID of the caller, is length. * Same thing for and which are used for the structured-data part * in RFC5424 formatted syslog messages, and and the syslog tag. * It overrides the last byte of the message vector with an LF character. * Does not return any error, */ static inline void __do_send_log(struct logsrv *logsrv, int nblogger, char *pid_str, size_t pid_size, int level, char *message, size_t size, char *sd, size_t sd_size, char *tag_str, size_t tag_size) { static THREAD_LOCAL struct iovec iovec[NB_MSG_IOVEC_ELEMENTS] = { }; static THREAD_LOCAL struct msghdr msghdr = { //.msg_iov = iovec, .msg_iovlen = NB_MSG_IOVEC_ELEMENTS }; static THREAD_LOCAL int logfdunix = -1; /* syslog to AF_UNIX socket */ static THREAD_LOCAL int logfdinet = -1; /* syslog to AF_INET socket */ static THREAD_LOCAL char *dataptr = NULL; time_t time = date.tv_sec; char *hdr, *hdr_ptr; size_t hdr_size; int fac_level; int *plogfd; char *pid_sep1 = "", *pid_sep2 = ""; char logheader_short[3]; int sent; int maxlen; int hdr_max = 0; int tag_max = 0; int pid_sep1_max = 0; int pid_max = 0; int pid_sep2_max = 0; int sd_max = 0; int max = 0; msghdr.msg_iov = iovec; dataptr = message; if (logsrv->type == LOG_TARGET_FD) { /* the socket's address is a file descriptor */ plogfd = (int *)&((struct sockaddr_in *)&logsrv->addr)->sin_addr.s_addr; } else if (logsrv->type == LOG_TARGET_BUFFER) { plogfd = NULL; } else if (logsrv->addr.ss_family == AF_UNIX) plogfd = &logfdunix; else plogfd = &logfdinet; if (plogfd && unlikely(*plogfd < 0)) { /* socket not successfully initialized yet */ if ((*plogfd = socket(logsrv->addr.ss_family, SOCK_DGRAM, (logsrv->addr.ss_family == AF_UNIX) ? 0 : IPPROTO_UDP)) < 0) { static char once; if (!once) { once = 1; /* note: no need for atomic ops here */ ha_alert("socket() failed in logger #%d: %s (errno=%d)\n", nblogger, strerror(errno), errno); } return; } else { /* we don't want to receive anything on this socket */ setsockopt(*plogfd, SOL_SOCKET, SO_RCVBUF, &zero, sizeof(zero)); /* does nothing under Linux, maybe needed for others */ shutdown(*plogfd, SHUT_RD); fcntl(*plogfd, F_SETFD, fcntl(*plogfd, F_GETFD, FD_CLOEXEC) | FD_CLOEXEC); } } switch (logsrv->format) { case LOG_FORMAT_RFC3164: hdr = logheader; hdr_ptr = update_log_hdr(time); break; case LOG_FORMAT_RFC5424: hdr = logheader_rfc5424; hdr_ptr = update_log_hdr_rfc5424(time); sd_max = sd_size; /* the SD part allowed only in RFC5424 */ break; case LOG_FORMAT_SHORT: /* all fields are known, skip the header generation */ hdr = logheader_short; hdr[0] = '<'; hdr[1] = '0' + MAX(level, logsrv->minlvl); hdr[2] = '>'; hdr_ptr = hdr; hdr_max = 3; maxlen = logsrv->maxlen - hdr_max; max = MIN(size, maxlen) - 1; goto send; case LOG_FORMAT_RAW: /* all fields are known, skip the header generation */ hdr_ptr = hdr = ""; hdr_max = 0; maxlen = logsrv->maxlen; max = MIN(size, maxlen) - 1; goto send; default: return; /* must never happen */ } hdr_size = hdr_ptr - hdr; /* For each target, we may have a different facility. * We can also have a different log level for each message. * This induces variations in the message header length. * Since we don't want to recompute it each time, nor copy it every * time, we only change the facility in the pre-computed header, * and we change the pointer to the header accordingly. */ fac_level = (logsrv->facility << 3) + MAX(level, logsrv->minlvl); hdr_ptr = hdr + 3; /* last digit of the log level */ do { *hdr_ptr = '0' + fac_level % 10; fac_level /= 10; hdr_ptr--; } while (fac_level && hdr_ptr > hdr); *hdr_ptr = '<'; hdr_max = hdr_size - (hdr_ptr - hdr); /* time-based header */ if (unlikely(hdr_size >= logsrv->maxlen)) { hdr_max = MIN(hdr_max, logsrv->maxlen) - 1; sd_max = 0; goto send; } maxlen = logsrv->maxlen - hdr_max; /* tag */ tag_max = tag_size; if (unlikely(tag_max >= maxlen)) { tag_max = maxlen - 1; sd_max = 0; goto send; } maxlen -= tag_max; /* first pid separator */ pid_sep1_max = log_formats[logsrv->format].pid.sep1.data; if (unlikely(pid_sep1_max >= maxlen)) { pid_sep1_max = maxlen - 1; sd_max = 0; goto send; } pid_sep1 = log_formats[logsrv->format].pid.sep1.area; maxlen -= pid_sep1_max; /* pid */ pid_max = pid_size; if (unlikely(pid_size >= maxlen)) { pid_size = maxlen - 1; sd_max = 0; goto send; } maxlen -= pid_size; /* second pid separator */ pid_sep2_max = log_formats[logsrv->format].pid.sep2.data; if (unlikely(pid_sep2_max >= maxlen)) { pid_sep2_max = maxlen - 1; sd_max = 0; goto send; } pid_sep2 = log_formats[logsrv->format].pid.sep2.area; maxlen -= pid_sep2_max; /* structured-data */ if (sd_max >= maxlen) { sd_max = maxlen - 1; goto send; } max = MIN(size, maxlen - sd_max) - 1; send: if (logsrv->addr.ss_family == AF_UNSPEC) { /* the target is a file descriptor or a ring buffer */ struct ist msg[7]; msg[0].ptr = hdr_ptr; msg[0].len = hdr_max; msg[1].ptr = tag_str; msg[1].len = tag_max; msg[2].ptr = pid_sep1; msg[2].len = pid_sep1_max; msg[3].ptr = pid_str; msg[3].len = pid_max; msg[4].ptr = pid_sep2; msg[4].len = pid_sep2_max; msg[5].ptr = sd; msg[5].len = sd_max; msg[6].ptr = dataptr; msg[6].len = max; if (logsrv->type == LOG_TARGET_BUFFER) sent = ring_write(logsrv->ring, ~0, NULL, 0, msg, 7); else /* LOG_TARGET_FD */ sent = fd_write_frag_line(*plogfd, ~0, NULL, 0, msg, 7, 1); } else { iovec[0].iov_base = hdr_ptr; iovec[0].iov_len = hdr_max; iovec[1].iov_base = tag_str; iovec[1].iov_len = tag_max; iovec[2].iov_base = pid_sep1; iovec[2].iov_len = pid_sep1_max; iovec[3].iov_base = pid_str; iovec[3].iov_len = pid_max; iovec[4].iov_base = pid_sep2; iovec[4].iov_len = pid_sep2_max; iovec[5].iov_base = sd; iovec[5].iov_len = sd_max; iovec[6].iov_base = dataptr; iovec[6].iov_len = max; iovec[7].iov_base = "\n"; /* insert a \n at the end of the message */ iovec[7].iov_len = 1; msghdr.msg_name = (struct sockaddr *)&logsrv->addr; msghdr.msg_namelen = get_addr_len(&logsrv->addr); sent = sendmsg(*plogfd, &msghdr, MSG_DONTWAIT | MSG_NOSIGNAL); } if (sent < 0) { static char once; if (errno == EAGAIN) _HA_ATOMIC_ADD(&dropped_logs, 1); else if (!once) { once = 1; /* note: no need for atomic ops here */ ha_alert("sendmsg()/writev() failed in logger #%d: %s (errno=%d)\n", nblogger, strerror(errno), errno); } } } /* * This function sends a syslog message. * It doesn't care about errors nor does it report them. * The arguments and are used for the structured-data part * in RFC5424 formatted syslog messages. */ void __send_log(struct list *logsrvs, struct buffer *tag, int level, char *message, size_t size, char *sd, size_t sd_size) { struct logsrv *logsrv; int nblogger; static THREAD_LOCAL int curr_pid; static THREAD_LOCAL char pidstr[100]; static THREAD_LOCAL struct buffer pid; if (logsrvs == NULL) { if (!LIST_ISEMPTY(&global.logsrvs)) { logsrvs = &global.logsrvs; } } if (!tag || !tag->area) tag = &global.log_tag; if (!logsrvs || LIST_ISEMPTY(logsrvs)) return; if (unlikely(curr_pid != getpid())) { curr_pid = getpid(); ltoa_o(curr_pid, pidstr, sizeof(pidstr)); chunk_initstr(&pid, pidstr); } /* Send log messages to syslog server. */ nblogger = 0; list_for_each_entry(logsrv, logsrvs, list) { static THREAD_LOCAL int in_range = 1; /* we can filter the level of the messages that are sent to each logger */ if (level > logsrv->level) continue; if (logsrv->lb.smp_rgs) { struct smp_log_range *curr_rg; HA_SPIN_LOCK(LOGSRV_LOCK, &logsrv->lock); curr_rg = &logsrv->lb.smp_rgs[logsrv->lb.curr_rg]; in_range = in_smp_log_range(curr_rg, logsrv->lb.curr_idx); if (in_range) { /* Let's consume this range. */ curr_rg->curr_idx = (curr_rg->curr_idx + 1) % curr_rg->sz; if (!curr_rg->curr_idx) { /* If consumed, let's select the next range. */ logsrv->lb.curr_rg = (logsrv->lb.curr_rg + 1) % logsrv->lb.smp_rgs_sz; } } logsrv->lb.curr_idx = (logsrv->lb.curr_idx + 1) % logsrv->lb.smp_sz; HA_SPIN_UNLOCK(LOGSRV_LOCK, &logsrv->lock); } if (in_range) __do_send_log(logsrv, ++nblogger, pid.area, pid.data, level, message, size, sd, sd_size, tag->area, tag->data); } } const char sess_cookie[8] = "NIDVEOU7"; /* No cookie, Invalid cookie, cookie for a Down server, Valid cookie, Expired cookie, Old cookie, Unused, unknown */ const char sess_set_cookie[8] = "NPDIRU67"; /* No set-cookie, Set-cookie found and left unchanged (passive), Set-cookie Deleted, Set-Cookie Inserted, Set-cookie Rewritten, Set-cookie Updated, unknown, unknown */ /* * try to write a character if there is enough space, or goto out */ #define LOGCHAR(x) do { \ if (tmplog < dst + maxsize - 1) { \ *(tmplog++) = (x); \ } else { \ goto out; \ } \ } while(0) /* Initializes some log data at boot */ static void init_log() { char *tmp; int i; /* Initialize the escape map for the RFC5424 structured-data : '"\]' * inside PARAM-VALUE should be escaped with '\' as prefix. * See https://tools.ietf.org/html/rfc5424#section-6.3.3 for more * details. */ memset(rfc5424_escape_map, 0, sizeof(rfc5424_escape_map)); tmp = "\"\\]"; while (*tmp) { ha_bit_set(*tmp, rfc5424_escape_map); tmp++; } /* initialize the log header encoding map : '{|}"#' should be encoded with * '#' as prefix, as well as non-printable characters ( <32 or >= 127 ). * URL encoding only requires '"', '#' to be encoded as well as non- * printable characters above. */ memset(hdr_encode_map, 0, sizeof(hdr_encode_map)); memset(url_encode_map, 0, sizeof(url_encode_map)); for (i = 0; i < 32; i++) { ha_bit_set(i, hdr_encode_map); ha_bit_set(i, url_encode_map); } for (i = 127; i < 256; i++) { ha_bit_set(i, hdr_encode_map); ha_bit_set(i, url_encode_map); } tmp = "\"#{|}"; while (*tmp) { ha_bit_set(*tmp, hdr_encode_map); tmp++; } tmp = "\"#"; while (*tmp) { ha_bit_set(*tmp, url_encode_map); tmp++; } /* initialize the http header encoding map. The draft httpbis define the * header content as: * * HTTP-message = start-line * *( header-field CRLF ) * CRLF * [ message-body ] * header-field = field-name ":" OWS field-value OWS * field-value = *( field-content / obs-fold ) * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ] * obs-fold = CRLF 1*( SP / HTAB ) * field-vchar = VCHAR / obs-text * VCHAR = %x21-7E * obs-text = %x80-FF * * All the chars are encoded except "VCHAR", "obs-text", SP and HTAB. * The encoded chars are form 0x00 to 0x08, 0x0a to 0x1f and 0x7f. The * "obs-fold" is voluntarily forgotten because haproxy remove this. */ memset(http_encode_map, 0, sizeof(http_encode_map)); for (i = 0x00; i <= 0x08; i++) ha_bit_set(i, http_encode_map); for (i = 0x0a; i <= 0x1f; i++) ha_bit_set(i, http_encode_map); ha_bit_set(0x7f, http_encode_map); } INITCALL0(STG_PREPARE, init_log); /* Initialize log buffers used for syslog messages */ int init_log_buffers() { logheader = my_realloc2(logheader, global.max_syslog_len + 1); logheader_end = NULL; logheader_rfc5424 = my_realloc2(logheader_rfc5424, global.max_syslog_len + 1); logheader_rfc5424_end = NULL; logline = my_realloc2(logline, global.max_syslog_len + 1); logline_rfc5424 = my_realloc2(logline_rfc5424, global.max_syslog_len + 1); if (!logheader || !logline_rfc5424 || !logline || !logline_rfc5424) return 0; return 1; } /* Deinitialize log buffers used for syslog messages */ void deinit_log_buffers() { free(logheader); free(logheader_rfc5424); free(logline); free(logline_rfc5424); ring_free(_HA_ATOMIC_XCHG(&startup_logs, NULL)); logheader = NULL; logheader_rfc5424 = NULL; logline = NULL; logline_rfc5424 = NULL; } /* Builds a log line in based on , and stops before reaching * characters. Returns the size of the output string in characters, * not counting the trailing zero which is always added if the resulting size * is not zero. It requires a valid session and optionally a stream. If the * stream is NULL, default values will be assumed for the stream part. */ int sess_build_logline(struct session *sess, struct stream *s, char *dst, size_t maxsize, struct list *list_format) { struct proxy *fe = sess->fe; struct proxy *be; struct http_txn *txn; const struct strm_logs *logs; struct connection *be_conn; unsigned int s_flags; unsigned int uniq_id; struct buffer chunk; char *uri; char *spc; char *qmark; char *end; struct tm tm; int t_request; int hdr; int last_isspace = 1; int nspaces = 0; char *tmplog; char *ret; int iret; struct logformat_node *tmp; struct timeval tv; struct strm_logs tmp_strm_log; /* FIXME: let's limit ourselves to frontend logging for now. */ if (likely(s)) { be = s->be; txn = s->txn; be_conn = cs_conn(objt_cs(s->si[1].end)); s_flags = s->flags; uniq_id = s->uniq_id; logs = &s->logs; } else { /* we have no stream so we first need to initialize a few * things that are needed later. We do increment the request * ID so that it's uniquely assigned to this request just as * if the request had reached the point of being processed. * A request error is reported as it's the only element we have * here and which justifies emitting such a log. */ be = fe; txn = NULL; be_conn = NULL; s_flags = SF_ERR_PRXCOND | SF_FINST_R; uniq_id = _HA_ATOMIC_XADD(&global.req_count, 1); /* prepare a valid log structure */ tmp_strm_log.tv_accept = sess->tv_accept; tmp_strm_log.accept_date = sess->accept_date; tmp_strm_log.t_handshake = sess->t_handshake; tmp_strm_log.t_idle = tv_ms_elapsed(&sess->tv_accept, &now) - sess->t_handshake; tv_zero(&tmp_strm_log.tv_request); tmp_strm_log.t_queue = -1; tmp_strm_log.t_connect = -1; tmp_strm_log.t_data = -1; tmp_strm_log.t_close = tv_ms_elapsed(&sess->tv_accept, &now); tmp_strm_log.bytes_in = 0; tmp_strm_log.bytes_out = 0; tmp_strm_log.prx_queue_pos = 0; tmp_strm_log.srv_queue_pos = 0; logs = &tmp_strm_log; } t_request = -1; if (tv_isge(&logs->tv_request, &logs->tv_accept)) t_request = tv_ms_elapsed(&logs->tv_accept, &logs->tv_request); tmplog = dst; /* fill logbuffer */ if (LIST_ISEMPTY(list_format)) return 0; list_for_each_entry(tmp, list_format, list) { struct connection *conn; const char *src = NULL; struct sample *key; const struct buffer empty = { }; switch (tmp->type) { case LOG_FMT_SEPARATOR: if (!last_isspace) { LOGCHAR(' '); last_isspace = 1; } break; case LOG_FMT_TEXT: // text src = tmp->arg; iret = strlcpy2(tmplog, src, dst + maxsize - tmplog); if (iret == 0) goto out; tmplog += iret; last_isspace = 0; break; case LOG_FMT_EXPR: // sample expression, may be request or response key = NULL; if (tmp->options & LOG_OPT_REQ_CAP) key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_REQ|SMP_OPT_FINAL, tmp->expr, SMP_T_STR); if (!key && (tmp->options & LOG_OPT_RES_CAP)) key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_RES|SMP_OPT_FINAL, tmp->expr, SMP_T_STR); if (tmp->options & LOG_OPT_HTTP) ret = lf_encode_chunk(tmplog, dst + maxsize, '%', http_encode_map, key ? &key->data.u.str : &empty, tmp); else ret = lf_text_len(tmplog, key ? key->data.u.str.area : NULL, key ? key->data.u.str.data : 0, dst + maxsize - tmplog, tmp); if (ret == 0) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_CLIENTIP: // %ci conn = objt_conn(sess->origin); if (conn && conn_get_src(conn)) ret = lf_ip(tmplog, (struct sockaddr *)conn->src, dst + maxsize - tmplog, tmp); else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_CLIENTPORT: // %cp conn = objt_conn(sess->origin); if (conn && conn_get_src(conn)) { if (conn->src->ss_family == AF_UNIX) { ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog); } else { ret = lf_port(tmplog, (struct sockaddr *)conn->src, dst + maxsize - tmplog, tmp); } } else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_FRONTENDIP: // %fi conn = objt_conn(sess->origin); if (conn && conn_get_dst(conn)) { ret = lf_ip(tmplog, (struct sockaddr *)conn->dst, dst + maxsize - tmplog, tmp); } else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_FRONTENDPORT: // %fp conn = objt_conn(sess->origin); if (conn && conn_get_dst(conn)) { if (conn->dst->ss_family == AF_UNIX) ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog); else ret = lf_port(tmplog, (struct sockaddr *)conn->dst, dst + maxsize - tmplog, tmp); } else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BACKENDIP: // %bi if (be_conn && conn_get_src(be_conn)) ret = lf_ip(tmplog, (const struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp); else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BACKENDPORT: // %bp if (be_conn && conn_get_src(be_conn)) ret = lf_port(tmplog, (struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp); else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SERVERIP: // %si if (be_conn && conn_get_dst(be_conn)) ret = lf_ip(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp); else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SERVERPORT: // %sp if (be_conn && conn_get_dst(be_conn)) ret = lf_port(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp); else ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_DATE: // %t = accept date get_localtime(logs->accept_date.tv_sec, &tm); ret = date2str_log(tmplog, &tm, &logs->accept_date, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_tr: // %tr = start of request date /* Note that the timers are valid if we get here */ tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0); get_localtime(tv.tv_sec, &tm); ret = date2str_log(tmplog, &tm, &tv, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_DATEGMT: // %T = accept date, GMT get_gmtime(logs->accept_date.tv_sec, &tm); ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_trg: // %trg = start of request date, GMT tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0); get_gmtime(tv.tv_sec, &tm); ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_DATELOCAL: // %Tl = accept date, local get_localtime(logs->accept_date.tv_sec, &tm); ret = localdate2str_log(tmplog, logs->accept_date.tv_sec, &tm, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_trl: // %trl = start of request date, local tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0); get_localtime(tv.tv_sec, &tm); ret = localdate2str_log(tmplog, tv.tv_sec, &tm, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TS: // %Ts if (tmp->options & LOG_OPT_HEXA) { iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", (unsigned int)logs->accept_date.tv_sec); if (iret < 0 || iret > dst + maxsize - tmplog) goto out; last_isspace = 0; tmplog += iret; } else { ret = ltoa_o(logs->accept_date.tv_sec, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; } break; case LOG_FMT_MS: // %ms if (tmp->options & LOG_OPT_HEXA) { iret = snprintf(tmplog, dst + maxsize - tmplog, "%02X",(unsigned int)logs->accept_date.tv_usec/1000); if (iret < 0 || iret > dst + maxsize - tmplog) goto out; last_isspace = 0; tmplog += iret; } else { if ((dst + maxsize - tmplog) < 4) goto out; ret = utoa_pad((unsigned int)logs->accept_date.tv_usec/1000, tmplog, 4); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; } break; case LOG_FMT_FRONTEND: // %f src = fe->id; ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_FRONTEND_XPRT: // %ft src = fe->id; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); iret = strlcpy2(tmplog, src, dst + maxsize - tmplog); if (iret == 0) goto out; tmplog += iret; if (sess->listener->bind_conf->xprt == xprt_get(XPRT_SSL)) LOGCHAR('~'); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; #ifdef USE_OPENSSL case LOG_FMT_SSL_CIPHER: // %sslc src = NULL; conn = objt_conn(sess->origin); if (conn) { src = ssl_sock_get_cipher_name(conn); } ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SSL_VERSION: // %sslv src = NULL; conn = objt_conn(sess->origin); if (conn) { src = ssl_sock_get_proto_version(conn); } ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; #endif case LOG_FMT_BACKEND: // %b src = be->id; ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SERVER: // %s switch (obj_type(s ? s->target : NULL)) { case OBJ_TYPE_SERVER: src = __objt_server(s->target)->id; break; case OBJ_TYPE_APPLET: src = __objt_applet(s->target)->name; break; default: src = ""; break; } ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_Th: // %Th = handshake time ret = ltoa_o(logs->t_handshake, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_Ti: // %Ti = HTTP idle time ret = ltoa_o(logs->t_idle, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TR: // %TR = HTTP request time ret = ltoa_o((t_request >= 0) ? t_request - logs->t_idle - logs->t_handshake : -1, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TQ: // %Tq = Th + Ti + TR ret = ltoa_o(t_request, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TW: // %Tw ret = ltoa_o((logs->t_queue >= 0) ? logs->t_queue - t_request : -1, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TC: // %Tc ret = ltoa_o((logs->t_connect >= 0) ? logs->t_connect - logs->t_queue : -1, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_Tr: // %Tr ret = ltoa_o((logs->t_data >= 0) ? logs->t_data - logs->t_connect : -1, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TD: // %Td if (be->mode == PR_MODE_HTTP) ret = ltoa_o((logs->t_data >= 0) ? logs->t_close - logs->t_data : -1, tmplog, dst + maxsize - tmplog); else ret = ltoa_o((logs->t_connect >= 0) ? logs->t_close - logs->t_connect : -1, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_Ta: // %Ta = active time = Tt - Th - Ti if (!(fe->to_log & LW_BYTES)) LOGCHAR('+'); ret = ltoa_o(logs->t_close - (logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0), tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TT: // %Tt = total time if (!(fe->to_log & LW_BYTES)) LOGCHAR('+'); ret = ltoa_o(logs->t_close, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_STATUS: // %ST ret = ltoa_o(txn ? txn->status : 0, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BYTES: // %B if (!(fe->to_log & LW_BYTES)) LOGCHAR('+'); ret = lltoa(logs->bytes_out, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BYTES_UP: // %U ret = lltoa(logs->bytes_in, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_CCLIENT: // %CC src = txn ? txn->cli_cookie : NULL; ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_CSERVER: // %CS src = txn ? txn->srv_cookie : NULL; ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_TERMSTATE: // %ts LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]); LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]); *tmplog = '\0'; last_isspace = 0; break; case LOG_FMT_TERMSTATE_CK: // %tsc, same as TS with cookie state (for mode HTTP) LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]); LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]); LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_cookie[(txn->flags & TX_CK_MASK) >> TX_CK_SHIFT] : '-'); LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_set_cookie[(txn->flags & TX_SCK_MASK) >> TX_SCK_SHIFT] : '-'); last_isspace = 0; break; case LOG_FMT_ACTCONN: // %ac ret = ltoa_o(actconn, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_FECONN: // %fc ret = ltoa_o(fe->feconn, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BECONN: // %bc ret = ltoa_o(be->beconn, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SRVCONN: // %sc ret = ultoa_o(objt_server(s ? s->target : NULL) ? objt_server(s->target)->cur_sess : 0, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_RETRIES: // %rq if (s_flags & SF_REDISP) LOGCHAR('+'); ret = ltoa_o((s && s->si[1].conn_retries > 0) ? (be->conn_retries - s->si[1].conn_retries) : be->conn_retries, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_SRVQUEUE: // %sq ret = ltoa_o(logs->srv_queue_pos, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_BCKQUEUE: // %bq ret = ltoa_o(logs->prx_queue_pos, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_HDRREQUEST: // %hr /* request header */ if (fe->nb_req_cap && s && s->req_cap) { if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); LOGCHAR('{'); for (hdr = 0; hdr < fe->nb_req_cap; hdr++) { if (hdr) LOGCHAR('|'); if (s->req_cap[hdr] != NULL) { ret = lf_encode_string(tmplog, dst + maxsize, '#', hdr_encode_map, s->req_cap[hdr], tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; } } LOGCHAR('}'); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; } break; case LOG_FMT_HDRREQUESTLIST: // %hrl /* request header list */ if (fe->nb_req_cap && s && s->req_cap) { for (hdr = 0; hdr < fe->nb_req_cap; hdr++) { if (hdr > 0) LOGCHAR(' '); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); if (s->req_cap[hdr] != NULL) { ret = lf_encode_string(tmplog, dst + maxsize, '#', hdr_encode_map, s->req_cap[hdr], tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; } else if (!(tmp->options & LOG_OPT_QUOTE)) LOGCHAR('-'); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; } } break; case LOG_FMT_HDRRESPONS: // %hs /* response header */ if (fe->nb_rsp_cap && s && s->res_cap) { if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); LOGCHAR('{'); for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) { if (hdr) LOGCHAR('|'); if (s->res_cap[hdr] != NULL) { ret = lf_encode_string(tmplog, dst + maxsize, '#', hdr_encode_map, s->res_cap[hdr], tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; } } LOGCHAR('}'); last_isspace = 0; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); } break; case LOG_FMT_HDRRESPONSLIST: // %hsl /* response header list */ if (fe->nb_rsp_cap && s && s->res_cap) { for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) { if (hdr > 0) LOGCHAR(' '); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); if (s->res_cap[hdr] != NULL) { ret = lf_encode_string(tmplog, dst + maxsize, '#', hdr_encode_map, s->res_cap[hdr], tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; } else if (!(tmp->options & LOG_OPT_QUOTE)) LOGCHAR('-'); if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; } } break; case LOG_FMT_REQ: // %r /* Request */ if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); uri = txn && txn->uri ? txn->uri : ""; ret = lf_encode_string(tmplog, dst + maxsize, '#', url_encode_map, uri, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_HTTP_PATH: // %HP uri = txn && txn->uri ? txn->uri : ""; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); end = uri + strlen(uri); // look for the first whitespace character while (uri < end && !HTTP_IS_SPHT(*uri)) uri++; // keep advancing past multiple spaces while (uri < end && HTTP_IS_SPHT(*uri)) { uri++; nspaces++; } // look for first space or question mark after url spc = uri; while (spc < end && *spc != '?' && !HTTP_IS_SPHT(*spc)) spc++; if (!txn || !txn->uri || nspaces == 0) { chunk.area = ""; chunk.data = strlen(""); } else { chunk.area = uri; chunk.data = spc - uri; } ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_HTTP_QUERY: // %HQ if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); if (!txn || !txn->uri) { chunk.area = ""; chunk.data = strlen(""); } else { uri = txn->uri; end = uri + strlen(uri); // look for the first question mark while (uri < end && *uri != '?') uri++; qmark = uri; // look for first space or question mark after url while (uri < end && !HTTP_IS_SPHT(*uri)) uri++; chunk.area = qmark; chunk.data = uri - qmark; } ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_HTTP_URI: // %HU uri = txn && txn->uri ? txn->uri : ""; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); end = uri + strlen(uri); // look for the first whitespace character while (uri < end && !HTTP_IS_SPHT(*uri)) uri++; // keep advancing past multiple spaces while (uri < end && HTTP_IS_SPHT(*uri)) { uri++; nspaces++; } // look for first space after url spc = uri; while (spc < end && !HTTP_IS_SPHT(*spc)) spc++; if (!txn || !txn->uri || nspaces == 0) { chunk.area = ""; chunk.data = strlen(""); } else { chunk.area = uri; chunk.data = spc - uri; } ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_HTTP_METHOD: // %HM uri = txn && txn->uri ? txn->uri : ""; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); end = uri + strlen(uri); // look for the first whitespace character spc = uri; while (spc < end && !HTTP_IS_SPHT(*spc)) spc++; if (spc == end) { // odd case, we have txn->uri, but we only got a verb chunk.area = ""; chunk.data = strlen(""); } else { chunk.area = uri; chunk.data = spc - uri; } ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_HTTP_VERSION: // %HV uri = txn && txn->uri ? txn->uri : ""; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); end = uri + strlen(uri); // look for the first whitespace character while (uri < end && !HTTP_IS_SPHT(*uri)) uri++; // keep advancing past multiple spaces while (uri < end && HTTP_IS_SPHT(*uri)) { uri++; nspaces++; } // look for the next whitespace character while (uri < end && !HTTP_IS_SPHT(*uri)) uri++; // keep advancing past multiple spaces while (uri < end && HTTP_IS_SPHT(*uri)) uri++; if (!txn || !txn->uri || nspaces == 0) { chunk.area = ""; chunk.data = strlen(""); } else if (uri == end) { chunk.area = "HTTP/0.9"; chunk.data = strlen("HTTP/0.9"); } else { chunk.area = uri; chunk.data = end - uri; } ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp); if (ret == NULL || *ret != '\0') goto out; tmplog = ret; if (tmp->options & LOG_OPT_QUOTE) LOGCHAR('"'); last_isspace = 0; break; case LOG_FMT_COUNTER: // %rt if (tmp->options & LOG_OPT_HEXA) { iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", uniq_id); if (iret < 0 || iret > dst + maxsize - tmplog) goto out; last_isspace = 0; tmplog += iret; } else { ret = ltoa_o(uniq_id, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; } break; case LOG_FMT_LOGCNT: // %lc if (tmp->options & LOG_OPT_HEXA) { iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", fe->log_count); if (iret < 0 || iret > dst + maxsize - tmplog) goto out; last_isspace = 0; tmplog += iret; } else { ret = ultoa_o(fe->log_count, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; } break; case LOG_FMT_HOSTNAME: // %H src = hostname; ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; case LOG_FMT_PID: // %pid if (tmp->options & LOG_OPT_HEXA) { iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", pid); if (iret < 0 || iret > dst + maxsize - tmplog) goto out; last_isspace = 0; tmplog += iret; } else { ret = ltoa_o(pid, tmplog, dst + maxsize - tmplog); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; } break; case LOG_FMT_UNIQUEID: // %ID ret = NULL; if (s) ret = lf_text_len(tmplog, s->unique_id.ptr, s->unique_id.len, maxsize - (tmplog - dst), tmp); else ret = lf_text_len(tmplog, NULL, 0, maxsize - (tmplog - dst), tmp); if (ret == NULL) goto out; tmplog = ret; last_isspace = 0; break; } } out: /* *tmplog is a unused character */ *tmplog = '\0'; return tmplog - dst; } /* * send a log for the stream when we have enough info about it. * Will not log if the frontend has no log defined. */ void strm_log(struct stream *s) { struct session *sess = s->sess; int size, err, level; int sd_size = 0; /* if we don't want to log normal traffic, return now */ err = (s->flags & SF_REDISP) || ((s->flags & SF_ERR_MASK) > SF_ERR_LOCAL) || (((s->flags & SF_ERR_MASK) == SF_ERR_NONE) && (s->si[1].conn_retries != s->be->conn_retries)) || ((sess->fe->mode == PR_MODE_HTTP) && s->txn && s->txn->status >= 500); if (!err && (sess->fe->options2 & PR_O2_NOLOGNORM)) return; if (LIST_ISEMPTY(&sess->fe->logsrvs)) return; if (s->logs.level) { /* loglevel was overridden */ if (s->logs.level == -1) { s->logs.logwait = 0; /* logs disabled */ return; } level = s->logs.level - 1; } else { level = LOG_INFO; if (err && (sess->fe->options2 & PR_O2_LOGERRORS)) level = LOG_ERR; } /* if unique-id was not generated */ if (!isttest(s->unique_id) && !LIST_ISEMPTY(&sess->fe->format_unique_id)) { stream_generate_unique_id(s, &sess->fe->format_unique_id); } if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) { sd_size = build_logline(s, logline_rfc5424, global.max_syslog_len, &sess->fe->logformat_sd); } size = build_logline(s, logline, global.max_syslog_len, &sess->fe->logformat); if (size > 0) { _HA_ATOMIC_ADD(&sess->fe->log_count, 1); __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level, logline, size + 1, logline_rfc5424, sd_size); s->logs.logwait = 0; } } /* * send a minimalist log for the session. Will not log if the frontend has no * log defined. It is assumed that this is only used to report anomalies that * cannot lead to the creation of a regular stream. Because of this the log * level is LOG_INFO or LOG_ERR depending on the "log-separate-error" setting * in the frontend. The caller must simply know that it should not call this * function to report unimportant events. It is safe to call this function with * sess==NULL (will not do anything). */ void sess_log(struct session *sess) { int size, level; int sd_size = 0; if (!sess) return; if (LIST_ISEMPTY(&sess->fe->logsrvs)) return; level = LOG_INFO; if (sess->fe->options2 & PR_O2_LOGERRORS) level = LOG_ERR; if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) { sd_size = sess_build_logline(sess, NULL, logline_rfc5424, global.max_syslog_len, &sess->fe->logformat_sd); } size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat); if (size > 0) { _HA_ATOMIC_ADD(&sess->fe->log_count, 1); __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level, logline, size + 1, logline_rfc5424, sd_size); } } void app_log(struct list *logsrvs, struct buffer *tag, int level, const char *format, ...) { va_list argp; int data_len; if (level < 0 || format == NULL || logline == NULL) return; va_start(argp, format); data_len = vsnprintf(logline, global.max_syslog_len, format, argp); if (data_len < 0 || data_len > global.max_syslog_len) data_len = global.max_syslog_len; va_end(argp); __send_log(logsrvs, tag, level, logline, data_len, default_rfc5424_sd_log_format, 2); } /* parse the "show startup-logs" command, returns 1 if a message is returned, otherwise zero */ static int cli_parse_show_startup_logs(char **args, char *payload, struct appctx *appctx, void *private) { if (!cli_has_level(appctx, ACCESS_LVL_OPER)) return 1; if (!startup_logs) return cli_msg(appctx, LOG_INFO, "\n"); // nothing to print return ring_attach_cli(startup_logs, appctx); } /* register cli keywords */ static struct cli_kw_list cli_kws = {{ },{ { { "show", "startup-logs", NULL }, "show startup-logs : report logs emitted during HAProxy startup", cli_parse_show_startup_logs, NULL, NULL }, {{},} }}; INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws); REGISTER_PER_THREAD_ALLOC(init_log_buffers); REGISTER_PER_THREAD_FREE(deinit_log_buffers); /* * Local variables: * c-indent-level: 8 * c-basic-offset: 8 * End: */