mirror of
https://github.com/haproxy/haproxy.git
synced 2026-04-26 00:27:54 -04:00
99c453df9d
It is possible to globally declare ring-buffers, to be used as target for log
servers or traces.
ring <ringname>
Creates a new ring-buffer with name <ringname>.
description <text>
The descritpition is an optional description string of the ring. It will
appear on CLI. By default, <name> is reused to fill this field.
format <format>
Format used to store events into the ring buffer.
Arguments:
<format> is the log format used when generating syslog messages. It may be
one of the following :
iso A message containing only the ISO date, followed by the text.
The PID, process name and system name are omitted. This is
designed to be used with a local log server.
raw A message containing only the text. The level, PID, date, time,
process name and system name are omitted. This is designed to be
used in containers or during development, where the severity
only depends on the file descriptor used (stdout/stderr). This
is the default.
rfc3164 The RFC3164 syslog message format. This is the default.
(https://tools.ietf.org/html/rfc3164)
rfc5424 The RFC5424 syslog message format.
(https://tools.ietf.org/html/rfc5424)
short A message containing only a level between angle brackets such as
'<3>', followed by the text. The PID, date, time, process name
and system name are omitted. This is designed to be used with a
local log server. This format is compatible with what the systemd
logger consumes.
timed A message containing only a level between angle brackets such as
'<3>', followed by ISO date and by the text. The PID, process
name and system name are omitted. This is designed to be
used with a local log server.
maxlen <length>
The maximum length of an event message stored into the ring,
including formatted header. If an event message is longer than
<length>, it will be truncated to this length.
size <size>
This is the optional size in bytes for the ring-buffer. Default value is
set to BUFSIZE.
Example:
global
log ring@myring local7
ring myring
description "My local buffer"
format rfc3164
maxlen 1200
Note: ring names are resolved during post configuration processing.
75 lines
2.4 KiB
C
75 lines
2.4 KiB
C
/*
|
|
* include/types/sink.h
|
|
* This file provides definitions for event sinks
|
|
*
|
|
* Copyright (C) 2000-2019 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _TYPES_SINK_H
|
|
#define _TYPES_SINK_H
|
|
|
|
#include <common/buffer.h>
|
|
#include <common/compat.h>
|
|
#include <common/config.h>
|
|
#include <common/ist.h>
|
|
|
|
/* A sink may be of 4 distinct types :
|
|
* - file descriptor (such as stdout)
|
|
* - ring buffer, readable from CLI
|
|
*/
|
|
enum sink_type {
|
|
SINK_TYPE_NEW, // not yet initialized
|
|
SINK_TYPE_FD, // events sent to a file descriptor
|
|
SINK_TYPE_BUFFER, // events sent to a ring buffer
|
|
};
|
|
|
|
/* This indicates the default event format, which is the destination's
|
|
* preferred format, but may be overridden by the source.
|
|
*/
|
|
enum sink_fmt {
|
|
SINK_FMT_RAW, // raw text sent as-is
|
|
SINK_FMT_SHORT, // raw text prefixed with a syslog level
|
|
SINK_FMT_ISO, // raw text prefixed with ISO time
|
|
SINK_FMT_TIMED, // syslog level then ISO
|
|
SINK_FMT_RFC3164, // regular syslog
|
|
SINK_FMT_RFC5424, // extended syslog
|
|
};
|
|
|
|
/* describes the configuration and current state of an event sink */
|
|
struct sink {
|
|
struct list sink_list; // position in the sink list
|
|
char *name; // sink name
|
|
char *desc; // sink description
|
|
enum sink_fmt fmt; // format expected by the sink
|
|
enum sink_type type; // type of storage
|
|
uint32_t maxlen; // max message length (truncated above)
|
|
struct {
|
|
__decl_hathreads(HA_RWLOCK_T lock); // shared/excl for dropped
|
|
struct ring *ring; // used by ring buffer and STRM sender
|
|
unsigned int dropped; // dropped events since last one.
|
|
int fd; // fd num for FD type sink
|
|
} ctx;
|
|
};
|
|
|
|
#endif /* _TYPES_SINK_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|