]> KU Leuven

robin.marx@kuleuven.be

Facebook

lniccolini@fb.com

Protocol Labs

marten@protocol.ai

Transport QUIC Internet-Draft This document describes concrete qlog event definitions and their metadata for HTTP/3 and QPACK-related events. These events can then be embedded in the higher level schema defined in .

Introduction This document describes the values of the qlog name ("category" + "event") and "data" fields and their semantics for the HTTP/3 and QPACK protocols. This document is based on draft-34 of the HTTP/3 I-D and draft-21 of the QPACK I-D . QUIC events are defined in a separate document . Feedback and discussion are welcome at https://github.com/quicwg/qlog. Readers are advised to refer to the "editor's draft" at that URL for an up-to-date version of this document. Concrete examples of integrations of this schema in various programming languages can be found at https://github.com/quiclog/qlog/.

Notational Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in . The event and data structure definitions in ths document are expressed in the Concise Data Definition Language and its extensions described in .

Overview This document describes the values of the qlog "name" ("category" + "event") and "data" fields and their semantics for the HTTP/3 and QPACK protocols. This document assumes the usage of the encompassing main qlog schema defined in . Each subsection below defines a separate category (for example http, qpack) and each subsubsection is an event type (for example frame_created). For each event type, its importance and data definition is laid out, often accompanied by possible values for the optional "trigger" field. For the definition and semantics of "importance" and "trigger", see the main schema document. Most of the complex datastructures, enums and re-usable definitions are grouped together on the bottom of this document for clarity.

Usage with QUIC The events described in this document can be used with or without logging the related QUIC events defined in . If used with QUIC events, the QUIC document takes precedence in terms of recommended filenames and trace separation setups. If used without QUIC events, it is recommended that the implementation assign a globally unique identifier to each HTTP/3 connection. This ID can then be used as the value of the qlog "group_id" field, as well as the qlog filename or file identifier, potentially suffixed by the vantagepoint type (For example, abcd1234_server.qlog would contain the server-side trace of the connection with GUID abcd1234).

Links to the main schema This document re-uses all the fields defined in the main qlog schema (e.g., name, category, type, data, group_id, protocol_type, the time-related fields, importance, RawInfo, etc.). One entry in the "protocol_type" qlog array field MUST be "HTTP3" if events from this document are included in a qlog trace.

Raw packet and frame information This document re-uses the definition of the RawInfo data class from .

Note:

As HTTP/3 does not use trailers in frames, each HTTP/3 frame header_length can be calculated as header_length = RawInfo:length - RawInfo:payload_length

Note:

In some cases, the length fields are also explicitly reflected inside of frame headers. For example, all HTTP/3 frames include their explicit payload lengths in the frame header. In these cases, those fields are intentionally preserved in the event definitions. Even though this can lead to duplicate data when the full RawInfo is logged, it allows a more direct mapping of the HTTP/3 specifications to qlog, making it easier for users to interpret. In this case, both fields MUST have the same value.

HTTP/3 and QPACK event definitions Each subheading in this section is a qlog event category, while each sub-subheading is a qlog event type. For example, for the following two items, we have the category "http" and event type "parameters_set", resulting in a concatenated qlog "name" field value of "http:parameters_set".

http Note: like all category values, the "http" category is written in lowercase.

parameters_set Importance: Base This event contains HTTP/3 and QPACK-level settings, mostly those received from the HTTP/3 SETTINGS frame. All these parameters are typically set once and never change. However, they are typically set at different times during the connection, so there can be several instances of this event with different fields set. Note that some settings have two variations (one set locally, one requested by the remote peer). This is reflected in the "owner" field. As such, this field MUST be correct for all settings included a single event instance. If you need to log settings from two sides, you MUST emit two separate event instances. Note: we use the CDDL unwrap operator (~) here to make HTTPParameters into a re-usable list of fields. The unwrap operator copies the fields from the referenced type into the target type directly, extending the target with the unwrapped fields. TODO: explain this better + provide reference and maybe an example. Definition:

HTTPParametersSet definition uint64 } ]]>

Note: enabling server push is not explicitly done in HTTP/3 by use of a setting or parameter. Instead, it is communicated by use of the MAX_PUSH_ID frame, which should be logged using the frame_created and frame_parsed events below. Additionally, this event can contain any number of unspecified fields. This is to reflect setting of for example unknown (greased) settings or parameters of (proprietary) extensions.

parameters_restored Importance: Base When using QUIC 0-RTT, HTTP/3 clients are expected to remember and reuse the server's SETTINGs from the previous connection. This event is used to indicate which HTTP/3 settings were restored and to which values when utilizing 0-RTT. Definition:

HTTPParametersRestored definition

Note that, like for parameters_set above, this event can contain any number of unspecified fields to allow for additional and custom settings.

stream_type_set Importance: Base Emitted when a stream's type becomes known. This is typically when a stream is opened and the stream's type indicator is sent or received. Note: most of this information can also be inferred by looking at a stream's id, since id's are strictly partitioned at the QUIC level. Even so, this event has a "Base" importance because it helps a lot in debugging to have this information clearly spelled out. Definition:

HTTPStreamTypeSet definition

frame_created Importance: Core HTTP equivalent to the packet_sent event. This event is emitted when the HTTP/3 framing actually happens. Note: this is not necessarily the same as when the HTTP/3 data is passed on to the QUIC layer. For that, see the "data_moved" event in . Definition:

HTTPFrameCreated definition

Note: in HTTP/3, DATA frames can have arbitrarily large lengths to reduce frame header overhead. As such, DATA frames can span many QUIC packets and can be created in a streaming fashion. In this case, the frame_created event is emitted once for the frame header, and further streamed data is indicated using the data_moved event.

frame_parsed Importance: Core HTTP equivalent to the packet_received event. This event is emitted when we actually parse the HTTP/3 frame. Note: this is not necessarily the same as when the HTTP/3 data is actually received on the QUIC layer. For that, see the "data_moved" event in . Definition:

HTTPFrameParsed definition

Note: in HTTP/3, DATA frames can have arbitrarily large lengths to reduce frame header overhead. As such, DATA frames can span many QUIC packets and can be processed in a streaming fashion. In this case, the frame_parsed event is emitted once for the frame header, and further streamed data is indicated using the data_moved event.

push_resolved Importance: Extra This event is emitted when a pushed resource is successfully claimed (used) or, conversely, abandoned (rejected) by the application on top of HTTP/3 (e.g., the web browser). This event is added to help debug problems with unexpected PUSH behaviour, which is commonplace with HTTP/2. Definition:

HTTPPushResolved definition

qpack Note: like all category values, the "qpack" category is written in lowercase. The QPACK events mainly serve as an aid to debug low-level QPACK issues. The higher-level, plaintext header values SHOULD (also) be logged in the http.frame_created and http.frame_parsed event data (instead). Note: qpack does not have its own parameters_set event. This was merged with http.parameters_set for brevity, since qpack is a required extension for HTTP/3 anyway. Other HTTP/3 extensions MAY also log their SETTINGS fields in http.parameters_set or MAY define their own events.

state_updated Importance: Base This event is emitted when one or more of the internal QPACK variables changes value. Note that some variables have two variations (one set locally, one requested by the remote peer). This is reflected in the "owner" field. As such, this field MUST be correct for all variables included a single event instance. If you need to log settings from two sides, you MUST emit two separate event instances. Definition:

QPACKStateUpdate definition

stream_state_updated Importance: Core This event is emitted when a stream becomes blocked or unblocked by header decoding requests or QPACK instructions. Note: This event is of "Core" importance, as it might have a large impact on HTTP/3's observed performance. Definition:

QPACKStreamStateUpdate definition

dynamic_table_updated Importance: Extra This event is emitted when one or more entries are inserted or evicted from QPACK's dynamic table. Definition:

QPACKDynamicTableUpdate definition

headers_encoded Importance: Base This event is emitted when an uncompressed header block is encoded successfully. Note: this event has overlap with http.frame_created for the HeadersFrame type. When outputting both events, implementers MAY omit the "headers" field in this event. Definition:

QPACKHeadersEncoded definition

headers_decoded Importance: Base This event is emitted when a compressed header block is decoded successfully. Note: this event has overlap with http.frame_parsed for the HeadersFrame type. When outputting both events, implementers MAY omit the "headers" field in this event. Definition:

QPACKHeadersDecoded definition

instruction_created Importance: Base This event is emitted when a QPACK instruction (both decoder and encoder) is created and added to the encoder/decoder stream. Definition:

QPACKInstructionCreated definition

Note: encoder/decoder semantics and stream_id's are implicit in either the instruction types or can be logged via other events (e.g., http.stream_type_set)

instruction_parsed Importance: Base This event is emitted when a QPACK instruction (both decoder and encoder) is read from the encoder/decoder stream. Definition:

QPACKInstructionParsed definition

Note: encoder/decoder semantics and stream_id's are implicit in either the instruction types or can be logged via other events (e.g., http.stream_type_set)

Security Considerations TBD

IANA Considerations TBD

References Normative References Akamai Technologies Google, Inc Akamai Technologies Facebook KU Leuven Facebook Protocol Labs KU Leuven Facebook Protocol Labs This document proposes a notational convention to express Concise Binary Object Representation (CBOR) data structures (RFC 7049). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON. Informative References In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.

HTTP/3 data field definitions

ProtocolEventBody extension We extend the $ProtocolEventBody extension point defined in with the HTTP/3 protocol events defined in this document.

HTTPEvents definition and ProtocolEventBody extension

Owner

Owner definition

HTTP/3 Frames

HTTPFrame definition

DataFrame

HTTPDataFrame definition

HeadersFrame This represents an uncompressed, plaintext HTTP Headers frame (e.g., no QPACK compression is applied). For example:

HTTPHeadersFrame example

HTTPHeadersFrame definition

HTTPField definition

CancelPushFrame

HTTPCancelPushFrame definition

SettingsFrame

HTTPSettingsFrame definition

PushPromiseFrame

HTTPPushPromiseFrame definition

GoAwayFrame

HTTPGoawayFrame definition

MaxPushIDFrame

HTTPMaxPushIDFrame definition

ReservedFrame

HTTPReservedFrame definition

UnknownFrame HTTP/3 qlog re-uses QUIC's UnknownFrame definition, since their values and usage overlaps. See .

ApplicationError

HTTPApplicationError definition

The HTTPApplicationError defines the general $ApplicationError definition in the qlog QUIC definition, see .

QPACK DATA type definitions

ProtocolEventBody extension We extend the $ProtocolEventBody extension point defined in with the QPACK protocol events defined in this document.

QPACKEvents definition and ProtocolEventBody extension

QPACK Instructions Note: the instructions do not have explicit encoder/decoder types, since there is no overlap between the insturctions of both types in neither name nor function.

QPACKInstruction definition

SetDynamicTableCapacityInstruction

SetDynamicTableCapacityInstruction definition

InsertWithNameReferenceInstruction

InsertWithNameReferenceInstruction definition

InsertWithoutNameReferenceInstruction

InsertWithoutNameReferenceInstruction definition

DuplicateInstruction

DuplicateInstruction definition

SectionAcknowledgementInstruction

SectionAcknowledgementInstruction definition

StreamCancellationInstruction

StreamCancellationInstruction definition

InsertCountIncrementInstruction

InsertCountIncrementInstruction definition

QPACK Header compression

QPACKHeaderBlockRepresentation definition

IndexedHeaderField Note: also used for "indexed header field with post-base index"

IndexedHeaderField definition

LiteralHeaderFieldWithName Note: also used for "Literal header field with post-base name reference"

LiteralHeaderFieldWithName definition

LiteralHeaderFieldWithoutName

LiteralHeaderFieldWithoutName definition

QPACKHeaderBlockPrefix

QPACKHeaderBlockPrefix definition

QPACKTableType

QPACKTableType definition

Change Log

Since draft-ietf-quic-qlog-h3-events-00:

• Change the data definition language from TypeScript to CDDL (#143)

Since draft-marx-qlog-event-definitions-quic-h3-02:

• These changes were done in preparation of the adoption of the drafts by the QUIC working group (#137)
• Split QUIC and HTTP/3 events into two separate documents
• Moved RawInfo, Importance, Generic events and Simulation events to the main schema document.

Since draft-marx-qlog-event-definitions-quic-h3-01: Major changes:

• Moved data_moved from http to transport. Also made the "from" and "to" fields flexible strings instead of an enum (#111,#65)
• Moved packet_type fields to PacketHeader. Moved packet_size field out of PacketHeader to RawInfo:length (#40)
• Made events that need to log packet_type and packet_number use a header field instead of logging these fields individually
• Added support for logging retry, stateless reset and initial tokens (#94,#86,#117)
• Moved separate general event categories into a single category "generic" (#47)
• Added "transport:connection_closed" event (#43,#85,#78,#49)
• Added version_information and alpn_information events (#85,#75,#28)
• Added parameters_restored events to help clarify 0-RTT behaviour (#88)

Smaller changes:

• Merged loss_timer events into one loss_timer_updated event
• Field data types are now strongly defined (#10,#39,#36,#115)
• Renamed qpack instruction_received and instruction_sent to instruction_created and instruction_parsed (#114)
• Updated qpack:dynamic_table_updated.update_type. It now has the value "inserted" instead of "added" (#113)
• Updated qpack:dynamic_table_updated. It now has an "owner" field to differentiate encoder vs decoder state (#112)
• Removed push_allowed from http:parameters_set (#110)
• Removed explicit trigger field indications from events, since this was moved to be a generic property of the "data" field (#80)
• Updated transport:connection_id_updated to be more in line with other similar events. Also dropped importance from Core to Base (#45)
• Added length property to PaddingFrame (#34)
• Added packet_number field to transport:frames_processed (#74)
• Added a way to generically log packet header flags (first 8 bits) to PacketHeader
• Added additional guidance on which events to log in which situations (#53)
• Added "simulation:scenario" event to help indicate simulation details
• Added "packets_acked" event (#107)
• Added "datagram_ids" to the datagram_X and packet_X events to allow tracking of coalesced QUIC packets (#91)
• Extended connection_state_updated with more fine-grained states (#49)

Since draft-marx-qlog-event-definitions-quic-h3-00:

• Event and category names are now all lowercase
• Added many new events and their definitions
• "type" fields have been made more specific (especially important for PacketType fields, which are now called packet_type instead of type)
• Events are given an importance indicator (issue #22)
• Event names are more consistent and use past tense (issue #21)
• Triggers have been redefined as properties of the "data" field and updated for most events (issue #23)

Design Variations TBD

Acknowledgements Much of the initial work by Robin Marx was done at Hasselt University. Thanks to Marten Seemann, Jana Iyengar, Brian Trammell, Dmitri Tikhonov, Stephen Petrides, Jari Arkko, Marcus Ihlar, Victor Vasiliev, Mirja Kuehlewind, Jeremy Laine, Kazu Yamamoto, Christian Huitema, and Lucas Pardue for their feedback and suggestions.