haproxy

mirror of http://git.haproxy.org/git/haproxy.git/ synced 2024-12-18 09:24:31 +00:00

haproxy public development tree

Go to file

Aurelien DARRAGON 47ee036e5f BUG/MEDIUM: log: improper use of logsrv->maxlen for buffer targets In `e709e1e` ("MEDIUM: logs: buffer targets now rely on new sink_write") we started using the sink API instead of using the ring_write function directly. But as indicated in the commit message, the maxlen parameter of the log directive now only applies to the message part and not the complete payload. I don't know what the original intent was (maybe minimizing code changes) but it seems wrong, because the doc doesn't mention this special case, and the result is that the ring->buffer output can differ from all other log output types, making it very confusing. One last issue with this is that log messages can end up being dropped at runtime, only for the buffer target, and even if logsrv->maxlen is correctly set (including default: 1024) because depending on the generated header size the payload can grow bigger than the accepted sink size (sink maxlen is not mandatory) and we have no simple way to detect this at configuration time. First, we partially revert `e709e1e`: TARGET_BUFFER still leverages the proper sink API, but thanks to "MINOR: sink: pass explicit maxlen parameter to sink_write()" we now explicitly pass the logsrv->maxlen to the sink_write function in order to stop writing as soon as either sink->maxlen or logsrv->maxlen is reached. This restores pre-e709e1e behavior with the added benefit from using the high-level API, which includes automatically announcing dropped message events. Then, we also need to take the ending '\n' into account: it is not explicitly set when generating the logline for TARGET_BUFFER, but it will be forcefully added by the sink_forward_io_handler function from the tcp handler applet when log messages from the buffer are forwarded to tcp endpoints. In current form, because the '\n' is added later in the chain, maxlen is not being considered anymore, so the final log message could exceed maxlen by 1 byte, which could make receiving servers unhappy in logging context. To prevent this, we sacrifice 1 byte from the logsrv->maxlen to ensure that the final message will never exceed log->maxlen, even if the '\n' char is automatically appended later by the forwarding applet. Thanks to this change TCP (over RING/BUFFER) target now behaves like FD and UDP targets. This commit depends on: - "MINOR: sink: pass explicit maxlen parameter to sink_write()" It may be backported as far as 2.2 [For 2.2 and 2.4 the patch does not apply automatically, the sink_write() call must be updated by hand]		2023-07-10 18:28:08 +02:00
.github	CI: drop Fedora m32 pipeline in favour of cross matrix	2023-05-17 14:57:10 +02:00
addons	MINOR: tree-wide: use free_acl_cond() where relevant	2023-05-11 15:37:04 +02:00
admin	MINOR: acme.sh: add the deploy script for acme.sh in admin directory	2023-04-26 17:32:15 +02:00
dev	DEV: add a Lua helper script for SSL keys logging	2023-05-24 16:08:23 +02:00
doc	DOC: ssl: Add ocsp-update troubleshooting clues and emphasize on crt-list only aspect	2023-07-03 16:04:09 +02:00
examples	EXAMPLES: update the basic-config-edge file for 2.8	2023-05-31 16:08:57 +02:00
include	MINOR: sink/api: pass explicit maxlen parameter to sink_write()	2023-07-10 18:28:08 +02:00
reg-tests	BUG/MINOR: cache: A 'max-age=0' cache-control directive can be overriden by a s-maxage	2023-07-04 22:15:00 +02:00
scripts	SCRIPTS: publish-release: update the umask to keep group write access	2023-05-24 22:49:12 +02:00
src	BUG/MEDIUM: log: improper use of logsrv->maxlen for buffer targets	2023-07-10 18:28:08 +02:00
tests	TESTS: add a unit test for one_among_mask()	2022-06-21 20:29:57 +02:00
.cirrus.yml	CI: cirrus-ci: bump FreeBSD image to 13-1	2023-04-23 09:44:53 +02:00
.gitattributes	MINOR: Configure the `cpp` userdiff driver for *.[ch] in .gitattributes	2021-02-22 18:17:57 +01:00
.gitignore	CONTRIB: Add vi file extensions to .gitignore	2023-06-02 18:14:34 +02:00
.mailmap	DOC: update Tim's address in .mailmap	2021-09-16 09:14:14 +02:00
.travis.yml	CI: travis-ci: temporarily disable arm64 builds	2021-08-07 07:28:15 +02:00
BRANCHES
BSDmakefile	BUILD: makefile: commit the tiny FreeBSD makefile stub	2023-05-24 17:17:36 +02:00
CHANGELOG	[RELEASE] Released version 2.9-dev1	2023-07-02 11:13:42 +02:00
CONTRIBUTING	CLEANUP: assorted typo fixes in the code and comments	2021-08-16 12:37:59 +02:00
INSTALL	MINOR: version: mention that it's development again	2023-05-31 16:28:34 +02:00
LICENSE
MAINTAINERS	CLEANUP: assorted typo fixes in the code and comments	2022-11-30 14:02:36 +01:00
Makefile	BUILD: Makefile: use -pthread not -lpthread when threads are enabled	2023-05-31 12:06:41 +02:00
README
SUBVERS
VERDATE	[RELEASE] Released version 2.9-dev1	2023-07-02 11:13:42 +02:00
VERSION	[RELEASE] Released version 2.9-dev1	2023-07-02 11:13:42 +02:00

README

The HAProxy documentation has been split into a number of different files for
ease of use.

Please refer to the following files depending on what you're looking for :

  - INSTALL for instructions on how to build and install HAProxy
  - BRANCHES to understand the project's life cycle and what version to use
  - LICENSE for the project's license
  - CONTRIBUTING for the process to follow to submit contributions

The more detailed documentation is located into the doc/ directory :

  - doc/intro.txt for a quick introduction on HAProxy
  - doc/configuration.txt for the configuration's reference manual
  - doc/lua.txt for the Lua's reference manual
  - doc/SPOE.txt for how to use the SPOE engine
  - doc/network-namespaces.txt for how to use network namespaces under Linux
  - doc/management.txt for the management guide
  - doc/regression-testing.txt for how to use the regression testing suite
  - doc/peers.txt for the peers protocol reference
  - doc/coding-style.txt for how to adopt HAProxy's coding style
  - doc/internals for developer-specific documentation (not all up to date)