From: Hugo Landau Date: Mon, 22 Jan 2024 14:41:44 +0000 (+0000) Subject: QUIC QLOG: Clarify filter docs X-Git-Tag: openssl-3.3.0-alpha1~203 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=613917ea0c5074700990851cb98b07f38c5b82b7;p=thirdparty%2Fopenssl.git QUIC QLOG: Clarify filter docs Reviewed-by: Matt Caswell Reviewed-by: Neil Horman (Merged from https://github.com/openssl/openssl/pull/22037) --- diff --git a/doc/designs/quic-design/qlog.md b/doc/designs/quic-design/qlog.md index b04d56f4022..33d21913212 100644 --- a/doc/designs/quic-design/qlog.md +++ b/doc/designs/quic-design/qlog.md @@ -98,10 +98,10 @@ wildcard = "*" name = 1*(ALPHA / DIGIT / "_" / "-") ``` -Here is an example filter: +Here is a (somewhat nonsensical) example filter: ```text --quic:version_information quic:packet_sent -* +* ++* -quic:version_information -* quic:packet_sent ``` The syntax works as follows: @@ -118,3 +118,16 @@ The syntax works as follows: - `-quic:version_information` disables a specific event type. - Partial wildcard matches are not supported at this time. + +Each term is applied in sequence, therefore later items in the filter override +earlier items. In the example above, for example, all events are enabled, then +the `quic:version_information` event is disabled, then all events are disabled, +then the `quic:packet_sent` event is reenabled. + +Some examples of more normal filters include: + +- `*` (or `+*`): enable all events + +- `quic:version_information quic:packet_sent`: enable some events explicitly + +- `* -quic:version_information`: enable all events except certain events