diff options
| author | Hugo Landau <hlandau@openssl.org> | 2024-01-22 14:41:44 +0000 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2024-02-02 11:50:03 +0000 |
| commit | 613917ea0c5074700990851cb98b07f38c5b82b7 (patch) | |
| tree | d92a3bd93bd04fa2ed27e1f80d33b2ecd5ce3964 /doc/designs | |
| parent | 9dcad79795a74b1fe7ecb001f9f65f940cfd4848 (diff) | |
QUIC QLOG: Clarify filter docs
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22037)
Diffstat (limited to 'doc/designs')
| -rw-r--r-- | doc/designs/quic-design/qlog.md | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/designs/quic-design/qlog.md b/doc/designs/quic-design/qlog.md index b04d56f402..33d2191321 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 |