Internet-Draft | qlog Datagram extension | October 2022 |
Marx | Expires 27 April 2023 | [Page] |
This document describes qlog data type definitions for both the QUIC Datagram Frame defined in [RFC9221] and the HTTP/3 Datagram Frame defined in [RFC9297]. These data types are intended for use within event definitions defined in [QLOG-QUIC] and [QLOG-HTTP3].¶
This note is to be removed before publishing as an RFC.¶
The latest revision of this draft can be found at https://rmarx.github.io/draft-marx-quic-qlog-datagram/draft-marx-quic-qlog-datagram.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-marx-quic-qlog-datagram/.¶
Discussion of this document takes place on the QUIC Working Group mailing list (mailto:quic@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/quic/. Subscribe at https://www.ietf.org/mailman/listinfo/quic/.¶
Source for this draft and an issue tracker can be found at https://github.com/rmarx/draft-marx-quic-qlog-datagram.¶
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 27 April 2023.¶
Copyright (c) 2022 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 qlog data type definitions for both the QUIC Datagram Frame defined in [RFC9221] and the HTTP/3 Datagram Frame defined in [RFC9297]. These data types are intended for use within event definitions defined in [QLOG-QUIC] and [QLOG-HTTP3].¶
This document extends the $QuicFrame
extension point defined in [QLOG-QUIC]
and the $HTTPFrame
extension point defined in [QLOG-HTTP3]. It also defines
how to log a QUIC transport parameter for indicating QUIC datagram support, as
well as an HTTP/3 setting to indicate HTTP/3 datagram support.¶
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 ths document are expressed in the Concise Data Definition Language [CDDL] and its extensions described in [QLOG-MAIN].¶
The following fields from [QLOG-MAIN] are imported and used: data and RawInfo.¶
qlog support for QUIC Datagram frames consists of two aspects:¶
Support for the QUIC Datagram extension defined in [RFC9221] is signaled using the max_datagram_frame_size
transport parameter, defined in Section 3 of [RFC9221].¶
If utilized, this transport parameter MUST be logged as a field of the
transport:parameters_set
event defined in [QLOG-QUIC], more specifically:¶
TransportParametersSet = { ? max_datagram_frame_size: uint64 * text => any }
This section describes a qlog data type that can be used to log the contents of the QUIC DATAGRAM frame defined in Section 4 of [RFC9221].¶
The $QuicFrame
extension point defined in [QLOG-QUIC] is utilized to link
the QUICDatagramFrame type to the existing qlog data types.¶
QUICDatagramFrame = { frame_type: "datagram" ? length: uint64 ? raw: RawInfo } $QuicFrame /= QUICDatagramFrame
qlog support for HTTP/3 Datagram frames consists of two aspects:¶
Support for the HTTP/3 Datagram extension defined in [RFC9297] is signaled using the SETTINGS_H3_DATAGRAM
setting, defined in Section 2.1.1 of [RFC9297].¶
If utilized, this setting MUST be logged as a field of the HTTPSetting
data
type defined in [QLOG-HTTP3], more specifically:¶
HTTP3DatagramSetting = { name: "SETTINGS_H3_DATAGRAM" value: uint16 }
This section describes a qlog data type that can be used to log the contents of the HTTP/3 DATAGRAM frame defined in Section 2 of [RFC9297].¶
The $HTTPFrame
extension point defined in [QLOG-HTTP3] is utilized to link
the HTTPDatagramFrame type to the existing qlog data types.¶
HTTPDatagramFrame = { frame_type: "datagram" quarter_stream_id: uint64 ? raw: RawInfo } $HTTPFrame /= HTTPDatagramFrame
The security and privacy considerations discussed in [QLOG-MAIN] apply to this document as well.¶
This document has no IANA actions.¶
TODO acknowledge.¶