From cd828a39385712d10ed179a2c979da7ae94df27b Mon Sep 17 00:00:00 2001 From: Lucas Pardue Date: Tue, 19 Dec 2023 01:56:58 +0000 Subject: [PATCH] Align terminology across $ProtocolEvent extension point (#352) As discussed on #131, there's a slight mismatch of terminology between the main $ProtocolEventBody and the extensions QUICEvents and H3Events. This change implements the proposal to align the terms. Close #131 --- draft-ietf-quic-qlog-h3-events.md | 26 +++++------ draft-ietf-quic-qlog-main-schema.md | 20 ++++----- draft-ietf-quic-qlog-quic-events.md | 70 ++++++++++++++--------------- 3 files changed, 58 insertions(+), 58 deletions(-) diff --git a/draft-ietf-quic-qlog-h3-events.md b/draft-ietf-quic-qlog-h3-events.md index 1fc6c30b..bd5c67b4 100644 --- a/draft-ietf-quic-qlog-h3-events.md +++ b/draft-ietf-quic-qlog-h3-events.md @@ -143,22 +143,22 @@ in this specification. # HTTP/3 Events {#h3-ev} -HTTP/3 events extend the `$ProtocolEventBody` extension point defined in {{QLOG-MAIN}}. +HTTP/3 events extend the `$ProtocolEventData` extension point defined in {{QLOG-MAIN}}. ~~~ cddl -H3Events = H3ParametersSet / - H3ParametersRestored / - H3StreamTypeSet / - H3PriorityUpdated / - H3FrameCreated / - H3FrameParsed / - H3DatagramCreated / - H3DatagramParsed / - H3PushResolved - -$ProtocolEventBody /= H3Events +H3EventData = H3ParametersSet / + H3ParametersRestored / + H3StreamTypeSet / + H3PriorityUpdated / + H3FrameCreated / + H3FrameParsed / + H3DatagramCreated / + H3DatagramParsed / + H3PushResolved + +$ProtocolEventData /= H3EventData ~~~ -{: #h3-events-def title="H3Events definition and ProtocolEventBody +{: #h3-events-def title="H3EventData definition and ProtocolEventData extension"} HTTP events are logged when a certain condition happens at the application diff --git a/draft-ietf-quic-qlog-main-schema.md b/draft-ietf-quic-qlog-main-schema.md index 36050f9f..8bab126c 100644 --- a/draft-ietf-quic-qlog-main-schema.md +++ b/draft-ietf-quic-qlog-main-schema.md @@ -509,7 +509,7 @@ An Event is defined in {{event-def}} as: Event = { time: float64 name: text - data: $ProtocolEventBody + data: $ProtocolEventData ? time_format: TimeFormat ? protocol_type: ProtocolType ? group_id: GroupID @@ -659,7 +659,7 @@ field value definitions for QUIC and HTTP/3 can be found in {{QLOG-QUIC}} and {{QLOG-H3}}. This field is defined here as a CDDL extension point (a "socket" or -"plug") named `$ProtocolEventBody`. Other documents MUST properly extend +"plug") named `$ProtocolEventData`. Other documents MUST properly extend this extension point when defining new data field content options to enable automated validation of aggregated qlog schemas. @@ -667,20 +667,20 @@ The only common field defined for the data field is the `trigger` field, which is discussed in {{trigger-field}}. ~~~ cddl -; The ProtocolEventBody is any key-value map (e.g., JSON object) +; The ProtocolEventData is any key-value map (e.g., JSON object) ; only the optional trigger field is defined in this document -$ProtocolEventBody /= { +$ProtocolEventData /= { ? trigger: text * text => any } ; event documents are intended to extend this socket by using: -; NewProtocolEvents = EventType1 / -; EventType2 / -; ... / -; EventTypeN -; $ProtocolEventBody /= NewProtocolEvents +; NewProtocolEventData = EventType1 / +; EventType2 / +; ... / +; EventTypeN +; $ProtocolEventData /= NewProtocolEventData ~~~ -{: #protocoleventbody-def title="ProtocolEventBody definition"} +{: #protocoleventdata-def title="ProtocolEventData definition"} One purely illustrative example for a QUIC "packet_sent" event is shown in {{data-ex}}: diff --git a/draft-ietf-quic-qlog-quic-events.md b/draft-ietf-quic-qlog-quic-events.md index d5918d67..91edaf6f 100644 --- a/draft-ietf-quic-qlog-quic-events.md +++ b/draft-ietf-quic-qlog-quic-events.md @@ -202,44 +202,44 @@ this specification. | recovery:ecn_state_updated | Extra | {{recovery-ecnstateupdated}} | {: #quic-events title="QUIC Events"} -QUIC events extend the `$ProtocolEventBody` extension point defined in +QUIC events extend the `$ProtocolEventData` extension point defined in {{QLOG-MAIN}}. ~~~ cddl -QuicEvents = ConnectivityServerListening / - ConnectivityConnectionStarted / - ConnectivityConnectionClosed / - ConnectivityConnectionIDUpdated / - ConnectivitySpinBitUpdated / - ConnectivityConnectionStateUpdated / - ConnectivityMTUUpdated / - SecurityKeyUpdated / - SecurityKeyDiscarded / - QUICVersionInformation / - QUICALPNInformation / - QUICParametersSet / - QUICParametersRestored / - QUICPacketSent / - QUICPacketReceived / - QUICPacketDropped / - QUICPacketBuffered / - QUICPacketsAcked / - QUICDatagramsSent / - QUICDatagramsReceived / - QUICDatagramDropped / - QUICStreamStateUpdated / - QUICFramesProcessed / - QUICStreamDataMoved / - QUICDatagramDataMoved / - RecoveryParametersSet / - RecoveryMetricsUpdated / - RecoveryCongestionStateUpdated / - RecoveryLossTimerUpdated / - RecoveryPacketLost - -$ProtocolEventBody /= QuicEvents -~~~ -{: #quicevents-def title="QuicEvents definition and ProtocolEventBody +QuicEventData = ConnectivityServerListening / + ConnectivityConnectionStarted / + ConnectivityConnectionClosed / + ConnectivityConnectionIDUpdated / + ConnectivitySpinBitUpdated / + ConnectivityConnectionStateUpdated / + ConnectivityMTUUpdated / + SecurityKeyUpdated / + SecurityKeyDiscarded / + QUICVersionInformation / + QUICALPNInformation / + QUICParametersSet / + QUICParametersRestored / + QUICPacketSent / + QUICPacketReceived / + QUICPacketDropped / + QUICPacketBuffered / + QUICPacketsAcked / + QUICDatagramsSent / + QUICDatagramsReceived / + QUICDatagramDropped / + QUICStreamStateUpdated / + QUICFramesProcessed / + QUICStreamDataMoved / + QUICDatagramDataMoved / + RecoveryParametersSet / + RecoveryMetricsUpdated / + RecoveryCongestionStateUpdated / + RecoveryLossTimerUpdated / + RecoveryPacketLost + +$ProtocolEventData /= QuicEventData +~~~ +{: #quicevent-data-def title="QuicEventData definition and ProtocolEventData extension"} # Connectivity events {#conn-ev}