]> Technical University of Munich

mathis.engelbart@gmail.com

Technical University of Munich

ott@in.tum.de

RoQ qlog RTP QUIC This document describes concrete qlog event definitions and their metadata for RTP over QUIC related events. These events can then be embedded in the higher level schema defined in . About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Source for this draft and an issue tracker can be found at .

Introduction This document describes the values of the qlog name ("category" + "event") and "data" fields and their semantics for RTP over QUIC ().

Conventions and Definitions 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 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 and its extensions described in . TODO: Check if we need all these imports: The following fields from are imported and used: name, category, type, data, group_id, protocol_type, importance, RawInfo, and time-related fields. As is the case for , the qlog schema definitions in this document are intentionally agnostic to serialization formats. The choice of format is an implementation decision.

Overview This document describes how RoQ can be expressed in qlog using the schema defined in . 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".

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 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).

RoQ Event Overview This document defines events in the roq category. As described in , the qlog "name" field is the concatenation of category and type. summarizes the name value of each event type that is defined in this specification. RoQ Events

Name value	Importance	Definition
roq:stream_opened	Base
roq:stream_packet_created	Core
roq:stream_packet_parsed	Core
roq:datagram_packet_created	Core
roq:datagram_packet_parsed	Core

RoQ Events RoQ events extend the $ProtocolEventData extension point defined in .

RoQEventData definition and ProtocolEventData extension

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 .

RoQ Stream Opened The stream_opened event is emitted when a new QUIC stream for sending RoQ packets is opened. It has Base importance level; see .

RoQStreamOpened definition

RoQ Stream Packet Created 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 . 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 .

RoQStreamPacketCreated definition

RoQ Stream Packet Parsed The stream_packet_parsed event is emitted when a RoQ packet received from a QUIC stream is parsed. It has Core importance level; see . 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 .

RoQStreamPacketParsed definition

RoQ Datagram Packet Created 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 . 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 .

RoQDatagramPacketCreated definition

RoQ Datagram Packet Parsed The datagram_packet_parsed event is emitted when a RoQ packet received in a QUIC Datagram is parsed. It has Core importance level; see . 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 .

RoQDatagramPacketParsed definition

RoQ Data Field Definitions The following data field definitions can be used in RoQ events.

RoQ Packet

RoQPacket definition

RoQ Application Error

RoQApplicationError definition

The RoQApplicationError extends the general $ApplicationError definition in the qlog QUIC definition, see .

Security Considerations The security and privacy considerations discussed in apply to this document as well.

IANA Considerations TODO

Normative References Technical University Munich Technical University Munich Tencent America LLC This document specifies a minimal mapping for encapsulating Real-time Transport Protocol (RTP) and RTP Control Protocol (RTCP) packets within the QUIC protocol. This mapping is called RTP over QUIC (RoQ). This document also discusses how to leverage state that is already available from the QUIC implementation in the endpoints, in order to reduce the need to exchange RTCP packets, and describes different options for implementing congestion control and rate adaptation for RTP without relying on RTCP feedback. Akamai Meta Cloudflare This document defines qlog, an extensible high-level schema for a standardized logging format. It allows easy sharing of data, benefitting common debug and analysis methods and tooling. The high- level schema is independent of protocol; separate documents extend qlog for protocol-specific data. The schema is also independent of serialization format, allowing logs to be represented in many ways such as JSON, CSV, or protobuf. Note to Readers Note to RFC editor: Please remove this section before publication. Feedback and discussion are welcome at https://github.com/quicwg/qlog (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/ (https://github.com/quiclog/qlog/). 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. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. 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. Akamai Meta Cloudflare This document describes concrete qlog event definitions and their metadata for QUIC events. These events can then be embedded in the higher level schema defined in [QLOG-MAIN]. Note to Readers Note to RFC editor: Please remove this section before publication. Feedback and discussion are welcome at https://github.com/quicwg/qlog (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/ (https://github.com/quiclog/qlog/).

Acknowledgments The authors would like to thank Lucas Pardue for their valuable comments and suggestions contributing to this document.