Skip to content

Commit 88cc7f8

Browse files
authored
s/protocol_type/protocol_types (#427)
Closes #426
1 parent 4eefbcf commit 88cc7f8

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

draft-ietf-quic-qlog-h3-events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ bottom of this document for clarity.
101101
{: #h3-events title="HTTP/3 Events"}
102102

103103
When any event from this document is included in a qlog trace, the
104-
"protocol_type" qlog array field MUST contain an entry with the value "HTTP3":
104+
"protocol_types" qlog array field MUST contain an entry with the value "HTTP3":
105105

106106
~~~ cddl
107107
$ProtocolType /= "HTTP3"
@@ -131,7 +131,7 @@ in the Concise Data Definition Language {{!CDDL=RFC8610}} and its
131131
extensions described in {{QLOG-MAIN}}.
132132

133133
The following fields from {{QLOG-MAIN}} are imported and used: name, category,
134-
type, data, group_id, protocol_type, importance, RawInfo, and time-related
134+
type, data, group_id, protocol_types, importance, RawInfo, and time-related
135135
fields.
136136

137137
As is the case for {{QLOG-MAIN}}, the qlog schema definitions in this document

draft-ietf-quic-qlog-main-schema.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ JSON-SEQ serialization example:
509509
"description": "Description for this trace file (long)",
510510
"trace": {
511511
"common_fields": {
512-
"protocol_type": ["QUIC","HTTP3"],
512+
"protocol_types": ["QUIC","HTTP3"],
513513
"group_id":"127ecc830d98f9d54a42c4f0842aa87e181a",
514514
"time_format":"relative",
515515
"reference_time": 1553986553572
@@ -612,7 +612,7 @@ Event = {
612612
data: $ProtocolEventData
613613
? path: PathID
614614
? time_format: TimeFormat
615-
? protocol_type: ProtocolTypeList
615+
? protocol_types: ProtocolTypeList
616616
? group_id: GroupID
617617
? system_info: SystemInformation
618618

@@ -631,7 +631,7 @@ the specific values and semantics of common fields, in particular the `name` and
631631
`data` fields. Furthermore, they can optionally add custom fields.
632632

633633
Each qlog event MAY contain the optional fields: "time_format"
634-
({{time-based-fields}}), "protocol_type" ({{protocol-type-field}}), "trigger"
634+
({{time-based-fields}}), "protocol_types" ({{protocol-type-field}}), "trigger"
635635
({{trigger-field}}), and "group_id" ({{group-ids}}).
636636

637637
Multiple events can appear in a Trace or TraceSeq and they might contain fields
@@ -647,7 +647,7 @@ Example qlog event:
647647
"name": "quic:packet_sent",
648648
"data": { ... },
649649

650-
"protocol_type": ["QUIC","HTTP3"],
650+
"protocol_types": ["QUIC","HTTP3"],
651651
"group_id": "127ecc830d98f9d54a42c4f0842aa87e181a",
652652

653653
"time_format": "absolute",
@@ -755,7 +755,7 @@ event to couple the PathID value to a specific path configuration, see
755755

756756
## ProtocolTypeList and ProtocolType {#protocol-type-field}
757757

758-
An event's "protocol_type" array field indicates to which protocols (or protocol
758+
An event's "protocol_types" array field indicates to which protocols (or protocol
759759
"stacks") this event belongs. This allows a single qlog file to aggregate traces
760760
of different protocols (e.g., a web server offering both TCP+HTTP/2 and
761761
QUIC+HTTP/3 connections).
@@ -845,15 +845,15 @@ and QUIC connection IDs:
845845
"events": [
846846
{
847847
"time": 1553986553579,
848-
"protocol_type": ["TCP", "TLS", "HTTP2"],
848+
"protocol_types": ["TCP", "TLS", "HTTP2"],
849849
"group_id": "ip1=2001:67c:1232:144:9498:6df6:f450:110b,
850850
ip2=2001:67c:2b0:1c1::198,port1=59105,port2=80",
851851
"name": "quic:packet_received",
852852
"data": { ... }
853853
},
854854
{
855855
"time": 1553986553581,
856-
"protocol_type": ["QUIC","HTTP3"],
856+
"protocol_types": ["QUIC","HTTP3"],
857857
"group_id": "127ecc830d98f9d54a42c4f0842aa87e181a",
858858
"name": "quic:packet_sent",
859859
"data": { ... }
@@ -893,7 +893,7 @@ SystemInformation = {
893893
As discussed in the previous sections, information for a typical qlog event varies
894894
in three main fields: "time", "name" and associated data. Additionally, there are
895895
also several more advanced fields that allow mixing events from different
896-
protocols and contexts inside of the same trace (for example "protocol_type" and
896+
protocols and contexts inside of the same trace (for example "protocol_types" and
897897
"group_id"). In most "normal" use cases however, the values of these advanced
898898
fields are consistent for each event instance (for example, a single trace
899899
contains events for a single QUIC connection).
@@ -910,7 +910,7 @@ per-event instance:
910910
{
911911
"events": [{
912912
"group_id": "127ecc830d98f9d54a42c4f0842aa87e181a",
913-
"protocol_type": ["QUIC","HTTP3"],
913+
"protocol_types": ["QUIC","HTTP3"],
914914
"time_format": "relative",
915915
"reference_time": 1553986553572,
916916

@@ -919,7 +919,7 @@ per-event instance:
919919
"data": { ... }
920920
},{
921921
"group_id": "127ecc830d98f9d54a42c4f0842aa87e181a",
922-
"protocol_type": ["QUIC","HTTP3"],
922+
"protocol_types": ["QUIC","HTTP3"],
923923
"time_format": "relative",
924924
"reference_time": 1553986553572,
925925

@@ -936,7 +936,7 @@ extracted to common_fields:
936936
{
937937
"common_fields": {
938938
"group_id": "127ecc830d98f9d54a42c4f0842aa87e181a",
939-
"protocol_type": ["QUIC","HTTP3"],
939+
"protocol_types": ["QUIC","HTTP3"],
940940
"time_format": "relative",
941941
"reference_time": 1553986553572
942942
},
@@ -970,7 +970,7 @@ CommonFields = {
970970
? path: PathID
971971
? time_format: TimeFormat
972972
? reference_time: float64
973-
? protocol_type: ProtocolTypeList
973+
? protocol_types: ProtocolTypeList
974974
? group_id: GroupID
975975
* text => any
976976
}

draft-ietf-quic-qlog-quic-events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ definitions, which are grouped together on the bottom of this document for
8181
clarity.
8282

8383
When any event from this document is included in a qlog trace, the
84-
`protocol_type` qlog array field MUST contain an entry with the value "QUIC":
84+
`protocol_types` qlog array field MUST contain an entry with the value "QUIC":
8585

8686
~~~ cddl
8787
$ProtocolType /= "QUIC"
@@ -135,7 +135,7 @@ in the Concise Data Definition Language {{!CDDL=RFC8610}} and its
135135
extensions described in {{QLOG-MAIN}}.
136136

137137
The following fields from {{QLOG-MAIN}} are imported and used: name, category,
138-
type, data, group_id, protocol_type, importance, RawInfo, and time-related
138+
type, data, group_id, protocol_types, importance, RawInfo, and time-related
139139
fields.
140140

141141
As is the case for {{QLOG-MAIN}}, the qlog schema definitions in this document

0 commit comments

Comments
 (0)