Skip to content

Commit

Permalink
Script updating gh-pages from c8f31b1. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
ID Bot committed Jul 6, 2024
1 parent 17442db commit a78552d
Show file tree
Hide file tree
Showing 2 changed files with 174 additions and 24 deletions.
106 changes: 95 additions & 11 deletions behold-schema/draft-ietf-quic-qlog-main-schema.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1176,7 +1176,7 @@ <h2 id="name-copyright-notice">
<p id="section-toc.1-1.3.1"><a href="#section-3" class="auto internal xref">3</a>.  <a href="#name-abstract-logfile-class" class="internal xref">Abstract LogFile Class</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.1">
<p id="section-toc.1-1.3.2.1.1"><a href="#section-3.1" class="auto internal xref">3.1</a>.  <a href="#name-concrete-log-file-schema-ur" class="internal xref">Concrete Log File Schema URI</a></p>
<p id="section-toc.1-1.3.2.1.1"><a href="#section-3.1" class="auto internal xref">3.1</a>.  <a href="#name-concrete-log-file-schema-ur" class="internal xref">Concrete Log File Schema URIs</a></p>
</li>
</ul>
</li>
Expand Down Expand Up @@ -1698,18 +1698,47 @@ <h2 id="name-abstract-logfile-class">
<div id="schema-uri">
<section id="section-3.1">
<h3 id="name-concrete-log-file-schema-ur">
<a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-concrete-log-file-schema-ur" class="section-name selfRef">Concrete Log File Schema URI</a>
<a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-concrete-log-file-schema-ur" class="section-name selfRef">Concrete Log File Schema URIs</a>
</h3>
<p id="section-3.1-1">Concrete log file schemas <span class="bcp14">MUST</span> identify themselves using a URI.<a href="#section-3.1-1" class="pilcrow"></a></p>
<p id="section-3.1-2">Log file schemas defined by RFCs <span class="bcp14">SHOULD</span> be URN of the form
<p id="section-3.1-2">Log file schemas defined by RFCs <span class="bcp14">MUST</span> register a URI in the "qlog log file
schema URIs" registry and <span class="bcp14">SHOULD</span> use a URN of the form
<code>urn:ietf:params:qlog:file:&lt;schema-identifier&gt;</code>, where <code>&lt;schema-identifier&gt;</code> is
a globally-unique name. URN <span class="bcp14">MUST</span> be registered with IANA; see <a href="#iana" class="auto internal xref">Section 15</a>.<a href="#section-3.1-2" class="pilcrow"></a></p>
<p id="section-3.1-3">Private or non-standard log file schemas can use other URI formats. URIs that
contain a domain name <span class="bcp14">SHOULD</span> also contain a month-date in the form mmyyyy. For
example, "https://example.org/072024/customfileschema". The definition of the
file schema and assignment of the URI <span class="bcp14">MUST</span> 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. For example,<a href="#section-3.1-3" class="pilcrow"></a></p>
a globally-unique name. This document registers
<code>urn:ietf:params:qlog:file:contained</code> (<a href="#qlog-file-schema" class="auto internal xref">Section 4</a>) and
<code>urn:ietf:params:qlog:file:sequential</code> (<a href="#qlog-file-seq-schema" class="auto internal xref">Section 5</a>).<a href="#section-3.1-2" class="pilcrow"></a></p>
<p id="section-3.1-3">Private or non-standard log file schemas <span class="bcp14">MAY</span> register a URI in the "qlog log
file schema" registry but <span class="bcp14">MUST NOT</span> use a URN of the form
<code>urn:ietf:params:qlog:file:&lt;schema-identifier&gt;</code>. URIs that contain a domain name
<span class="bcp14">SHOULD</span> also contain a month-date in the form mmyyyy. For example,
"https://example.org/072024/customfileschema". The definition of the log file
schema and assignment of the URI <span class="bcp14">MUST</span> 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.<a href="#section-3.1-3" class="pilcrow"></a></p>
<p id="section-3.1-4">The "qlog log file schema URIs" registry operates under the Expert Review
policy, per <span><a href="https://rfc-editor.org/rfc/rfc8126#section-4.5" class="relref">Section 4.5</a> of [<a href="#RFC8126" class="cite xref">RFC8126</a>]</span>. When reviewing requests, the expert
<span class="bcp14">MUST</span> check that the URI is appropriate to the concrete log file format and
satisfies the requirements in this section. A request to register a private or
non-standard log schema URI using a URN of the form
<code>urn:ietf:params:qlog:file:&lt;schema-identifier&gt;</code> <span class="bcp14">MUST</span> be rejected.<a href="#section-3.1-4" class="pilcrow"></a></p>
<p id="section-3.1-5">Registration requests should use the following template:<a href="#section-3.1-5" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlParallel" id="section-3.1-6">
<dt id="section-3.1-6.1">Log File Schema URI:</dt>
<dd style="margin-left: 1.5em" id="section-3.1-6.2">
<p id="section-3.1-6.2.1">[the log file schema identifier]<a href="#section-3.1-6.2.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-3.1-6.3">Description:</dt>
<dd style="margin-left: 1.5em" id="section-3.1-6.4">
<p id="section-3.1-6.4.1">[a description of the log file schema]<a href="#section-3.1-6.4.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-3.1-6.5">Reference:</dt>
<dd style="margin-left: 1.5em" id="section-3.1-6.6">
<p id="section-3.1-6.6.1">[to a specification defining the log file schema]<a href="#section-3.1-6.6.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
</section>
Expand Down Expand Up @@ -3566,7 +3595,54 @@ <h3 id="name-data-minimization-or-anonym">
<h2 id="name-iana-considerations">
<a href="#section-15" class="section-number selfRef">15. </a><a href="#name-iana-considerations" class="section-name selfRef">IANA Considerations</a>
</h2>
<p id="section-15-1">TODO: file and event schema registration stuff<a href="#section-15-1" class="pilcrow"></a></p>
<p id="section-15-1">IANA is requested to register a new entry in the "IETF URN Sub-namespace for
Registered Protocol Parameter Identifiers" registry (<span>[<a href="#RFC3553" class="cite xref">RFC3553</a>]</span>)":<a href="#section-15-1" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlParallel" id="section-15-2">
<dt id="section-15-2.1">Registered Parameter Identifier:</dt>
<dd style="margin-left: 1.5em" id="section-15-2.2">
<p id="section-15-2.2.1">qlog<a href="#section-15-2.2.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-15-2.3">Reference:</dt>
<dd style="margin-left: 1.5em" id="section-15-2.4">
<p id="section-15-2.4.1">This Document<a href="#section-15-2.4.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-15-2.5">IANA Registry Reference:</dt>
<dd style="margin-left: 1.5em" id="section-15-2.6">
<p id="section-15-2.6.1"><span>&lt;<a href="https://www.iana.org/assignments/qlog">https://www.iana.org/assignments/qlog</a>&gt;</span><a href="#section-15-2.6.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-15-3">IANA is requested to create the "qlog log file schema URIs" registry
at <span><a href="https://www.iana.org/assignments/qlog">https://www.iana.org/assignments/qlog</a></span> for the purpose of registering
log file schema. It has the following format:<a href="#section-15-3" class="pilcrow"></a></p>
<table class="center" id="table-1">
<caption><a href="#table-1" class="selfRef">Table 1</a></caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Log File Schema URI</th>
<th class="text-left" rowspan="1" colspan="1">Description</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">urn:ietf:params:qlog:file:contained</td>
<td class="text-left" rowspan="1" colspan="1">Concrete log file format that can contain several traces from multiple vantage points.</td>
<td class="text-left" rowspan="1" colspan="1">
<a href="#qlog-file-schema" class="auto internal xref">Section 4</a>
</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">urn:ietf:params:qlog:file:sequential</td>
<td class="text-left" rowspan="1" colspan="1">Concrete log file format containing a single trace, optimized for seqential read and write access.</td>
<td class="text-left" rowspan="1" colspan="1">
<a href="#qlog-file-seq-schema" class="auto internal xref">Section 5</a>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<section id="section-16">
Expand Down Expand Up @@ -3607,6 +3683,10 @@ <h3 id="name-normative-references">
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc2119">https://www.rfc-editor.org/rfc/rfc2119</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC3553">[RFC3553]</dt>
<dd>
<span class="refAuthor">Mealling, M.</span>, <span class="refAuthor">Masinter, L.</span>, <span class="refAuthor">Hardie, T.</span>, and <span class="refAuthor">G. Klyne</span>, <span class="refTitle">"An IETF URN Sub-namespace for Registered Protocol Parameters"</span>, <span class="seriesInfo">BCP 73</span>, <span class="seriesInfo">RFC 3553</span>, <span class="seriesInfo">DOI 10.17487/RFC3553</span>, <time datetime="2003-06" class="refDate">June 2003</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc3553">https://www.rfc-editor.org/rfc/rfc3553</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC6839">[RFC6839]</dt>
<dd>
<span class="refAuthor">Hansen, T.</span> and <span class="refAuthor">A. Melnikov</span>, <span class="refTitle">"Additional Media Type Structured Syntax Suffixes"</span>, <span class="seriesInfo">RFC 6839</span>, <span class="seriesInfo">DOI 10.17487/RFC6839</span>, <time datetime="2013-01" class="refDate">January 2013</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc6839">https://www.rfc-editor.org/rfc/rfc6839</a>&gt;</span>. </dd>
Expand All @@ -3623,6 +3703,10 @@ <h3 id="name-normative-references">
<dd>
<span class="refAuthor">Wilde, E.</span>, <span class="refTitle">"A Media Type Structured Syntax Suffix for JSON Text Sequences"</span>, <span class="seriesInfo">RFC 8091</span>, <span class="seriesInfo">DOI 10.17487/RFC8091</span>, <time datetime="2017-02" class="refDate">February 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc8091">https://www.rfc-editor.org/rfc/rfc8091</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC8126">[RFC8126]</dt>
<dd>
<span class="refAuthor">Cotton, M.</span>, <span class="refAuthor">Leiba, B.</span>, and <span class="refAuthor">T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="seriesInfo">BCP 26</span>, <span class="seriesInfo">RFC 8126</span>, <span class="seriesInfo">DOI 10.17487/RFC8126</span>, <time datetime="2017-06" class="refDate">June 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc8126">https://www.rfc-editor.org/rfc/rfc8126</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC8174">[RFC8174]</dt>
<dd>
<span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc8174">https://www.rfc-editor.org/rfc/rfc8174</a>&gt;</span>. </dd>
Expand Down
92 changes: 79 additions & 13 deletions behold-schema/draft-ietf-quic-qlog-main-schema.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Table of Contents
1.2. Use of CDDL
2. Design Overview
3. Abstract LogFile Class
3.1. Concrete Log File Schema URI
3.1. Concrete Log File Schema URIs
4. QlogFile schema
4.1. Traces
4.2. Trace
Expand Down Expand Up @@ -385,22 +385,41 @@ Table of Contents
Figure 3: Example of using a generic CDDL group socket to extend
logfile- extensions

3.1. Concrete Log File Schema URI
3.1. Concrete Log File Schema URIs

Concrete log file schemas MUST identify themselves using a URI.

Log file schemas defined by RFCs SHOULD be URN of the form
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 name. URN MUST be registered with
IANA; see Section 15.
identifier> is a globally-unique name. This document registers
urn:ietf:params:qlog:file:contained (Section 4) and
urn:ietf:params:qlog:file:sequential (Section 5).

Private or non-standard log file schemas can use other URI formats.
URIs that contain a domain name SHOULD also contain a month-date in
the form mmyyyy. For example, "https://example.org/072024/
customfileschema". The definition of the 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. For example,
Private or non-standard log file schemas MAY register a URI in the
"qlog log file schema" 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/customfileschema". 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 "qlog log file schema URIs" registry operates under the Expert
Review policy, per Section 4.5 of [RFC8126]. When reviewing
requests, the expert MUST check that the URI is appropriate to the
concrete log file format and satisfies the requirements in this
section. A request to register a private or non-standard log schema
URI using a URN of the form urn:ietf:params:qlog:file:<schema-
identifier> MUST be rejected.

Registration requests should use the following 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]

4. QlogFile schema

Expand Down Expand Up @@ -1992,7 +2011,44 @@ Table of Contents

15. IANA Considerations

TODO: file and event schema registration stuff
IANA is requested to register a new entry in the "IETF URN Sub-
namespace for Registered Protocol Parameter Identifiers" registry
([RFC3553])":

Registered Parameter Identifier: qlog

Reference: This Document

IANA Registry Reference: <https://www.iana.org/assignments/qlog>

IANA is requested to create the "qlog log file schema URIs" registry
at https://www.iana.org/assignments/qlog for the purpose of
registering log file schema. It has the following format:

+======================================+================+===========+
| Log File Schema URI | Description | Reference |
+======================================+================+===========+
| urn:ietf:params:qlog:file:contained | Concrete log | Section 4 |
| | file format | |
| | that can | |
| | contain | |
| | several | |
| | traces from | |
| | multiple | |
| | vantage | |
| | points. | |
+--------------------------------------+----------------+-----------+
| urn:ietf:params:qlog:file:sequential | Concrete log | Section 5 |
| | file format | |
| | containing a | |
| | single trace, | |
| | optimized for | |
| | seqential | |
| | read and | |
| | write access. | |
+--------------------------------------+----------------+-----------+

Table 1

16. References

Expand Down Expand Up @@ -2034,6 +2090,11 @@ Table of Contents
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/rfc/rfc2119>.

[RFC3553] Mealling, M., Masinter, L., Hardie, T., and G. Klyne, "An
IETF URN Sub-namespace for Registered Protocol
Parameters", BCP 73, RFC 3553, DOI 10.17487/RFC3553, June
2003, <https://www.rfc-editor.org/rfc/rfc3553>.

[RFC6839] Hansen, T. and A. Melnikov, "Additional Media Type
Structured Syntax Suffixes", RFC 6839,
DOI 10.17487/RFC6839, January 2013,
Expand All @@ -2053,6 +2114,11 @@ Table of Contents
Text Sequences", RFC 8091, DOI 10.17487/RFC8091, February
2017, <https://www.rfc-editor.org/rfc/rfc8091>.

[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/rfc/rfc8126>.

[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/rfc/rfc8174>.
Expand Down

0 comments on commit a78552d

Please sign in to comment.