Internet DRAFT - draft-ietf-quic-qlog-h3-events

draft-ietf-quic-qlog-h3-events







QUIC                                                        R. Marx, Ed.
Internet-Draft                                                    Akamai
Intended status: Standards Track                       L. Niccolini, Ed.
Expires: 5 September 2024                                           Meta
                                                         M. Seemann, Ed.
                                                                        
                                                          L. Pardue, Ed.
                                                              Cloudflare
                                                            4 March 2024


                     HTTP/3 qlog event definitions
                   draft-ietf-quic-qlog-h3-events-07

Abstract

   This document describes concrete qlog event definitions and their
   metadata for HTTP/3-related 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/).

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




Marx, et al.            Expires 5 September 2024                [Page 1]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   This Internet-Draft will expire on 5 September 2024.

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  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   3
   2.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     2.1.  Usage with QUIC . . . . . . . . . . . . . . . . . . . . .   4
   3.  HTTP/3 Event Overview . . . . . . . . . . . . . . . . . . . .   4
   4.  HTTP/3 Events . . . . . . . . . . . . . . . . . . . . . . . .   5
     4.1.  parameters_set  . . . . . . . . . . . . . . . . . . . . .   6
     4.2.  parameters_restored . . . . . . . . . . . . . . . . . . .   7
     4.3.  stream_type_set . . . . . . . . . . . . . . . . . . . . .   7
     4.4.  priority_updated  . . . . . . . . . . . . . . . . . . . .   8
     4.5.  frame_created . . . . . . . . . . . . . . . . . . . . . .   9
     4.6.  frame_parsed  . . . . . . . . . . . . . . . . . . . . . .   9
     4.7.  datagram_created  . . . . . . . . . . . . . . . . . . . .   9
     4.8.  datagram_parsed . . . . . . . . . . . . . . . . . . . . .  10
     4.9.  push_resolved . . . . . . . . . . . . . . . . . . . . . .  10
   5.  HTTP/3 Data Field Definitions . . . . . . . . . . . . . . . .  11
     5.1.  Owner . . . . . . . . . . . . . . . . . . . . . . . . . .  11
     5.2.  H3Frame . . . . . . . . . . . . . . . . . . . . . . . . .  11
     5.3.  H3Datagram  . . . . . . . . . . . . . . . . . . . . . . .  12
       5.3.1.  H3DataFrame . . . . . . . . . . . . . . . . . . . . .  12
       5.3.2.  H3HeadersFrame  . . . . . . . . . . . . . . . . . . .  12
       5.3.3.  H3CancelPushFrame . . . . . . . . . . . . . . . . . .  13
       5.3.4.  H3SettingsFrame . . . . . . . . . . . . . . . . . . .  13
       5.3.5.  H3PushPromiseFrame  . . . . . . . . . . . . . . . . .  14
       5.3.6.  H3GoAwayFrame . . . . . . . . . . . . . . . . . . . .  14
       5.3.7.  H3MaxPushIDFrame  . . . . . . . . . . . . . . . . . .  14
       5.3.8.  H3PriorityUpdateFrame . . . . . . . . . . . . . . . .  14
       5.3.9.  H3ReservedFrame . . . . . . . . . . . . . . . . . . .  15
       5.3.10. H3UnknownFrame  . . . . . . . . . . . . . . . . . . .  15
       5.3.11. H3ApplicationError  . . . . . . . . . . . . . . . . .  15



Marx, et al.            Expires 5 September 2024                [Page 2]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   6.  Security and Privacy Considerations . . . . . . . . . . . . .  16
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  16
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  16
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .  16
     8.2.  Informative References  . . . . . . . . . . . . . . . . .  18
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  18
   Change Log  . . . . . . . . . . . . . . . . . . . . . . . . . . .  18
     Since draft-ietf-quic-qlog-h3-events-06:  . . . . . . . . . . .  18
     Since draft-ietf-quic-qlog-h3-events-05:  . . . . . . . . . . .  18
     Since draft-ietf-quic-qlog-h3-events-04:  . . . . . . . . . . .  18
     Since draft-ietf-quic-qlog-h3-events-03:  . . . . . . . . . . .  19
     Since draft-ietf-quic-qlog-h3-events-02:  . . . . . . . . . . .  19
     Since draft-ietf-quic-qlog-h3-events-01:  . . . . . . . . . . .  19
     Since draft-ietf-quic-qlog-h3-events-00:  . . . . . . . . . . .  19
     Since draft-marx-qlog-event-definitions-quic-h3-02: . . . . . .  19
     Since draft-marx-qlog-event-definitions-quic-h3-01: . . . . . .  20
     Since draft-marx-qlog-event-definitions-quic-h3-00: . . . . . .  21
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  21

1.  Introduction

   This document describes the values of the qlog name ("category" +
   "event") and "data" fields and their semantics for the HTTP/3
   protocol [HTTP/3] and some of extensions (see [EXTENDED-CONNECT],
   [H3_PRIORITIZATION] and [H3-DATAGRAM]).

1.1.  Notational Conventions

   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: name,
   category, type, data, group_id, protocol_type, importance, RawInfo,
   and time-related fields.

   As is the case for [QLOG-MAIN], the qlog schema definitions in this
   document are intentionally agnostic to serialization formats.  The
   choice of format is an implementation decision.






Marx, et al.            Expires 5 September 2024                [Page 3]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


2.  Overview

   This document describes how HTTP/3 can be expressed in qlog using the
   schema defined in [QLOG-MAIN].  HTTP/3 events are defined with a
   category, a name (the concatenation of "category" and "event"), an
   "importance", an optional "trigger", and "data" fields.

   Some data fields use complex datastructures.  These are represented
   as enums or re-usable definitions, which are grouped together on the
   bottom of this document for clarity.

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

2.1.  Usage with QUIC

   The events described in this document can be used with or without
   logging the related QUIC events defined in [QLOG-QUIC].  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).

3.  HTTP/3 Event Overview

   This document defines events in two categories, written as lowercase
   to follow convention: h3 (Section 4).

   As described in Section 3.4.2 of [QLOG-MAIN], 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.











Marx, et al.            Expires 5 September 2024                [Page 4]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


           +========================+============+=============+
           | Name value             | Importance | Definition  |
           +========================+============+=============+
           | h3:parameters_set      | Base       | Section 4.1 |
           +------------------------+------------+-------------+
           | h3:parameters_restored | Base       | Section 4.2 |
           +------------------------+------------+-------------+
           | h3:stream_type_set     | Base       | Section 4.3 |
           +------------------------+------------+-------------+
           | h3:priority_updated    | Base       | Section 4.4 |
           +------------------------+------------+-------------+
           | h3:frame_created       | Core       | Section 4.5 |
           +------------------------+------------+-------------+
           | h3:frame_parsed        | Core       | Section 4.6 |
           +------------------------+------------+-------------+
           | h3:datagram_created    | Base       | Section 4.7 |
           +------------------------+------------+-------------+
           | h3:datagram_parsed     | Base       | Section 4.8 |
           +------------------------+------------+-------------+
           | h3:push_resolved       | Extra      | Section 4.9 |
           +------------------------+------------+-------------+

                           Table 1: HTTP/3 Events

4.  HTTP/3 Events

   HTTP/3 events extend the $ProtocolEventData extension point defined
   in [QLOG-MAIN].

   H3EventData = H3ParametersSet /
                 H3ParametersRestored /
                 H3StreamTypeSet /
                 H3PriorityUpdated /
                 H3FrameCreated /
                 H3FrameParsed /
                 H3DatagramCreated /
                 H3DatagramParsed /
                 H3PushResolved

   $ProtocolEventData /= H3EventData

      Figure 1: H3EventData definition and ProtocolEventData extension

   HTTP events are logged when a certain condition happens at the
   application layer, and there isn't always a one to one mapping
   between HTTP and QUIC events.  The exchange of data between the HTTP
   and QUIC layer is logged via the "stream_data_moved" and
   "datagram_data_moved" events in [QLOG-QUIC].



Marx, et al.            Expires 5 September 2024                [Page 5]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


4.1.  parameters_set

   The parameters_set event contains HTTP/3 and QPACK-level settings,
   mostly those received from the HTTP/3 SETTINGS frame.  It has Base
   importance level; see Section 9.2 of [QLOG-MAIN].

   All these parameters are typically set once and never change.
   However, they might be set at different times during the connection,
   therefore a qlog can have multiple instances of parameters_set with
   different fields set.

   The "owner" field reflects how Settings are exchanged on a
   connection.  Sent settings have the value "local" and received
   settings have the value "received".

   As a reminder the CDDL unwrap operator (~), see [RFC8610]), copies
   the fields from the referenced type (H3Parameters) into the target
   type directly, extending the target with the unwrapped fields.

   H3ParametersSet = {
       ? owner: Owner
       ~H3Parameters

       ; qlog-specific
       ; indicates whether this implementation waits for a SETTINGS
       ; frame before processing requests
       ? waits_for_settings: bool
   }

   H3Parameters = {
       ; RFC9114
       ? max_field_section_size: uint64

       ; RFC9204
       ? max_table_capacity: uint64
       ? blocked_streams_count: uint64

       ; RFC9220 (SETTINGS_ENABLE_CONNECT_PROTOCOL)
       ? extended_connect: uint16

       ; RFC9297 (SETTINGS_H3_DATAGRAM)
       ? h3_datagram: uint16

       ; additional settings for grease and extensions
       * text => uint64
   }

                    Figure 2: H3ParametersSet definition



Marx, et al.            Expires 5 September 2024                [Page 6]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   The parameters_set event can contain any number of unspecified
   fields.  This allows for representation of reserved settings (aka
   GREASE) or ad-hoc support for extension settings that do not have a
   related qlog schema definition.

4.2.  parameters_restored

   When using QUIC 0-RTT, HTTP/3 clients are expected to remember and
   reuse the server's SETTINGs from the previous connection.  The
   parameters_restored event is used to indicate which HTTP/3 settings
   were restored and to which values when utilizing 0-RTT.  It has Base
   importance level; see Section 9.2 of [QLOG-MAIN].

   H3ParametersRestored = {
       ~H3Parameters
   }

                 Figure 3: H3ParametersRestored definition

   The parameters_restored event can contain any number of unspecified
   fields.  This allows for representation of reserved settings (aka
   GREASE) or ad-hoc support for extension settings that do not have a
   related qlog schema definition.

4.3.  stream_type_set

   The stream_type_set event conveys when a HTTP/3 stream type becomes
   known; see Sections 6.1 and 6.2 of [HTTP/3].  It has Base importance
   level; see Section 9.2 of [QLOG-MAIN].

   Client bidirectional streams always have a stream_type value of
   "request".  Server bidirectional streams have no defined use,
   although extensions could change that.

   Unidirectional streams in either direction begin with with a
   variable-length integer type.  Where the type is not known, the
   stream_type value of "unknown" type can be used and the value
   captured in the stream_type_value field; a numerical value without
   variable-length integer encoding.












Marx, et al.            Expires 5 September 2024                [Page 7]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3StreamTypeSet = {
       ? owner: Owner
       stream_id: uint64
       stream_type: H3StreamType

       ; only when stream_type === "unknown"
       ? stream_type_value: uint64

       ; only when stream_type === "push"
       ? associated_push_id: uint64
   }

   H3StreamType =  "request" /
                     "control" /
                     "push" /
                     "reserved" /
                     "unknown" /
                     "qpack_encode" /
                     "qpack_decode"

                    Figure 4: H3StreamTypeSet definition

4.4.  priority_updated

   Emitted when the priority of a request stream or push stream is
   initialized or updated through mechanisms defined in [RFC9218].  For
   example, the priority can be updated through signals received from
   client and/or server (e.g., in HTTP/3 HEADERS or PRIORITY_UPDATE
   frames) or it can be changed or overridden due to local policies.
   The event has Base importance level; see Section 9.2 of [QLOG-MAIN].

   H3PriorityUpdated = {
       ; if the prioritized element is a request stream
       ? stream_id: uint64

       ; if the prioritized element is a push stream
       ? push_id: uint64

       ? old: H3Priority
       new: H3Priority
   }

                   Figure 5: H3PriorityUpdated definition








Marx, et al.            Expires 5 September 2024                [Page 8]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


4.5.  frame_created

   The frame_created event is emitted when the HTTP/3 framing actually
   happens.  It has Core importance level; see Section 9.2 of
   [QLOG-MAIN].

   This event does not necessarily coincide with HTTP/3 data getting
   passed to the QUIC layer.  For that, see the stream_data_moved event
   in [QLOG-QUIC].

   H3FrameCreated = {
       stream_id: uint64
       ? length: uint64
       frame: $H3Frame
       ? raw: RawInfo
   }

                    Figure 6: H3FrameCreated definition

4.6.  frame_parsed

   The frame_parsed event is emitted when the HTTP/3 frame is parsed.
   It has Core importance level; see Section 9.2 of [QLOG-MAIN].

   This event is not necessarily the same as when the HTTP/3 data is
   actually received on the QUIC layer.  For that, see the
   stream_data_moved event in [QLOG-QUIC].

   H3FrameParsed = {
       stream_id: uint64
       ? length: uint64
       frame: $H3Frame
       ? raw: RawInfo
   }

                     Figure 7: H3FrameParsed definition

   HTTP/3 DATA frames can have arbitrarily large lengths to reduce frame
   header overhead.  As such, DATA frames can span multiple QUIC
   packets.  In this case, the frame_parsed event is emitted once for
   the frame header, and further streamed data is indicated using the
   stream_data_moved event.

4.7.  datagram_created

   The datagram_created event is emitted when an HTTP/3 Datagram is
   created (see [RFC9297]).  It has Base importance level; see
   Section 9.2 of [QLOG-MAIN].



Marx, et al.            Expires 5 September 2024                [Page 9]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   This event does not necessarily coincide with the HTTP/3 Datagram
   getting passed to the QUIC layer.  For that, see the
   datagram_data_moved event in [QLOG-QUIC].

   H3DatagramCreated = {
       quarter_stream_id: uint64
       ? datagram: $H3Datagram
       ? raw: RawInfo
   }

                   Figure 8: H3DatagramCreated definition

4.8.  datagram_parsed

   The datagram_parsed event is emitted when the HTTP/3 Datagram is
   parsed (see [RFC9297]).  It has Base importance level; see
   Section 9.2 of [QLOG-MAIN].

   This event is not necessarily the same as when the HTTP/3 Datagram is
   actually received on the QUIC layer.  For that, see the
   datagram_data_moved event in [QLOG-QUIC].

   H3DatagramParsed = {
       quarter_stream_id: uint64
       ? datagram: $H3Datagram
       ? raw: RawInfo
   }

                   Figure 9: H3DatagramParsed definition

4.9.  push_resolved

   The push_resolved event is emitted when a pushed resource
   (Section 4.6 of [HTTP/3]) is successfully claimed (used) or,
   conversely, abandoned (rejected) by the application on top of HTTP/3
   (e.g., the web browser).  This event provides additional context that
   can is aid debugging issues related to server push.  It has Extra
   importance level; see Section 9.2 of [QLOG-MAIN].













Marx, et al.            Expires 5 September 2024               [Page 10]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3PushResolved = {
       ? push_id: uint64

       ; in case this is logged from a place that does not have access
       ; to the push_id
       ? stream_id: uint64
       decision: H3PushDecision
   }

   H3PushDecision = "claimed" /
                      "abandoned"

                    Figure 10: H3PushResolved definition

5.  HTTP/3 Data Field Definitions

   The following data field definitions can be used in HTTP/3 events.

5.1.  Owner

   Owner = "local" /
           "remote"

                        Figure 11: Owner definition

5.2.  H3Frame

   The generic $H3Frame is defined here as a CDDL extension point (a
   "socket" or "plug").  It can be extended to support additional HTTP/3
   frame types.

   ; The H3Frame is any key-value map (e.g., JSON object)
   $H3Frame /= {
       * text => any
   }

                     Figure 12: H3Frame plug definition

   The HTTP/3 frame types defined in this document are as follows:












Marx, et al.            Expires 5 September 2024               [Page 11]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3BaseFrames = H3DataFrame /
                  H3HeadersFrame /
                  H3CancelPushFrame /
                  H3SettingsFrame /
                  H3PushPromiseFrame /
                  H3GoawayFrame /
                  H3MaxPushIDFrame /
                  H3ReservedFrame /
                  H3UnknownFrame

   $H3Frame /= H3BaseFrames

                     Figure 13: H3BaseFrames definition

5.3.  H3Datagram

   The generic $H3Datagram is defined here as a CDDL extension point (a
   "socket" or "plug").  It can be extended to support additional HTTP/3
   datagram types.  This document intentionally does not define any
   specific HTTP/3 Datagram types.

   ; The H3Datagram is any key-value map (e.g., JSON object)
   $H3Datagram /= {
       * text => any
   }

                   Figure 14: H3Datagram plug definition

5.3.1.  H3DataFrame

   H3DataFrame = {
       frame_type: "data"
       ? raw: RawInfo
   }

                     Figure 15: H3DataFrame definition

5.3.2.  H3HeadersFrame

   This represents an _uncompressed_, plaintext HTTP Headers frame
   (e.g., no QPACK compression is applied).

   For example:








Marx, et al.            Expires 5 September 2024               [Page 12]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   headers: [
     {
       "name": ":path",
       "value": "/"
     },
     {
       "name": ":method",
       "value": "GET"
     },
     {
       "name": ":authority",
       "value": "127.0.0.1:4433"
     },
     {
       "name": ":scheme",
       "value": "https"
     }
   ]

                     Figure 16: H3HeadersFrame example

   H3HeadersFrame = {
       frame_type: "headers"
       headers: [* H3HTTPField]
   }

                    Figure 17: H3HeadersFrame definition

   H3HTTPField = {
       name: text
       ? value: text
   }

                     Figure 18: H3HTTPField definition

5.3.3.  H3CancelPushFrame

   H3CancelPushFrame = {
       frame_type: "cancel_push"
       push_id: uint64
   }

                  Figure 19: H3CancelPushFrame definition

5.3.4.  H3SettingsFrame






Marx, et al.            Expires 5 September 2024               [Page 13]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3SettingsFrame = {
       frame_type: "settings"
       settings: [* H3Setting]
   }

   H3Setting = {
       name: text
       value: uint64
   }

                   Figure 20: H3SettingsFrame definition

5.3.5.  H3PushPromiseFrame

   H3PushPromiseFrame = {
       frame_type: "push_promise"
       push_id: uint64
       headers: [* H3HTTPField]
   }

                  Figure 21: H3PushPromiseFrame definition

5.3.6.  H3GoAwayFrame

   H3GoawayFrame = {
       frame_type: "goaway"

       ; Either stream_id or push_id.
       ; This is implicit from the sender of the frame
       id: uint64
   }

                    Figure 22: H3GoawayFrame definition

5.3.7.  H3MaxPushIDFrame

   H3MaxPushIDFrame = {
       frame_type: "max_push_id"
       push_id: uint64
   }

                   Figure 23: H3MaxPushIDFrame definition

5.3.8.  H3PriorityUpdateFrame

   The PRIORITY_UPDATE frame is defined in [RFC9218].





Marx, et al.            Expires 5 September 2024               [Page 14]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3PriorityUpdateFrame = {
       frame_type: "priority_update"

       ; if the prioritized element is a request stream
       ? stream_id: uint64

       ; if the prioritized element is a push stream
       ? push_id: uint64

       priority_field_value: H3Priority
   }

   ; The priority value in ASCII text, encoded using Structured Fields
   ; Example: u=5, i
   H3Priority = text

                Figure 24: h3priorityupdateframe definition

5.3.9.  H3ReservedFrame

   H3ReservedFrame = {
       frame_type: "reserved"
       ? length: uint64
   }

                   Figure 25: H3ReservedFrame definition

5.3.10.  H3UnknownFrame

   The frame_type_value field is the numerical value without variable-
   length integer encoding.

   H3UnknownFrame = {
       frame_type: "unknown"
       frame_type_value: uint64
       ? raw: RawInfo
   }

                     Figure 26: UnknownFrame definition

5.3.11.  H3ApplicationError










Marx, et al.            Expires 5 September 2024               [Page 15]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   H3ApplicationError = "http_no_error" /
                          "http_general_protocol_error" /
                          "http_internal_error" /
                          "http_stream_creation_error" /
                          "http_closed_critical_stream" /
                          "http_frame_unexpected" /
                          "http_frame_error" /
                          "http_excessive_load" /
                          "http_id_error" /
                          "http_settings_error" /
                          "http_missing_settings" /
                          "http_request_rejected" /
                          "http_request_cancelled" /
                          "http_request_incomplete" /
                          "http_early_response" /
                          "http_connect_error" /
                          "http_version_fallback"

                  Figure 27: H3ApplicationError definition

   The H3ApplicationError defines the general $ApplicationError
   definition in the qlog QUIC definition, see [QLOG-QUIC].

   ; ensure HTTP errors are properly validate in QUIC events as well
   ; e.g., QUIC's ConnectionClose Frame
   $ApplicationError /= H3ApplicationError

6.  Security and Privacy Considerations

   The security and privacy considerations discussed in [QLOG-MAIN]
   apply to this document as well.

7.  IANA Considerations

   There are no IANA considerations.

8.  References

8.1.  Normative References

   [CDDL]     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>.






Marx, et al.            Expires 5 September 2024               [Page 16]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   [EXTENDED-CONNECT]
              Hamilton, R., "Bootstrapping WebSockets with HTTP/3",
              RFC 9220, DOI 10.17487/RFC9220, June 2022,
              <https://www.rfc-editor.org/rfc/rfc9220>.

   [H3-DATAGRAM]
              Schinazi, D. and L. Pardue, "HTTP Datagrams and the
              Capsule Protocol", RFC 9297, DOI 10.17487/RFC9297, August
              2022, <https://www.rfc-editor.org/rfc/rfc9297>.

   [H3_PRIORITIZATION]
              Oku, K. and L. Pardue, "Extensible Prioritization Scheme
              for HTTP", RFC 9218, DOI 10.17487/RFC9218, June 2022,
              <https://www.rfc-editor.org/rfc/rfc9218>.

   [HTTP/3]   Bishop, M., Ed., "HTTP/3", RFC 9114, DOI 10.17487/RFC9114,
              June 2022, <https://www.rfc-editor.org/rfc/rfc9114>.

   [QLOG-MAIN]
              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-07, 23 October
              2023, <https://datatracker.ietf.org/doc/html/draft-ietf-
              quic-qlog-main-schema-07>.

   [QLOG-QUIC]
              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-06, 23 October
              2023, <https://datatracker.ietf.org/doc/html/draft-ietf-
              quic-qlog-quic-events-06>.

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

   [RFC9218]  Oku, K. and L. Pardue, "Extensible Prioritization Scheme
              for HTTP", RFC 9218, DOI 10.17487/RFC9218, June 2022,
              <https://www.rfc-editor.org/rfc/rfc9218>.

   [RFC9297]  Schinazi, D. and L. Pardue, "HTTP Datagrams and the
              Capsule Protocol", RFC 9297, DOI 10.17487/RFC9297, August
              2022, <https://www.rfc-editor.org/rfc/rfc9297>.



Marx, et al.            Expires 5 September 2024               [Page 17]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


8.2.  Informative References

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

Acknowledgements

   Much of the initial work by Robin Marx was done at the Hasselt and KU
   Leuven Universities.

   Thanks to Jana Iyengar, Brian Trammell, Dmitri Tikhonov, Stephen
   Petrides, Jari Arkko, Marcus Ihlar, Victor Vasiliev, Mirja
   Kuehlewind, Jeremy Laine, Kazu Yamamoto, and Christian Huitema for
   their feedback and suggestions.

Change Log

   This section is to be removed before publishing as an RFC.

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

   *  ProtocolEventBody is now called ProtocolEventData (#352)

   *  Editorial changes (#402)

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

   *  Removed all qpack event definitions (#335)

   *  Various editorial changes

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

   *  Renamed 'http' category to 'h3' (#300)

   *  H3HTTPField.value is now optional (#296)

   *  Added definitions for RFC9297 (HTTP/3 Datagram extension) (#310)

   *  Added definitions for RFC9218 (HTTP Extensible Prioritizations
      extension) (#312)

   *  Added definitions for RFC9220 (Extended Connect extension) (#325)

   *  Editorial and formatting changes (#298, #258, #299, #304, #327)



Marx, et al.            Expires 5 September 2024               [Page 18]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


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

   *  Ensured consistent use of RawInfo to indicate raw wire bytes
      (#243)

   *  Changed HTTPStreamTypeSet:raw_stream_type to stream_type_value
      (#54)

   *  Changed HTTPUnknownFrame:raw_frame_type to frame_type_value (#54)

   *  Renamed max_header_list_size to max_field_section_size (#282)

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

   *  Renamed HTTPStreamType data to request (#222)

   *  Added HTTPStreamType value unknown (#227)

   *  Added HTTPUnknownFrame (#224)

   *  Replaced old and new fields with stream_type in HTTPStreamTypeSet
      (#240)

   *  Changed HTTPFrame to a CDDL plug type (#257)

   *  Moved data definitions out of the appendix into separate sections

   *  Added overview Table of Contents

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

   *  No changes - new draft to prevent expiration

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.





Marx, et al.            Expires 5 September 2024               [Page 19]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


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)





Marx, et al.            Expires 5 September 2024               [Page 20]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


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

Authors' Addresses

   Robin Marx (editor)
   Akamai
   Email: rmarx@akamai.com




Marx, et al.            Expires 5 September 2024               [Page 21]

Internet-Draft        HTTP/3 qlog event definitions           March 2024


   Luca Niccolini (editor)
   Meta
   Email: lniccolini@meta.com


   Marten Seemann (editor)
   Email: martenseemann@gmail.com


   Lucas Pardue (editor)
   Cloudflare
   Email: lucas@lucaspardue.com







































Marx, et al.            Expires 5 September 2024               [Page 22]