| Internet-Draft | RoQ qlog event definitions | July 2024 |
| Engelbart & Ott | Expires 2 January 2025 | [Page] |
This document describes concrete qlog event definitions and their metadata for RTP over QUIC [I-D.draft-ietf-avtcore-rtp-over-quic] related events. These events can then be embedded in the higher level schema defined in [I-D.draft-ietf-quic-qlog-main-schema].¶
This note is to be removed before publishing as an RFC.¶
The latest revision of this draft can be found at https://mengelbart.github.io/draft-engelbart-qlog-roq-events/draft-engelbart-qlog-roq-events.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-engelbart-qlog-roq-events/.¶
Source for this draft and an issue tracker can be found at https://github.com/mengelbart/draft-engelbart-qlog-roq-events.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 2 January 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document describes the values of the qlog name ("category" + "event") and "data" fields and their semantics for RTP over QUIC ([I-D.draft-ietf-avtcore-rtp-over-quic]).¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The event and data structure definitions in this document are expressed in the Concise Data Definition Language [RFC8610] and its extensions described in [I-D.draft-ietf-quic-qlog-main-schema].¶
TODO: Check if we need all these imports:¶
The following fields from [I-D.draft-ietf-quic-qlog-main-schema] are imported and used: name, category, type, data, group_id, protocol_type, importance, RawInfo, and time-related fields.¶
As is the case for [I-D.draft-ietf-quic-qlog-main-schema], the qlog schema definitions in this document are intentionally agnostic to serialization formats. The choice of format is an implementation decision.¶
This document describes how RoQ can be expressed in qlog using the schema defined in [I-D.draft-ietf-quic-qlog-main-schema]. RoQ events are defined with a category, a name (the concatenation of "category" and "event"), an "importance", and "data" fields.¶
When any event from this document is included in a qlog trace, the "protocol_type" qlog array field MUST contain an entry with the value "RoQ".¶
The events described in this document can be used with or without logging the related QUIC events defined in [I-D.draft-ietf-quic-qlog-quic-events]. 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 RoQ connection. This identifier 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 identifier abcd1234).¶
This document defines events in the roq category.¶
As described in Section 3.4.2 of [I-D.draft-ietf-quic-qlog-main-schema], the qlog "name" field is the concatenation of category and type.¶
Table 1 summarizes the name value of each event type that is defined in this specification.¶
| Name value | Importance | Definition |
|---|---|---|
| roq:stream_opened | Base | Section 5.1 |
| roq:stream_packet_created | Core | Section 5.2 |
| roq:stream_packet_parsed | Core | Section 5.3 |
| roq:datagram_packet_created | Core | Section 5.4 |
| roq:datagram_packet_parsed | Core | Section 5.5 |
RoQ events extend the $ProtocolEventData extension point defined in
[I-D.draft-ietf-quic-qlog-main-schema].¶
RoQEventData = RoQStreamOpened /
RoQStreamPacketCreated /
RoQStreamPacketParsed /
RoQDatagramPacketCreated /
RoQDatagramPacketParsed
$ProtocolEventData /= RoQEventData
RoQ events are logged when a certain condition happens at the application layer, and there isn't always a one to one mapping between RoQ and QUIC events. The exchange of data between the RoQ and QUIC layer is logged via the "stream_data_moved" and "datagram_data_moved" events in [I-D.draft-ietf-quic-qlog-quic-events].¶
The stream_opened event is emitted when a new QUIC stream for sending RoQ
packets is opened. It has Base importance level; see Section 9.2 of [I-D.draft-ietf-quic-qlog-main-schema].¶
RoQStreamOpened = {
flow_id: uint64
stream_id: uint64
}
The stream_packet_created event is emitted when a RoQ packet to be sent on a
QUIC stream is created. It has Core importance level; see Section 9.2 of [I-D.draft-ietf-quic-qlog-main-schema].¶
This event is not necessarily the same as when the packet is passed to the QUIC
layer. For that, see the stream_data_moved event in
[I-D.draft-ietf-quic-qlog-quic-events].¶
RoQStreamPacketCreated = {
~RoQPacket
stream_id: uint64
}
The stream_packet_parsed event is emitted when a RoQ packet received from a
QUIC stream is parsed. It has Core importance level; see Section 92. of [I-D.draft-ietf-quic-qlog-main-schema].¶
The event is not necessarily the same as when the packet is received from the
QUIC layer. For that see stream_data_moved event in
[I-D.draft-ietf-quic-qlog-quic-events].¶
RoQStreamPacketParsed = {
~RoQPacket
stream_id: uint64
}
The roq_datagram_packet_created event is emitted when a RoQ packet to be sent
in a QUIC Datagram is created. It has Core importance level; see Section 9.2 of [I-D.draft-ietf-quic-qlog-main-schema].¶
This event is not necessarily the same as when the packet is passed to the QUIC
layer. For that, see the datagram_data_moved event in
[I-D.draft-ietf-quic-qlog-quic-events].¶
RoQDatagramPacketCreated = {
~RoQPacket
}
The datagram_packet_parsed event is emitted when a RoQ packet received in a
QUIC Datagram is parsed. It has Core importance level; see Section 92. of [I-D.draft-ietf-quic-qlog-main-schema].¶
The event is not necessarily the same as when the packet is received from the
QUIC layer. For that see datagram_data_moved event in
[I-D.draft-ietf-quic-qlog-quic-events].¶
RoQDatagramPacketParsed = {
~RoQPacket
}
The following data field definitions can be used in RoQ events.¶
RoQPacket = {
flow_id: uint64
length: uint64
}
RoQApplicationError = "roq_no_error" /
"roq_general_error" /
"roq_internal_error" /
"roq_packet_error" /
"roq_stream_creation_error" /
"roq_frame_cancelled_error" /
"roq_unknown_flow_id_error" /
"roq_expectation_unmet_error"
The RoQApplicationError extends the general $ApplicationError definition in
the qlog QUIC definition, see [I-D.draft-ietf-quic-qlog-main-schema].¶
$ApplicationError /= RoQApplicationError¶
The security and privacy considerations discussed in [I-D.draft-ietf-quic-qlog-main-schema] apply to this document as well.¶
TODO¶
The authors would like to thank Lucas Pardue for their valuable comments and suggestions contributing to this document.¶