Skip to content

Commit

Permalink
Fixed markdown nits, aligned module prefixes, a spelling error and mo…
Browse files Browse the repository at this point in the history
…ved the latest document history entry to the right place
  • Loading branch information
janlindblad committed Nov 5, 2024
1 parent 40afb7d commit 708bd5f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
33 changes: 18 additions & 15 deletions draft-ietf-netconf-trace-ctx-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ docname: draft-ietf-netconf-trace-ctx-extension-latest
ipr: trust200902
submissiontype: IETF
consensus: true
v: 4
v: 3
area: "Operations and Management"
workgroup: "Network Configuration"
keyword:
Expand Down Expand Up @@ -136,17 +136,20 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT","SHOULD","SHO

Additionally, the document utilizes the following abbreviations:

- OTLP: OpenTelemetry protocol as defined by {{OpenTelemetry}}
OTLP:
: OpenTelemetry protocol as defined by {{OpenTelemetry}}

- M.E.L.T: Metrics, Events, Logs and Traces
M.E.L.T:
: Metrics, Events, Logs and Traces

- gNMI: gRPC Network Management Interface, as defined by {{gNMI}}
gNMI:
: gRPC Network Management Interface, as defined by {{gNMI}}

The XML prefixes used in this document are mapped as follows:

- xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0",
- xmlns:w3ctc="urn:ietf:params:xml:ns:netconf:w3ctc:1.0" and
- xmlns:ietf-trce-context=
- xmlns:ietf-trace-context=
"urn:ietf:params:xml:ns:yang:trace-context"

## Implementation example 1: OpenTelemetry
Expand Down Expand Up @@ -354,21 +357,21 @@ We define a pair YANG modules (ietf-trace-context-traceparent-version-1.0.yang a
{::include src/yang/ietf-trace-context.yang}
~~~~
{: sourcecode-markers="true"
sourcecode-name="[email protected]}
sourcecode-name="[email protected]"}

## YANG module for traceparent header version 1.0
~~~~ yang
{::include src/yang/ietf-trace-context-traceparent-version-1.0.yang}
~~~~
{: sourcecode-markers="true"
sourcecode-name="[email protected]}
sourcecode-name="[email protected]"}

## YANG module for tracestate header version 1.0
~~~~ yang
{::include src/yang/ietf-trace-context-tracestate-version-1.0.yang}
~~~~
{: sourcecode-markers="true"
sourcecode-name="[email protected]}
sourcecode-name="[email protected]"}

# Security Considerations

Expand All @@ -390,7 +393,7 @@ This document registers the following capability identifier URN in the 'Network
urn:ietf:params:netconf:capability:w3ctc:1.0
~~~

This document registers one XML namespace URN in the 'IETF XML registry', following the format defined in {{RFC3688}} (https://tools.ietf.org/html/rfc3688).
This document registers one XML namespace URN in the 'IETF XML registry', following the format defined in {{RFC3688}} (https://www.rfc-editor.org/rfc/rfc3688.html).

~~~
URI: urn:ietf:params:xml:ns:netconf:w3ctc:1.0
Expand All @@ -405,7 +408,7 @@ This document registers three module names in the 'YANG Module Names' registry,
~~~
name: ietf-trace-context-traceparent-version-1.0

prefix: ietf-trace-context-otlpparent-1.0
prefix: ietf-trace-context-traceparent-version-1.0

namespace: urn:ietf:params:xml:ns:yang:traceparent:1.0

Expand All @@ -417,7 +420,7 @@ and
~~~
name: ietf-trace-context-tracestate-version-1.0

prefix: ietf-trace-context-otlpstate-1.0
prefix: ietf-trace-context-tracestate-version-1.0

namespace: urn:ietf:params:xml:ns:yang:tracestate:1.0

Expand All @@ -444,6 +447,10 @@ The authors would like to acknowledge the valuable implementation feedback from

# Changes (to be deleted by RFC Editor)

## From version 01 to 02
- Enhanced Terminology and moved it up in the document.
- Changed namespaces and module names to map WGLC comments.

## From version 00 to 01
- Added Security considerations
- Added Acknowledgements
Expand Down Expand Up @@ -474,10 +481,6 @@ The authors would like to acknowledge the valuable implementation feedback from
- Added new use case: Billing and auditing
- Added in introduction and in "Provisioning root cause analysis" the idea that the different transaction-ids defined in {{I-D.ietf-netconf-transaction-id}} could be added as part of the tracing information to be exported to the collectors, showing how the two documents are complementary.

## From version 03 to 04
- Enhanced Terminology and moved it up in the document.
- Changed namespaces and module names to map WGLC comments.

# XML Attributes vs RPCs input augmentations discussion (to be deleted by RFC Editor)

There are arguments that can be raised regarding using XML Attribute or to augment NETCONF RPCs.
Expand Down
2 changes: 1 addition & 1 deletion src/yang/ietf-trace-context-traceparent-version-1.0.yang
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module ietf-trace-context-traceparent-version-1.0 {
namespace "urn:ietf:params:xml:ns:yang:traceparent:1.0";
prefix ietf-trace-context-otlpparent-1.0;
prefix ietf-trace-context-traceparent-version-1.0;
}
2 changes: 1 addition & 1 deletion src/yang/ietf-trace-context-tracestate-version-1.0.yang
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module ietf-trace-context-tracestate-version-1.0 {
namespace "urn:ietf:params:xml:ns:yang:tracestate:1.0";
prefix ietf-trace-context-otlpstate-1.0;
prefix ietf-trace-context-tracestate-version-1.0;
}
2 changes: 1 addition & 1 deletion src/yang/ietf-trace-context.yang
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module ietf-trace-context {
"IETF NETCONF (Network Configuration) Working Group";

contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
"WG Web: <https://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>";

description
Expand Down

0 comments on commit 708bd5f

Please sign in to comment.