]> Akamai

rmarx@akamai.com

Meta

lniccolini@meta.com

martenseemann@gmail.com

Apple

lucas@lucaspardue.com

Transport QUIC Internet-Draft qlog provides extensible structured logging for network protocols, allowing for easy sharing of data that benefits common debug and analysis methods and tooling. This document describes key concepts of qlog: formats, files, traces, events, and extension points. This definition includes the high-level log file schemas, and generic event schemas. Requirements and guidelines for creating protocol-specific event schemas are also presented. All schemas are defined independent of serialization format, allowing logs to be represented in various ways such as JSON, CSV, or protobuf. Note to Readers

• Note to RFC editor: Please remove this section before publication.

Feedback and discussion are welcome at 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.

Introduction Endpoint logging is a useful strategy for capturing and understanding how applications using network protocols are behaving, particularly where protocols have an encrypted wire image that restricts observers' ability to see what is happening. Many applications implement logging using a custom, non-standard logging format. This has an effect on the tools and methods that are used to analyze the logs, for example to perform root cause analysis of an interoperability failure between distinct implementations. A lack of a common format impedes the development of common tooling that can be used by all parties that have access to logs. qlog is an extensible structured logging for network protocols that allows for easy sharing of data that benefits common debug and analysis methods and tooling. This document describes key concepts of qlog: formats, files, traces, events, and extension points. This definition includes the high-level log file schemas, and generic event schemas. Requirements and guidelines for creating protocol-specific event schemas are also presented. Accompanying documents define event schemas for QUIC () and HTTP/3 (). The goal of qlog is to provide amenities and default characteristics that each logging file should contain (or should be able to contain), such that generic and reusable toolsets can be created that can deal with logs from a variety of different protocols and use cases. As such, qlog provides versioning, metadata inclusion, log aggregation, event grouping and log file size reduction techniques. All qlog schemas can be serialized in many ways (e.g., JSON, CBOR, protobuf, etc). This document describes only how to employ JSON , its subset I-JSON , and its streamable derivative JSON Text Sequences .

Conventions and Terminology 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 when, and only when, they appear in all capitals, as shown here. Serialization examples in this document use JSON () unless otherwise indicated. Events are defined with an importance level as described in .

Use of CDDL To define events and data structures, all qlog documents use the Concise Data Definition Language . This document uses the basic syntax, the specific text, uint, float32, float64, bool, and any types, as well as the .size and .regexp control operators, the ~ unwrapping operator, and the $ and $$ extension points syntax from . Additionally, this document defines the following custom types for clarity:

Additional CDDL type definitions

All timestamps and time-related values (e.g., offsets) in qlog are logged as float64 in the millisecond resolution. Other qlog documents can define their own CDDL-compatible (struct) types (e.g., separately for each Packet type that a protocol supports). The ordering of member fields in qlog CDDL type definitions is not significant. The ordering of member fields in the serialization formats defined in this document, JSON () and JSON Text Sequences (), is also not significant, and qlog tools MUST NOT depend on it. Other qlog serialization formats MAY define field order as significant; if they do, they MUST define requirements for qlog tools supporting those formats.

• Note to RFC editor: Please remove the following text in this section before publication.

The main general CDDL syntax conventions in this document a reader should be aware of for easy reading comprehension are:

• ? obj : this object is optional
• TypeName1 / TypeName2 : a union of these two types (object can be either type 1 OR type 2)
• obj: TypeName : this object has this concrete type
• obj: [* TypeName] : this object is an array of this type with minimum size of 0 elements
• obj: [+ TypeName] : this object is an array of this type with minimum size of 1 element
• TypeName = ... : defines a new type
• EnumName = "entry1" / "entry2" / entry3 / ...: defines an enum
• StructName = { ... } : defines a new struct type
• ; : single-line comment
• * text => any : special syntax to indicate 0 or more fields that have a string key that maps to any value. Used to indicate a generic JSON object.

Design Overview The main tenets for the qlog design are:

• Streamable, event-based logging
• A flexible format that can reduce log producer overhead, at the cost of increased complexity for consumers (e.g. tools)
• Extensible and pragmatic
• Aggregation and transformation friendly (e.g., the top-level element for the non-streaming format is a container for individual traces, group_ids can be used to tag events to a particular context)
• Metadata is stored together with event data

This is achieved by a logical logging hierarchy of:

• Log file
  • Trace(s)
    • Event(s)

An abstract LogFile class is declared (), from which all concrete log file formats derive using log file schemas. This document defines the QlogFile () and QlogFileSeq () log file schemas. A trace is conceptually fluid but the conventional use case is to group events related to a single data flow, such as a single logical QUIC connection, at a single vantage point (). Concrete trace definitions relate to the log file schemas they are contained in; see (, , and ). Events are logged at a time instant and convey specific details of the logging use case. For example, a network packet being sent or received. This document declares an abstract Event class () containing fields common to all events, which all concrete events derive from. Concrete events are defined by event schemas that declare or extend a namespace, which contains one or more related event types or their extensions. For example, this document defines two event schemas for two generic event namespaces loglevel and simulation (see ).

Default Values Log files, traces, and events can have optional fields. The definition of an optional field can give it a default value. If the field is omitted in a logged event, it has that default value, unless common_fields () sets it. Logging the default value explicitly means the same as omitting the field. If an optional field has no default value, omitting it implies nothing about its value. The rules for default values can be overridden by definitions, for example by saying that an omitted field keeps its value from an earlier event.

Abstract LogFile Class A Log file is intended to contain a collection of events that are in some way related. An abstract LogFile class containing fields common to all log files is defined in . Each concrete log file schema derives from this using the CDDL unwrap operator (~) and can extend it by defining semantics and any custom fields.

LogFile definition

The required file_schema field identifies the concrete log file schema. It MUST have a value that is an absolute URI; see for rules and guidance. The required serialization_format field indicates the serialization format using a media type . It is case-insensitive. In order to make it easier to parse and identify qlog files and their serialization format, the file_schema and serialization_format fields and their values SHOULD be in the first 256 characters/bytes of the resulting log file. The optional title and description fields provide additional free-text information about the file.

Concrete Log File Schema URIs Concrete log file schemas MUST identify themselves using a URI . Log file schemas defined by RFCs MUST register a URI in the "qlog log file schema URIs" registry and SHOULD use a URN of the form urn:ietf:params:qlog:file:<schema-identifier>, where <schema-identifier> is a globally-unique text name using only characters in the URI unreserved range; see . This document registers urn:ietf:params:qlog:file:contained () and urn:ietf:params:qlog:file:sequential (). Private or non-standard log file schemas MAY register a URI in the "qlog log file schema URIs" registry but MUST NOT use a URN of the form urn:ietf:params:qlog:file:<schema-identifier>. URIs that contain a domain name SHOULD also contain a month-date in the form mmyyyy. For example, "https://example.org/072024/globallyuniquelogfileschema". The definition of the log file schema and assignment of the URI MUST have been authorized by the owner of the domain name on or very close to that date. This avoids problems when domain names change ownership. The URI does not need to be dereferenceable, allowing for confidential use or to cover the case where the log file schema continues to be used after the organization that defined it ceases to exist. The "qlog log file schema URIs" registry operates under the Expert Review policy, per . When reviewing requests, the expert MUST check that the URI is appropriate to the concrete log file schema and satisfies the requirements in this section. A request to register a private or non-standard log file schema URI using a URN of the form urn:ietf:params:qlog:file:<schema-identifier> MUST be rejected. Registration requests should use the template defined in .

QlogFile Schema A qlog file using the QlogFile schema can contain several individual traces and logs from multiple vantage points that are in some way related. The top-level element in this schema defines only a small set of "header" fields and an array of component traces. This is defined in as:

QlogFile definition

The QlogFile schema URI is urn:ietf:params:qlog:file:contained. QlogFile extends LogFile using the CDDL unwrap operator (~), which copies the fields presented in . Additionally, the optional traces field contains an array of qlog traces () or trace errors (). Each trace contains metadata and an array of qlog events (). This document defines a JSON serialization for QlogFile; see for guidance on populating the serialization_format field and other considerations. Where a qlog file is serialized to a JSON format, one of the downsides is that it is inherently a non-streamable format. Put differently, it is not possible to simply append new qlog events to a log file without "closing" this file at the end by appending "]}]}". Without these closing brackets, most JSON parsers will be unable to parse the file entirely. The alternative QlogFileSeq () is better suited to streaming use cases. JSON serialization example:

QlogFile example

Traces It can be useful to group several related qlog traces in a single file. For example, logging can happen simultaneously on the client, on the server, and at a point on their common network path. Combining these three traces in one file makes them easier to analyze, store, transfer, and annotate as a set. The QlogFile traces field is an array that contains a list of individual qlog traces. When capturing a qlog at a vantage point, it is expected that the traces field contains a single entry. Files can be aggregated, for example as part of a post-processing operation, by copying the traces from the component files into the combined traces array of a new, aggregated qlog file. Note that another way to combine events of different traces in a single qlog file is through the use of the group_id field, discussed in .

Trace The exact conceptual definition of a Trace can be fluid. For example, a trace could contain all events for a single connection, for a single endpoint, for a single measurement interval, for a single protocol, etc. In the normal use case however, a trace is a log of a single data flow collected at a single location or vantage point. For example, for QUIC, a single trace typically contains events for a single logical QUIC connection for either the client or the server. A Trace contains some metadata in addition to qlog events, defined in as:

Trace definition

The optional title and description fields provide additional free-text information about the trace. The optional common_fields field is described in . The optional vantage_point field is described in . The required event_schemas field contains event schema URIs that identify concrete event namespaces and their associated types recorded in the events field. Requirements and guidelines are defined in . The semantics and context of the trace can mainly be deduced from the entries in the common_fields list and vantage_point field. JSON serialization example:

Trace example

TraceError A TraceError indicates that an attempt to find/convert a file for inclusion in the aggregated qlog was made, but there was an error during the process. Rather than silently dropping the erroneous file, it can be explicitly included in the qlog file as an entry in the traces array, defined in as:

TraceError definition

JSON serialization example:

TraceError example

QlogFileSeq Schema A qlog file using the QlogFileSeq schema can be serialized to a streamable JSON format called JSON Text Sequences (JSON-SEQ) (). The top-level element in this schema defines only a small set of "header" fields and a single component trace. This is defined in as:

QlogFileSeq definition

The QlogFileSeq schema URI is urn:ietf:params:qlog:file:sequential. QlogFileSeq extends LogFile using the CDDL unwrap operator (~), which copies the fields presented in . Additionally, the required trace field contains a single TraceSeq (), which all qlog events in the file are related to. See for guidance on populating the serialization_format field and other serialization considerations. JSON-SEQ serialization example, showing a QlogFileSeq header record followed by qlog event records. Each record starts with a Record Separator character, shown as <RS>, and ends with a newline; see .

QlogFileSeq example { "file_schema": "urn:ietf:params:qlog:file:sequential", "serialization_format": "application/qlog+json-seq", "title": "Name of JSON Text Sequence qlog file (short)", "description": "Description for this trace file (long)", "trace": { "common_fields": { "group_id":"127ecc830d98f9d54a42c4f0842aa87e181a", "time_format": "relative_to_epoch", "reference_time": { "clock_type": "system", "epoch": "1970-01-01T00:00:00.000Z" } }, "vantage_point": { "name":"backend-67", "type":"server" }, "event_schemas": ["urn:ietf:params:qlog:events:quic", "urn:ietf:params:qlog:events:http3"] } } {"time": 2, "name": "quic:parameters_set", "data": { ... } } {"time": 7, "name": "quic:packet_sent", "data": { ... } } ... ]]>

TraceSeq TraceSeq is used with QlogFileSeq. It is conceptually similar to a Trace, with the exception that qlog events are not contained within it, but rather appended after it in a QlogFileSeq.

TraceSeq definition

VantagePoint A VantagePoint describes the vantage point from which a trace originates, defined in as:

VantagePoint definition

JSON serialization examples:

VantagePoint example

The flow field is only required if the type is "network" (for example, the trace is generated from a packet capture). It is used to disambiguate events like "packet sent" and "packet received". This is indicated explicitly because for multiple reasons (e.g., privacy) data from which the flow direction can be otherwise inferred (e.g., IP addresses) might not be present in the logs. Meaning of the different values for the flow field:

• "client" indicates that this vantage point follows client data flow semantics (a "packet sent" event goes in the direction of the server).
• "server" indicates that this vantage point follows server data flow semantics (a "packet sent" event goes in the direction of the client).
• "unknown" indicates that the flow's direction is unknown.

Depending on the context, tools confronted with "unknown" values in the vantage_point can either try to heuristically infer the semantics from protocol-level domain knowledge (e.g., in QUIC, the client always sends the first packet) or give the user the option to switch between client and server perspectives manually.

Abstract Event Class Events are logged at a time instant and convey specific details of the logging use case. An abstract Event class containing fields common to all events is defined in .

Event definition any } ]]>

Each qlog event MUST contain the mandatory fields: time (), name (), and data (). Each qlog event is an instance of a concrete event type that derives from the abstract Event class; see . They extend it by defining the specific values and semantics of the fields common to all events, in particular the name and data fields. Furthermore, they can optionally add custom fields. Each qlog event MAY contain the optional fields: time_format (), tuple (), group_id (), and system_info (). Multiple events can appear in a Trace or TraceSeq and they might contain fields with identical values. It is possible to optimize out this duplication using common_fields (). Example qlog event:

Event example

Timestamps The time field indicates when the event occurred. It is a duration measured from some point in time; its units depend on the type of clock chosen and system used. The time field is a float64 and it is typically used to represent a duration in milliseconds, with a fractional component to microsecond or nanosecond resolution. There are several options for generating and logging timestamps, these are governed by the ReferenceTime type (optionally included in the reference_time field contained in a trace's common_fields ()) and TimeFormat type (optionally included in the time_format field contained in the event itself, or a trace's common_fields). There is no requirement that events in the same trace use the same time format. However, using a single time format for related events can make them easier to analyze. The reference time governs from which point in time the time field values are measured and is defined as:

ReferenceTime definition

The required clock_type field represents the type of clock used for time measurements. The value "system" represents a clock that uses system time, commonly measured against a chosen or well-known epoch. However, depending on the system, system time can potentially jump forward or back. In contrast, a clock using monotonic time is generally guaranteed to never go backwards. The value "monotonic" represents such a clock. The required epoch field is the start of the ReferenceTime. When using the "system" clock type, the epoch field SHOULD have a date/time value using the format defined in . However, the value "unknown" MAY be used. When using the "monotonic" clock type, the epoch field MUST have the value "unknown". The optional wall_clock_time field can be used to provide an approximate date/time value that logging commenced at if the epoch value is "unknown". It uses the format defined in . Note that conversion of timestamps to calendar time based on wall clock times cannot be safely relied on. The time format details how time values are encoded relative to the reference time and is defined as:

TimeFormat definition

relative_to_epoch:

A duration relative to the ReferenceTime epoch field. This approach produces the largest values. It is suitable for stateless loggers. The time_format field defaults to this value.

relative_to_previous_event:

A delta-encoded value: the duration since the time of the previously logged event. The first event in a trace is always relative to the ReferenceTime. This approach produces the smallest values. It is suitable for stateful loggers.

Events in each individual trace SHOULD be logged in time order, so that no event has an earlier time than the event logged before it. With the "relative_to_previous_event" format, this means that no logged time value is negative. Loggers could choose to log events out of order for reasons such as supporting multi-threaded or streaming implementations. Tools cannot rely on logs containing traces with events in time order. A qlog trace can be sorted, for example, as a post-processing step by the logger, or a pre-processing step for a tool. Several events can have the same time, for example when one received packet leads to several events, or when the clock has a low resolution. The logged order of these events can still matter, for example to show a packet before the events it caused. A stable sort, which keeps events with the same time in their logged order, preserves it. Tools SHOULD NOT assume the ability to derive the absolute calendar timestamp of an event from qlog traces. Tools should not rely on timestamps to be consistent across traces, even those generated by the same logging endpoint. For reasons of privacy, the reference time MAY have minimization or anonymization applied. Example of a log using the relative_to_epoch format:

Relative to epoch timestamps

Example of a log using the relative_to_previous_event format:

Relative-to-previous-event timestamps

Example of a monotonic log using the relative_to_epoch format:

Monotonic timestamps

Tuple A qlog event is typically associated with a single network "path", which is usually aligned with a four-tuple of IP addresses and ports. The optional tuple field (of type TupleID) identifies a single network four-tuple and can be used to associate individual events with a specific "path". Definition:

TupleID definition

The tuple field defaults to "". Because tuple definitions can depend and vary based on the underlying protocols and mechanisms used, this document intentionally does not define further how to choose this identifier's value per tuple or how to log other parameters that can be associated with such a tuple. This is expected to be defined by extension schemas that want to use the tuple field. Implementers are for example free to encode or serialize tuple information directly into the TupleID's contents or to log associated info in a separate event. For example, QUIC has the tuple_assigned event to couple the TupleID contents to a specific tuple configuration, see . The tuple field is intentionally marked as optional, as there can be many practical or logical reasons why implementations might not want to log it for every event. For example, the TupleID contents will usually be the same for all events in a single connection and bears no repeating. Similarly, application level protocols will typically not care which tuple a specific frame is sent/received on. However, in some situations, such as during QUIC's Connection Migration or when a transport protocol can use multiple paths, it is useful to be able to split events across multiple (concurrent) tuples and/or paths, especially for packet-level events. Even in those cases however, it is allowed to log the tuple field only for some events in the trace when salient (for example only when QUIC PATH_CHALLENGE and PATH_RESPONSE frames are involved, or when the first packet on a new path is sent/received) and omit it when not.

Grouping As discussed in , a single qlog file can contain several traces taken from different vantage points. However, a single trace from one endpoint can also contain events from a variety of sources. For example, a server implementation might choose to log events for all incoming connections in a single large (streamed) qlog file. As such, a method for splitting up events belonging to separate logical entities is required. The simplest way to perform this splitting is by associating a "group id" to each event that indicates to which conceptual "group" each event belongs. A post-processing step can then extract events per group. However, this group identifier can be highly protocol and context-specific. In the example above, the QUIC "Original Destination Connection ID" could be used to uniquely identify a connection. As such, the server implementation might add an odcid field to each event. Additionally, a service providing different levels of Quality of Service (QoS) to their users might wish to group connections per QoS level applied. They might instead prefer a qos field. As such, to provide consistency and ease of tooling in cross-protocol and cross-context setups, qlog instead defines the common group_id field, which contains a string value. Implementations are free to use their preferred string serialization for this field, so long as it contains a unique value per logical group. Some examples can be seen in .

GroupID definition

JSON serialization example for events grouped either by QUIC Connection IDs, or according to an endpoint-specific Quality of Service (QoS) logic that includes the service level:

GroupID example

Note that in some contexts (for example a transport protocol that can use multiple paths) it might make sense to add additional contextual per-event fields (for example TupleID, see ), rather than use the group_id field for that purpose. Note also that, typically, a single trace only contains events belonging to a single logical group (for example, an individual QUIC connection). As such, instead of logging the group_id field with an identical value for each event instance, this field is typically logged once in common_fields, see .

SystemInformation The system_info field can be used to record system-specific details related to an event. This is useful, for instance, where an application splits work across CPUs, processes, or threads and events for a single trace occur on potentially different combinations thereof. Each field is optional to support deployment diversity.

SystemInformation definition

CommonFields As discussed in the previous sections, information for a typical qlog event varies in three main fields: time, name and associated data. Additionally, there are also several more advanced fields that allow mixing events from different protocols and contexts inside of the same trace (for example group_id). In most "normal" use cases however, the values of these advanced fields are consistent for each event instance (for example, a single trace contains events for a single QUIC connection). To reduce file size and make logging easier, qlog uses the common_fields list to indicate those fields and their values that are shared by all events in this component trace. This prevents these fields from being logged for each individual event. An example of this is shown in .

CommonFields example

The common_fields field is a generic dictionary of key-value pairs, where the key is always a string and the value can be of any type, but is typically also a string or number. As such, unknown entries in this dictionary MUST be disregarded by the user and tools (i.e., the presence of an unknown field is explicitly NOT an error). The list of default qlog fields that are typically logged in common_fields (as opposed to as individual fields per event instance) are shown in the listing below:

CommonFields definition any } ]]>

Tools MUST be able to deal with these fields being defined either on each event individually or combined in common_fields. Note that if at least one event in a trace has a different value for a given field, this field MUST NOT be added to common_fields but instead defined on each event individually. Good examples of such fields are time and data, which are divergent by nature.

Concrete Event Types and Event Schemas Concrete event types, as well as related data types, are grouped in event namespaces which in turn are defined in one or multiple event schemas. As an example, the QUICPacketSent and PacketHeader event and data types would be part of the quic namespace, which is defined in an event schema with URI urn:ietf:params:qlog:events:quic. A later extension that adds a new QUIC frame QUICNewFrame would also be part of the quic namespace, but defined in a new event schema with URI urn:ietf:params:qlog:events:quic#new-frame-extension. Similarly, the first document that defines qlog events for a new hypothetical protocol called "IPoAC" would define and register both the new event namespace ipoac and the event schema URI urn:ietf:params:qlog:events:ipoac. Concrete event types MUST belong to a single event namespace and MUST have a non-empty identifier of type text. New namespaces MUST have a non-empty globally-unique text identifier using only characters in the URI unreserved range; see . Namespaces are mutable and MAY be extended with new events. The value of a qlog event name field MUST be the concatenation of namespace identifier, colon (':'), and event type identifier (for example: quic:packet_sent). The resulting concatenation MUST be globally unique, so log files can contain events from multiple event schemas without the risk of name collisions. The designated expert checks this for the event types listed in the registry; see . A (private or non-standard) event schema that does not list its event types there cannot rely on its event names being unique. A single event schema contains exactly one of the following:

• A definition for a new event namespace
• An extension of an existing namespace (adding new events/data types and/or extending existing events/data types within the namespace with new fields)

A single document can define multiple event schemas. For example, this document defines the loglevel and simulation event schemas; see and respectively. An event schema MUST have a single URI that MUST be absolute. The URI MUST include the namespace identifier. Event schemas that extend an existing namespace MUST furthermore include a non-empty "extension" identifier that is unique within the namespace. The extension identifier is a URI fragment (characters after a "#" in the URI) using only characters in the URI unreserved range; see . Registration guidance and requirements for event schema URIs are provided in . Event schemas by themselves are immutable once defined and MUST NOT be extended. Implementations that record concrete event types SHOULD list all event schemas in use in a specific trace. This is achieved by including the appropriate URIs in the event_schemas field of the Trace () and TraceSeq () types. The event_schemas field is a hint to tools about which event namespaces, extensions, event types, and data types a trace might contain. The trace MAY still contain event types that do not belong to a listed event schema. Conversely, not all event types associated with an event schema listed in event_schemas are guaranteed to be logged in a qlog trace. Tools MUST NOT treat either of these as an error; see . In the following hypothetical example, a qlog trace contains events belonging to:

• The two event namespaces defined by event schemas in this document ().
• Events in a namespace named rick specified in a hypothetical RFC
• Extensions to the rick namespace defined in two separate new event schemas (with URI extension identifiers astley and moranis)
• Events from three private event schemas, detailing definitions for and extensions to two namespaces (pickle and cucumber)

The standardized schema URIs use a URN format; the private schemas use a URI with a domain name.

Example event_schemas serialization

Event Schema URIs Event schemas defined by RFCs MUST register all namespaces and concrete event types they contain in the "qlog event schema URIs" registry. If an event schema defined by an RFC defines a new namespace, it SHOULD use a URN of the form urn:ietf:params:qlog:events:<namespace identifier>, where <namespace identifier> is globally unique. For example, the loglevel event schema uses urn:ietf:params:qlog:events:loglevel. If an event schema defined by an RFC extends an existing namespace, it SHOULD use a URN of the form urn:ietf:params:qlog:events:<namespace identifier>#<extension identifier>, where the combination of <namespace identifier> and <extension identifier> is globally unique. Private or non-standard event schemas MAY be registered in the "qlog event schema URIs" registry but MUST NOT use a URN of the forms outlined above. URIs that contain a domain name SHOULD also contain a month-date in the form mmyyyy. For example, "https://example.org/072024/customeventschema#customextension". The definition of the event schema and assignment of the URI MUST have been authorized by the owner of the domain name on or very close to that date. This avoids problems when domain names change ownership. The URI does not need to be dereferenceable, allowing for confidential use or to cover the case where the event schemas continue to be used after the organization that defined them ceases to exist. The "qlog event schema URIs" registry operates under the Expert Review policy, per . When reviewing requests, the expert MUST check that the URI is appropriate to the event schema and satisfies the requirements in and this section. A request to register a private or non-standard schema URI using a URN of the forms reserved for schemas defined by an RFC above MUST be rejected. Registration requests should use the template defined in .

Extending the Data Field An event's data field is a generic key-value map (e.g., JSON object). It defines the per-event metadata that is to be logged. Its specific subfields and their semantics are defined per concrete event type. For example, data field definitions for QUIC and HTTP/3 can be found in and . To keep qlog fully extensible, data fields are defined using two kinds of CDDL extension point, called "sockets", which other definitions extend with "plugs"; see . Firstly, a "group socket" allows existing event data definitions to be extended, for example with a field needed for a new protocol feature. An event data definition includes the socket as an entry of the form * $$NAMESPACE-EVENTTYPE-extension. Other event schemas add fields to it with plugs that use the //= operator, and several plugs can extend the same socket. An example is shown in .

Example of using a generic CDDL group socket to extend an existing event data definition

Secondly, a "type socket" allows documents to define entirely new event data definitions. The type of the data field in the qlog Event type (see ) is the type socket $ProtocolEventData, which acts as an open enum of the types allowed for the data field. Each new event data definition is its own CDDL type, added to $ProtocolEventData with a plug that uses the /= operator. Any generic key-value map type can be added this way. The example in shows $ProtocolEventData extended with two types.

ProtocolEventData extension

Event schemas defining new qlog events MUST properly extend $ProtocolEventData when defining data fields to enable automated validation of aggregated qlog schemas. Furthermore, they SHOULD add a * $$NAMESPACE-EVENTTYPE-extension extension field to newly defined event data to allow the new events to be properly extended by other event schemas. A combined but purely illustrative example of the use of both extension points for a conceptual QUIC packet_sent event is shown in :

Example of an extended 'data' field for a conceptual QUIC packet_sent event

Triggers It can be useful to understand the cause or trigger of an event. Sometimes, events are caused by a variety of other events and additional information is needed to identify the exact details. Commonly, the context of the surrounding log messages gives a hint about the cause. However, in highly-parallel and optimized implementations, corresponding log messages might be separated in time, making it difficult to build an accurate context. Including a trigger as part of the event itself is one method for providing fine-grained information without much additional overhead. In circumstances where a trigger is useful, it is RECOMMENDED for the purpose of consistency that the event data definition contains an optional field named trigger, holding a string value. For example, the QUIC packet_dropped event () includes a trigger field that identifies the general reason category for dropping a QUIC packet. shows this field; the event's other fields are omitted for clarity.

Trigger example

Event Importance Levels Depending on how events are designed, it may be that several events allow the logging of similar or overlapping data. For example the separate QUIC connection_started event overlaps with the more generic connection_state_updated. In these cases, it is not always clear which event should be logged or used, and which event should take precedence if, for example, both are present and provide conflicting information. To aid in this decision making, qlog defines three event importance levels, in decreasing order of importance and expected usage:

• Core
• Base
• Extra

Concrete event types SHOULD define an importance level. Core-level events SHOULD be present in all qlog files for a given protocol. These are typically tied to basic packet and frame parsing and creation, as well as listing basic internal metrics. Tool implementers SHOULD expect and add support for these events, though SHOULD NOT expect all Core events to be present in each qlog trace. Base-level events add additional debugging options and MAY be present in qlog files. Most of these can be implicitly inferred from data in Core events (if those contain all their properties), but for many it is better to log the events explicitly as well, making it clearer how the implementation behaves. These events are for example tied to passing data around in buffers, to how internal state machines change, and used to help show when decisions are actually made based on received data. Tool implementers SHOULD at least add support for showing the contents of these events, if they do not handle them explicitly. Extra-level events are considered mostly useful for low-level debugging of the implementation, rather than the protocol. They allow more fine-grained tracking of internal behavior. As such, they MAY be present in qlog files and tool implementers MAY add support for these, but they are not required to. Implementers might choose not to log some details in Core-level events, such as data content, for performance or privacy reasons (see ). In that case, they SHOULD log relevant Base-level events instead, so that the qlog output remains usable. For example, a QUIC implementation can omit the details of STREAM frames from its packet_received events and log stream_state_updated events instead. Finally, for event types whose data (partially) overlap with other event types' definitions, where necessary the document defining them should include explicit guidance on which to use in specific situations.

Relationship to On-the-Wire Data Events reflect the view of the implementation that logs them. This can differ from what was sent or received on the wire, for example because of a bug. Event schemas assume a correct implementation when they let one logged value imply another, or when they leave out data that the wire already shows. For example, the QUIC packet_sent event does not log the encryption level, because the packet type implies it .

Tooling Expectations qlog is an extensible format and it is expected that new event schemas will emerge that define new namespaces, event types, event fields (e.g., a field indicating an event's privacy properties), as well as values for the trigger property within the data field, or other member fields of the data field, as they see fit. It SHOULD NOT be expected that general-purpose tools will recognize or visualize all forms of qlog extension. Tools SHOULD allow for the presence of unknown event fields and make an effort to visualize even unknown data if possible, otherwise they MUST ignore it.

Further Design Guidance There are several ways of defining concrete event types. In practice, two main approaches have been observed. In the first, event types map directly to protocol concepts (e.g., packet_sent). In the second, event types aggregate data from several protocol behaviors or code paths (e.g., parameters_set). Aggregation keeps the number of definitions manageable, as a separate definition for every protocol behavior would cause an explosion of event types. Event schemas also avoid duplicate data as much as possible. For example, QUIC packet header values that stay the same across many packets have their own events, logged only when a value changes (e.g., spin_bit_updated or connection_id_updated). Finally, many state changes can be inferred from data on the wire (e.g., flow control limit changes). Event schemas typically do not define events for these, because the data on the wire already reveals the change; see . Exceptions have been made for common events that benefit from being easy to identify or log individually (e.g., packets_acked).

The Generic Event Schemas The two following generic event schemas define two namespaces and several concrete event types that are common across protocols, applications, and use cases.

Loglevel Events In typical logging setups, users utilize a discrete number of well-defined logging categories, levels or severities to log freeform (string) data. The loglevel event namespace replicates this approach to allow implementations to fully replace their existing text-based logging by qlog. This is done by providing events to log generic strings for the typical well-known logging levels (error, warning, info, debug, verbose). The namespace identifier is "loglevel". The event schema URI is urn:ietf:params:qlog:events:loglevel.

LogLevelEventData and ProtocolEventData extension

The event types are further defined below, their identifier is the heading name.

error Used to log details of an internal error that might not get reflected on the wire. It has Core importance level.

LogLevelError definition

warning Used to log details of an internal warning that might not get reflected on the wire. It has Base importance level.

LogLevelWarning definition

info Used mainly for implementations that want to use qlog as their one and only logging format but still want to support unstructured string messages. The event has Extra importance level.

LogLevelInfo definition

debug Used mainly for implementations that want to use qlog as their one and only logging format but still want to support unstructured string messages. The event has Extra importance level.

LogLevelDebug definition

verbose Used mainly for implementations that want to use qlog as their one and only logging format but still want to support unstructured string messages. The event has Extra importance level.

LogLevelVerbose definition

Simulation Events When evaluating a protocol implementation, one typically sets up a series of interoperability or benchmarking tests, in which the test situations can change over time. For example, the network bandwidth or latency can vary during the test, or the network can be fully disabled for a short time. In these setups, it is useful to know when exactly these conditions are triggered, to allow for proper correlation with other events. This namespace defines event types to allow logging of such simulation metadata and its identifier is "simulation". The event schema URI is urn:ietf:params:qlog:events:simulation.

SimulationEventData and ProtocolEventData extension

The event types are further defined below, their identifier is the heading name.

scenario Used to specify which specific scenario is being tested at this particular instance. This supports, for example, aggregation of several simulations into one trace (e.g., split by group_id). It has Extra importance level.

SimulationScenario definition any } * $$simulation-scenario-extension } ]]>

marker Used to indicate when specific test conditions are triggered at set times (e.g., at 3 seconds, 2% packet loss is introduced; at 10 seconds, a NAT rebinding is triggered). It has Extra importance level.

SimulationMarker definition

Raw Packet and Frame Information While qlog is a high-level logging format, it also allows the inclusion of most raw wire image information, such as byte lengths and byte values. This is useful when for example investigating or tuning packetization behavior or determining encoding/framing overheads. However, these fields are not always necessary, can take up considerable space, and can have a considerable privacy and security impact (see ). Where applicable, these fields are grouped in a separate, optional, field named raw of type RawInfo. The exact definition of entities, headers, trailers and payloads depends on the protocol used.

RawInfo definition

All fields in RawInfo are defined as optional. It is acceptable to log any field without the others. Logging length related fields and omitting the data field permits protocol debugging without the risk of logging potentially sensitive data. The data field, if logged, is not required to contain the contents of a full entity and can be truncated, see . The length fields, if logged, should indicate the actual lengths as defined above, even if the data field is omitted or truncated. Protocol entities containing an on-the-wire length field (for example a packet header or QUIC's stream frame) are strongly recommended to re-use the raw.length field instead of defining a separate length field, to maintain consistency and prevent data duplication. This document does not specify explicit header_length or trailer_length fields. In protocols without trailers, header_length can be calculated by subtracting the payload_length from the length. In protocols with trailers (e.g., QUIC's AEAD tag), documents that define event schemas SHOULD specify how to support header_length calculation.

Serializing qlog qlog schema definitions in this document are intentionally agnostic to serialization formats. The choice of format is an implementation decision. Other documents related to qlog (for example event definitions for specific protocols), SHOULD be similarly agnostic to the employed serialization format and SHOULD clearly indicate this. If not, they MUST include an explanation on which serialization formats are supported and on how to employ them correctly. Serialization formats make certain tradeoffs between usability, flexibility, interoperability, and efficiency. Implementations should take these into consideration when choosing a format. Some examples of possible formats are JSON, CBOR, CSV, protocol buffers, flatbuffers, etc. which each have their own characteristics. For instance, a textual format like JSON can be more flexible than a binary format but more verbose, typically making it less efficient than a binary format. A plaintext readable (yet relatively large) format like JSON is potentially more usable for users operating on the logs directly, while a more optimized yet restricted format can better suit the constraints of a large scale operation. A custom or restricted format could be more efficient for analysis with custom tooling but might not be interoperable with general-purpose qlog tools. Considering these tradeoffs, JSON-based serialization formats provide features that make them a good starting point for qlog flexibility and interoperability. For these reasons, JSON is a recommended default and expanded considerations are given to how to map qlog to JSON (), and its streaming counterpart JSON Text Sequences (). presents interoperability considerations for both formats, and presents potential optimizations. Serialization formats require appropriate deserializers/parsers. The serialization_format field () is used to indicate the chosen serialization format.

qlog to JSON Mapping When mapping qlog to JSON, QlogFile () is used. The Media Type is "application/qlog+json" per . The file extension/suffix SHOULD be ".qlog". In accordance with , JSON files are required to use UTF-8 both for the file itself and the string values it contains. In addition, all qlog field names MUST be lowercase when serialized to JSON. In order to serialize CDDL-based qlog event and data structure definitions to JSON, the official CDDL-to-JSON mapping defined in SHOULD be employed.

qlog to JSON Text Sequences Mapping One of the downsides of using JSON is that it is inherently a non-streamable format. A qlog serializer could work around this by opening a file, writing the required opening data, streaming qlog events by appending them, and then finalizing the log by appending appropriate closing brackets, e.g., "]}]}". However, failure to append closing brackets could lead to problems because most JSON parsers will fail if a document is malformed. Some streaming JSON parsers are able to handle missing closing brackets; however, they are not widely deployed in popular environments (e.g., Web browsers). To overcome the issues related to JSON streaming, a qlog mapping to a streamable JSON format called JSON Text Sequences (JSON-SEQ) () is provided. JSON Text Sequences are very similar to JSON, except that objects are serialized as individual records, each prefixed by an ASCII Record Separator (<RS>, 0x1E), and each ending with an ASCII Line Feed character (\n, 0x0A). Note that each record can also contain any amount of newlines in its body, as long as it ends with a newline character before the next <RS> character. In order to leverage the streaming capability, each qlog event is serialized and interpreted as an individual JSON Text Sequence record, that is appended as a new object to the back of an event stream or log file. Put differently, unlike JSON, it does not require a document to be wrapped as a full object with "{ ... }" or "[... ]". This alternative record streaming approach cannot be accommodated by QlogFile (). Instead, QlogFileSeq is defined in , which notably includes only a single trace (TraceSeq) and omits an explicit events array. An example is provided in . The group_id field can still be used on a per-event basis to include events from conceptually different sources in a single JSON-SEQ qlog file. When mapping qlog to JSON-SEQ, the Media Type is "application/qlog+json-seq" per . The file extension/suffix SHOULD be ".sqlog" (for "streaming" qlog). While not specifically required by the JSON-SEQ specification, all qlog field names MUST be lowercase when serialized to JSON-SEQ. In order to serialize all other CDDL-based qlog event and data structure definitions to JSON-SEQ, the official CDDL-to-JSON mapping defined in SHOULD be employed.

Supporting JSON Text Sequences in Tooling Note that JSON Text Sequences are not supported in most default programming environments (unlike JSON). However, several custom JSON-SEQ parsing libraries exist in most programming languages that can be used and the format is easy enough to parse with existing implementations (i.e., by splitting the file into its component records and feeding them to a standard JSON parser individually, as each record by itself is a valid JSON object).

JSON Interoperability Some JSON implementations have issues with the full JSON format, especially those integrated within a JavaScript environment (e.g., Web browsers, NodeJS). I-JSON (Internet-JSON) is a subset of JSON for such environments; see . One of the key limitations of JavaScript, and thus I-JSON, is that it cannot represent full 64-bit integers in standard operating mode (i.e., without using BigInt extensions), instead being limited to the range -(2⁵³)+1 to (2⁵³)-1. To accommodate such constraints in CDDL, suggests defining integer types that restrict 64-bit values to the range in which I-JSON can represent integers exactly. However, some of the protocols that qlog is intended to support (e.g., QUIC, HTTP/3), can use the full range of uint64 values. As such, to support situations where I-JSON is in use, serializers MAY encode uint64 values using JSON strings. qlog parsers, therefore, SHOULD support parsing of uint64 values from JSON strings or JSON numbers unless there is out-of-band information indicating that neither the serializer nor parser are constrained by I-JSON. The CDDL definitions describe uint64 values as numbers. A log that encodes them as JSON strings needs those values converted to numbers before it can be validated against the CDDL.

Truncated Values For some use cases (e.g., limiting file size, privacy), it can be necessary not to log a full raw blob (using the hexstring type) but instead a truncated value. For example, one might only store the first 100 bytes of an HTTP response body to be able to discern which file it actually contained. In these cases, the original byte-size length cannot be obtained from the serialized value directly. As such, all qlog schema definitions SHOULD include a separate, length-indicating field for all fields of type hexstring they specify, see for example . This not only ensures the original length can always be retrieved, but also allows the omission of any raw value bytes of the field completely (e.g., out of privacy or security considerations). To reduce overhead however and in the case the full raw value is logged, the extra length-indicating field can be left out. As such, tools SHOULD be able to deal with this situation and derive the length of the field from the raw value if no separate length-indicating field is present. The main possible permutations are shown by example in .

Example for serializing truncated hexstrings

Optimization of Serialized Data Both the JSON and JSON-SEQ formatting options described above are serviceable in general small to medium scale (debugging) setups. However, these approaches tend to be relatively verbose, leading to larger file sizes. Additionally, generalized JSON(-SEQ) (de)serialization performance is typically (slightly) lower than that of more optimized and predictable formats. Both aspects present challenges to large scale setups, though they may still be practical to deploy; see . JSON and JSON-SEQ compress very well using commonly-available algorithms such as GZIP or Brotli. During the development of qlog, a multitude of alternative formatting and optimization options were assessed and the results are summarized on the qlog github repository. Formal definition of additional qlog formats or encodings that use these or any other optimization techniques is left to future activity, which can apply the following guideline. In order to help tools correctly parse and process serialized qlog, it is RECOMMENDED that new formats also define suitable file extensions and media types. This provides a clear signal and avoids the need to provide out-of-band information or to rely on heuristic fallbacks; see .

Methods of Access and Generation Different implementations will have different ways of generating and storing qlogs. However, there is still value in defining a few default ways in which to steer this generation and access of the results.

Set File Output Destination via an Environment Variable To provide users control over where and how qlog files are created, two environment variables are defined. The first, QLOGFILE, indicates a full path to where an individual qlog file should be stored. This path MUST include the full file extension. The second, QLOGDIR, sets a general directory path in which qlog files should be placed. This path MUST include the directory separator character at the end. In general, QLOGDIR should be preferred over QLOGFILE if an endpoint is prone to generate multiple qlog files. This can for example be the case for a QUIC server implementation that logs each QUIC connection in a separate qlog file. An alternative that uses QLOGFILE would be a QUIC server that logs all connections in a single file and uses the group_id field () to allow post-hoc separation of events. Implementations SHOULD provide support for QLOGDIR and MAY provide support for QLOGFILE. When using QLOGDIR, it is up to the implementation to choose an appropriate naming scheme for the qlog files themselves. The chosen scheme will typically depend on the context or protocols used. For example, a QUIC implementation can use the Original Destination Connection ID (ODCID), followed by the vantage point type of the logging endpoint; see . Examples of all options for QUIC are shown in .

Environment variable examples for a QUIC implementation

Tooling Requirements Tools ingesting qlog MUST indicate which serialization format(s), qlog file and event schema(s), compression methods and potentially other input file formats (for example .pcap) they support. Tools SHOULD at least support .qlog files in the JSON format (). Additionally, they SHOULD indicate exactly which values for and properties of the name (namespace:event_type) and data fields they look for to execute their logic. Tools SHOULD perform a (high-level) check if an input qlog file adheres to the expected qlog file and event schemas. If a tool determines a qlog file does not contain enough supported information to correctly execute the tool's logic, it SHOULD generate a clear error message to this effect. Tools MUST NOT produce breaking errors for any field names and/or values in the qlog format that they do not recognize. Tools SHOULD indicate even unknown event occurrences within their context (e.g., marking unknown events on a timeline for manual interpretation by the user). Tool authors should be aware that, depending on the logging implementation, some events will not always be present in all traces. For example, using a circular logging buffer of a fixed size, it could be that the earliest events (e.g., connection setup events) are later overwritten by "newer" events. Alternatively, some events can be intentionally omitted out of privacy or file size considerations. Tool authors are encouraged to make their tools robust enough to still provide adequate output for incomplete logs. Tool authors should also be aware that events reflect the view of the logging implementation; see . A trace can therefore disagree with a packet capture, or with a trace from another vantage point.

Security and Privacy Considerations Protocols such as TLS and QUIC encrypt much of what they send, which limits what their wire image reveals to observers. Logging can record information that the wire image does not reveal, creating tension between observability, security and privacy, especially if data can be correlated across data sources. qlog can record a broad and detailed range of data. Operators and implementers are responsible for deciding what to log, based on their requirements and constraints. Logged data can be compromised (), which risks the privacy of all participants. Participants who rely on protocol features, such as encryption, to protect their data can be exposed through logging to privacy risks that they are unaware of and cannot assess or respond to.

Data at Risk qlog operators and implementers need to consider security and privacy risks when handling qlog data, including logging, storage, usage, and more. The data types listed in this section can pose different levels of risk, depending on the data itself and how it is handled. The following is a non-exhaustive list of example data types that could contain sensitive information that might allow identification or correlation of individual connections, endpoints, users or sessions across qlog or other data sources (e.g., captures of encrypted packets):

• IP addresses and transport protocol port numbers.
• Session, Connection, or User identifiers e.g., QUIC Connection IDs ().
• System-level information e.g., CPU, process, or thread identifiers.
• Stored State e.g., QUIC address validation and retry tokens, TLS session tickets, and HTTP cookies.
• TLS decryption keys, passwords, and HTTP-level API access or authorization tokens.
• High-resolution event timestamps or inter-event timings, event counts, packet sizes, and frame sizes.
• Full or partial raw packet and frame payloads that are encrypted.
• Full or partial raw packet and frame payloads that are plaintext e.g., HTTP Field values, HTTP response data, or TLS SNI field values.

Operational Implications and Recommendations Operational considerations focus on authorizing capture and access to logs. Logging of Internet protocols using qlog can be equivalent to the ability to store or read plaintext communications. Without a more detailed analysis, all of the security considerations of plaintext access apply. End users might not understand the implications of qlog for security or privacy, and their environments might limit access control techniques. Operators and implementers are advised to:

• Subject qlog capture to access control and auditing, with controls that support granular levels of information capture based on role and permissions (e.g., capture of more-sensitive data requires higher privileges).
• Subject access to stored qlog files to access control and auditing.
• Make enabling qlog conspicuous (e.g., requiring clear and explicit actions to start a capture) and resistant to social engineering, automation, or drive-by attacks (e.g., by isolating or sandboxing capture from other activities in the same process or component).
• Define data retention policies for the storage of qlog files.
• Encrypt qlog files in transit and at rest.

Data Minimization or Anonymization Applying data minimization or anonymization techniques to qlog might help address some security and privacy risks. However, removing or anonymizing data without sufficient care might not enhance privacy or security and could diminish the utility of qlog data. Operators and implementers are advised to balance the value of logged data against the potential risks of voluntary or involuntary disclosure to trusted or untrusted entities. Importantly, both the breadth and depth of the data needed to make it useful, as well as the definition of entities depend greatly on the intended use cases. For example, a research project might be tightly scoped, time bound, and require participants to explicitly opt in to having their data collected and shared in a publication. Conversely, a server administrator might collect telemetry on an ongoing basis for operational needs, from users with whom they have no relationship. The most extreme form of minimization or anonymization is deleting a field, equivalent to not logging it. qlog implementations are advised to offer fine-grained control over this on a per-use-case or per-connection basis. Data can undergo anonymization, pseudonymization, permutation, truncation, re-encryption, or aggregation; see for techniques, especially regarding IP addresses. However, operators are advised to be cautious, because many anonymization methods have been shown to be insufficient to safeguard user privacy or identity, particularly with large or easily correlated data sets. Operators are advised to consider end user rights and preferences. Active user participation (as indicated by ) on a per-qlog basis is challenging but aligning qlog capture, storage, and removal with existing user preference and privacy controls is crucial. Operators are advised to consider aggressive approaches to deletion or aggregation. Some of the most sensitive data in qlog is contained in RawInfo fields (see ), which can hold full packet and frame contents, and in fields that log keys or plaintext application data; see . qlog users are advised to include such fields only when a use case needs them.

IANA Considerations IANA is requested to register a new entry in the "IETF URN Sub-namespace for Registered Protocol Parameter Identifiers" registry ():

Registered Parameter Identifier:

qlog

Reference:

This Document

IANA Registry Reference:

IANA is requested to create the "qlog log file schema URIs" registry under a new "qlog" heading at for the purpose of registering log file schemas. Registrations use the Expert Review policy (); gives the registration requirements and the instructions for the designated expert. The registry has the following format/template:

Log File Schema URI:

[the log file schema identifier]

Description:

[a description of the log file schema]

Reference:

[to a specification defining the log file schema]

This document furthermore adds the following two new entries to the "qlog log file schema URIs" registry:

Log File Schema URI	Description	Reference
urn:ietf:params:qlog:file:contained	Concrete log file schema that can contain several traces from multiple vantage points.
urn:ietf:params:qlog:file:sequential	Concrete log file schema containing a single trace, optimized for sequential read and write access.

IANA is requested to create the "qlog event schema URIs" registry under the "qlog" heading at for the purpose of registering event schemas. Registrations use the Expert Review policy (); gives the registration requirements and the instructions for the designated expert. The registry has the following format/template:

Event schema URI:

[the event schema identifier]

Namespace:

[the identifier of the namespace that this event schema either defines or extends]

Event Types:

[a comma-separated list of concrete event types defined in the event schema; a private or non-standard event schema need not list them]

Description:

[a description of the event schema]

Reference:

[to a specification defining the event schema definition]

This document furthermore adds the following two new entries to the "qlog event schema URIs" registry:

Event schema URI:

urn:ietf:params:qlog:events:loglevel

Namespace:

loglevel

Event Types:

error,warning,info,debug,verbose

Description:

Well-known logging levels for free-form text.

Reference:

Event schema URI:

urn:ietf:params:qlog:events:simulation

Namespace:

simulation

Event Types:

scenario,marker

Description:

Events for simulation testing.

Reference:

Media Type Registrations IANA is requested to register the following media types in the "Media Types" registry <https://www.iana.org/assignments/media-types/>.

application/qlog+json Media Type

Type name:

application

Subtype name:

qlog+json

Required parameters:

N/A

Optional parameters:

N/A

Encoding considerations:

binary; see

Security considerations:

See of this document

Interoperability considerations:

See of this document

Published specification:

This document

Applications that use this media type:

Applications that generate, consume, or process qlog-format network protocol logs, such as protocol analyzers, debugging tools, and performance monitoring systems.

Fragment identifier considerations:

The syntax and semantics of fragment identifiers are as specified for "application/json"; see .

Additional information:

Deprecated alias names for this type:

N/A

Magic number(s):

N/A

File extension(s):

.qlog

Macintosh file type code(s):

N/A

Person & email address to contact for further information:

QUIC WG, quic@ietf.org

Intended usage:

COMMON

Restrictions on usage:

N/A

Author:

QUIC WG, quic@ietf.org

Change controller:

IETF

application/qlog+json-seq Media Type

Type name:

application

Subtype name:

qlog+json-seq

Required parameters:

N/A

Optional parameters:

N/A

Encoding considerations:

binary; see

Security considerations:

See of this document

Interoperability considerations:

See of this document

Published specification:

This document

Applications that use this media type:

Applications that generate, consume, or process qlog-format network protocol logs in a streaming fashion, such as protocol analyzers, debugging tools, and performance monitoring systems.

Fragment identifier considerations:

The syntax and semantics of fragment identifiers are as specified for "application/json-seq"; see .

Additional information:

Deprecated alias names for this type:

N/A

Magic number(s):

N/A

File extension(s):

.sqlog

Macintosh file type code(s):

N/A

Person & email address to contact for further information:

QUIC WG, quic@ietf.org

Intended usage:

COMMON

Restrictions on usage:

N/A

Author:

QUIC WG, quic@ietf.org

Change controller:

IETF

References Normative References JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format. It was derived from the ECMAScript Programming Language Standard. JSON defines a small set of formatting rules for the portable representation of structured data. This document removes inconsistencies with other specifications of JSON, repairs specification errors, and offers experience-based interoperability guidance. I-JSON (short for "Internet JSON") is a restricted profile of JSON designed to maximize interoperability and increase confidence that software can process it successfully with predictable results. This document describes the JavaScript Object Notation (JSON) text sequence format and associated media type "application/json-seq". A JSON text sequence consists of any number of JSON texts, all encoded in UTF-8, each prefixed by an ASCII Record Separator (0x1E), and each ending with an ASCII Line Feed character (0x0A). In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. This document proposes a notational convention to express Concise Binary Object Representation (CBOR) data structures (RFC 7049). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON. This second document defines the general structure of the MIME media typing system and defines an initial set of media types. [STANDARDS-TRACK] A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] Many protocols make use of points of extensibility that use constants to identify various protocol parameters. To ensure that the values in these fields do not have conflicting uses and to promote interoperability, their allocations are often coordinated by a central record keeper. For IETF protocols, that role is filled by the Internet Assigned Numbers Authority (IANA). To make assignments in a given registry prudently, guidance describing the conditions under which new values should be assigned, as well as when and how modifications to existing values can be made, is needed. This document defines a framework for the documentation of these guidelines by specification authors, in order to assure that the provided guidance for the IANA Considerations is clear and addresses the various issues that are likely in the operation of a registry. This is the third edition of this document; it obsoletes RFC 5226. This document defines a date and time format for use in Internet protocols that is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. A content media type name sometimes includes partitioned meta- information distinguished by a structured syntax to permit noting an attribute of the media as a suffix to the name. This document defines several structured syntax suffixes for use with media type registrations. In particular, it defines and registers the "+json", "+ber", "+der", "+fastinfoset", "+wbxml" and "+zip" structured syntax suffixes, and provides a media type structured syntax suffix registration form for the "+xml" structured syntax suffix. This document is not an Internet Standards Track specification; it is published for informational purposes. Structured syntax suffixes for media types allow other media types to build on them and make it explicit that they are built on an existing media type as their foundation. This specification defines and registers "+json-seq" as a structured syntax suffix for JSON text sequences. This document describes a new sub-delegation for the 'ietf' URN namespace for registered protocol items. The 'ietf' URN namespace is defined in RFC 2648 as a root for persistent URIs that refer to IETF- defined resources. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Informative References Akamai Meta Cloudflare This document describes a qlog event schema containing concrete qlog event definitions and their metadata for the core QUIC protocol and selected extensions. 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. Akamai Meta Cloudflare This document defines qlog event schemas containing concrete events for the core HTTP/3 protocol and selected extensions. It also defines an http namespace for the Capsule Protocol. 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. This document specifies version 1.3 of the Transport Layer Security (TLS) protocol. TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery. This document updates RFCs 5705 and 6066, and obsoletes RFCs 5077, 5246, and 6961. This document also specifies new requirements for TLS 1.2 implementations. This document defines the core of the QUIC transport protocol. QUIC provides applications with flow-controlled streams for structured communication, low-latency connection establishment, and network path migration. QUIC includes security measures that ensure confidentiality, integrity, and availability in a range of deployment circumstances. Accompanying documents describe the integration of TLS for key negotiation, loss detection, and an exemplary congestion control algorithm. This document defines the wire image, an abstraction of the information available to an on-path non-participant in a networking protocol. This abstraction is intended to shed light on the implications that increased encryption has for network functions that use the wire image. This document offers guidance for developing privacy considerations for inclusion in protocol specifications. It aims to make designers, implementers, and users of Internet protocols aware of privacy-related design choices. It suggests that whether any individual RFC warrants a specific privacy considerations section will depend on the document's content. This document presents operational, policy, and security considerations for DNS recursive resolver operators who choose to offer DNS privacy services. With these recommendations, the operator can make deliberate decisions regarding which services to provide, as well as understanding how those decisions and the alternatives impact the privacy of users. This document also presents a non-normative framework to assist writers of a Recursive operator Privacy Statement, analogous to DNS Security Extensions (DNSSEC) Policies and DNSSEC Practice Statements described in RFC 6841.

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, Christian Huitema, Hugo Landau, Will Hawkins, Mathis Engelbart, Kazuho Oku, and Jonathan Lennox for their feedback and suggestions.

Change Log

Since draft-ietf-quic-qlog-main-schema-14:

• Wide range of editorial and consistency changes

Since draft-ietf-quic-qlog-main-schema-13:

• Added IANA registration templates (#425)
• Added clarification on extending qlog with new protocol support (#516)
• Wide range of editorial changes

Since draft-ietf-quic-qlog-main-schema-12:

• Changed Path and related fields to Tuple (#491)
• Replaced all lenght fields with raw.length (#495)

Since draft-ietf-quic-qlog-main-schema-10:

• Multiple editorial changes
• Remove protocol_types and move event_schemas to Trace and TraceSeq (#449)

Since draft-ietf-quic-qlog-main-schema-09:

• Renamed protocol_type to protocol_types (#427)
• Moved Trigger section. Purely editorial (#430)
• Removed the concept of categories and updated extension and event schema logic to match. Major change (#439)
• Reworked completely how we handle timestamps and clocks. Major change (#433)

Since draft-ietf-quic-qlog-main-schema-08:

• TODO (we forgot...)

Since draft-ietf-quic-qlog-main-schema-07:

• Added path and PathID (#336)
• Removed custom definition of uint64 type (#360, #388)
• ProtocolEventBody is now called ProtocolEventData (#352)
• Editorial changes (#364, #289, #353, #361, #362)

Since draft-ietf-quic-qlog-main-schema-06:

• Editorial reworking of the document (#331, #332)
• Updated IANA considerations section (#333)

Since draft-ietf-quic-qlog-main-schema-05:

• Updated qlog_version to 0.4 (due to breaking changes) (#314)
• Renamed 'transport' category to 'quic' (#302)
• Added 'system_info' field (#305)
• Removed 'summary' and 'configuration' fields (#308)
• Editorial and formatting changes (#298, #303, #304, #316, #320, #321, #322, #326, #328)

Since draft-ietf-quic-qlog-main-schema-04:

• Updated RawInfo definition and guidance (#243)

Since draft-ietf-quic-qlog-main-schema-03:

• Added security and privacy considerations discussion (#252)

Since draft-ietf-quic-qlog-main-schema-02:

• No changes - new draft to prevent expiration

Since draft-ietf-quic-qlog-main-schema-01:

• Change the data definition language from TypeScript to CDDL (#143)

Since draft-ietf-quic-qlog-main-schema-00:

• Changed the streaming serialization format from NDJSON to JSON Text Sequences (#172)
• Added Media Type definitions for various qlog formats (#158)
• Changed to semantic versioning

Since draft-marx-qlog-main-schema-draft-02:

• These changes were done in preparation of the adoption of the drafts by the QUIC working group (#137)
• Moved RawInfo, Importance, Generic events and Simulation events to this document.
• Added basic event definition guidelines
• Made protocol_type an array instead of a string (#146)

Since draft-marx-qlog-main-schema-01:

• Decoupled qlog from the JSON format and described a mapping instead (#89)
  • Data types are now specified in this document and proper definitions for fields were added in this format
  • 64-bit numbers can now be either strings or numbers, with a preference for numbers (#10)
  • binary blobs are now logged as lowercase hex strings (#39, #36)
  • added guidance to add length-specifiers for binary blobs (#102)
• Removed "time_units" from Configuration. All times are now in ms instead (#95)
• Removed the "event_fields" setup for a more straightforward JSON format (#101,#89)
• Added a streaming option using the NDJSON format (#109,#2,#106)
• Described optional optimization options for implementers (#30)
• Added QLOGDIR and QLOGFILE environment variables, clarified the .well-known URL usage (#26,#33,#51)
• Overall tightened up the text and added more examples

Since draft-marx-qlog-main-schema-00:

• All field names are now lowercase (e.g., category instead of CATEGORY)
• Triggers are now properties on the "data" field value, instead of separate field types (#23)
• group_ids in common_fields is now just also group_id