RoQ qlog event definitions

Status of This Memo

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 Notice

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

Table of Contents

1. Introduction

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

2. 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 [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.¶

3. Overview

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".¶

4. RoQ Event Overview

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

5. RoQ Events

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].¶

RoQStreamOpened = {
    flow_id: uint64
    stream_id: uint64
}

RoQStreamPacketCreated = {
    ~RoQPacket
    stream_id: uint64
}

RoQStreamPacketParsed = {
    ~RoQPacket
    stream_id: uint64
}

RoQDatagramPacketCreated = {
    ~RoQPacket
}

RoQDatagramPacketParsed = {
    ~RoQPacket
}

6. RoQ Data Field Definitions

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"

$ApplicationError /= RoQApplicationError

7. Security Considerations

The security and privacy considerations discussed in [I-D.draft-ietf-quic-qlog-main-schema] apply to this document as well.¶

8. IANA Considerations

TODO¶

9. Normative References

[I-D.draft-ietf-avtcore-rtp-over-quic]

Ott, J., Engelbart, M., and S. Dawkins, "RTP over QUIC (RoQ)", Work in Progress, Internet-Draft, draft-ietf-avtcore-rtp-over-quic-10, 8 May 2024, <https://datatracker.ietf.org/doc/html/draft-ietf-avtcore-rtp-over-quic-10>.

[I-D.draft-ietf-quic-qlog-main-schema]

Marx, R., Niccolini, L., Seemann, M., and L. Pardue, "Main logging schema for qlog", Work in Progress, Internet-Draft, draft-ietf-quic-qlog-main-schema-08, 4 March 2024, <https://datatracker.ietf.org/doc/html/draft-ietf-quic-qlog-main-schema-08>.

[I-D.draft-ietf-quic-qlog-quic-events]

Marx, R., Niccolini, L., Seemann, M., and L. Pardue, "QUIC event definitions for qlog", Work in Progress, Internet-Draft, draft-ietf-quic-qlog-quic-events-07, 4 March 2024, <https://datatracker.ietf.org/doc/html/draft-ietf-quic-qlog-quic-events-07>.

[RFC2119]

Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/rfc/rfc2119>.

[RFC8174]

Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/rfc/rfc8174>.

[RFC8610]

Birkholz, H., Vigano, C., and C. Bormann, "Concise Data Definition Language (CDDL): A Notational Convention to Express Concise Binary Object Representation (CBOR) and JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, June 2019, <https://www.rfc-editor.org/rfc/rfc8610>.

Acknowledgments

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

Authors' Addresses