]> Cisco Systems

Avenue des Uttins 5 Rolle 1180 Switzerland rogaglia@cisco.com

Deutsche Telekom AG

kll@dev.terastrm.net

Cisco Systems

jlindbla@cisco.com

Operations and Management NETCONF telemetry distributed systems opentelemetry This document defines how to propagate trace context information across the Network Configuration Protocol (NETCONF), that enables distributed tracing scenarios. It is an adaption of the HTTP-based W3C specification. About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Discussion of this document takes place on the NETCONF Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction Network automation and management systems commonly consist of multiple sub-systems and together with the network devices they manage, they effectively form a distributed system. Distributed tracing is a methodology implemented by tracing tools to follow, analyze and debug operations, such as configuration transactions, across multiple distributed systems. An operation is uniquely identified by a trace-id and through a trace context, carries some metadata about the operation. Propagating this "trace context" between systems enables forming a coherent view of the entire operation as carried out by all involved systems. The W3C has defined two HTTP headers for context propagation that are useful in use case scenarios of distributed systems like the ones defined in . This document defines an extension to the NETCONF protocol to add the same concepts and enable trace context propagation over NETCONF. It is worth noting that the trace context is not meant to have any relationship with the data that is carried with a given operation (including configurations, service identifiers or state information). A trace context also differs from in several ways as the trace operation may involve any operation (including for example validate, lock, unlock, etc.) Additionally, a trace context scope may include the full application stack (orchestrator, controller, devices, etc) rather than a single NETCONF server, which is the scope for the transaction-id. The trace context is also complemetary to as a given trace-id can be associated with the different transaction-ids as part of the information exported to the collector. The following enhancement of the reference SDN Architecture from RFC 8309 shows the impact of distributed traces for a network operator. | | .------------------. | | . : . | | . : . | Collector | ------------ ------------ ------------ | (Metrics, | | | | | | | | Events, | | Controller | | Controller | | Controller | --> | Logs, | | | | | | | | Traces) | ------------ ------------ ------------ | | : . . : | | : . . : | | : . . : | | --------- --------- --------- --------- | | | Network | | Network | | Network | | Network | | | | Element | | Element | | Element | | Element | -> | | --------- --------- --------- --------- ------------- Figure 1: A Sample SDN Architecture from RFC8309 augmented to include the export of metrics, events, logs and traces from the different components to a common collector. ]]> The network automation, management and control architectures are distributed in nature. In order to "manage the managers", operators would like to use the same techniques as any other distributed systems in their IT environment. Solutions for analysing Metrics, Events, Logs and Traces (M.E.L.T) are key for the successful monitoring and troubleshooting of such applications. Initiatives such as the OpenTelemetry enable rich ecosystems of tools that NETCONF-based applications would want to participate in. With the implementation of this trace context propagation extension to NETCONF, backend systems behind the M.E.L.T collector will be able to correlate information from different systems but related to a common context.

Implementation example 1: OpenTelemetry We will describe an example to show the value of trace context propagation in the NETCONF protocol. In Figure 2, we show a deployment based on Figure 1 with a single controller and two network elements. In this example, the NETCONF protocol is running between the Orchestrator and the Controller. NETCONF is also used between the Controller and the Network Elements. Let's assume an edit-config operation between the orchestrator and the controller that results (either synchronously or asynchronously) in corresponding edit-config operations from the Controller towards the two network elements. All trace operations are related and will create M.E.L.T data. | | .------------------. | | . NETCONF | | . edit-config (trace-id "1", parent-id "A") | Collector | ------------ | (Metrics, | | | | Events, | | Controller | ------------------------------------> | Logs, | | | OTLP protocol | Traces) | ------------ | | : . NETCONF | | : . edit-config (trace-id "1", parent-id "B") | | : . | | --------- --------- | | | Network | | Network | OTLP protocol | | | Element | | Element | --------------------------> | | --------- --------- ------------- Figure 2: An implementation example where the NETCONF protocol is used between the Orchestrator and the Controller and also between the Controller and the Network Elements. Every component exports M.E.L.T information to the collector using the OTLP protocol. ]]> Each of the components in this example (Orchestrator, Controller and Network Elements) is exporting M.E.L.T information to the collector using the OpenTelemetry Protocol (OTLP). For every edit-config operation, the trace context is included. In particular, the same trace-id "1" (simplified encoding for documentation) is included in all related NETCONF messages, which enables the collector and any backend application to correlate all M.E.L.T messages related to this transaction in this distributed stack. Another interesting attribute is the parent-id. We can see in this example that the parent-id between the orchestrator and the controller ("A") is different from the one between the controller and the network elements ("B"). This attribute will help the collector and the backend applications to build a connectivity graph to understand how M.E.L.T information exported from one component relates to the information exported from a different component. With this additional metadata exchanged between the components and exposed to the M.E.L.T collector, there are important improvements to the monitoring and troubleshooting operations for the full application stack.

Implementation example 2: YANG DataStore OpenTelemetry implements the "push" model for data streaming where information is sent to the back-end as soon as produced and is not required to be stored in the system. In certain cases, a "pull" model may be envisioned, for example for performing forensic analysis while not all OTLP traces are available in the back-end systems. An implementation of a "pull" mechanism for M.E.L.T. information in general and for traces in particular, could consist of storing traces in a yang datastore (particularly the operational datastore.) Implementations should consider the use of circular buffers to avoid resources exhaustion. External systems could access traces (and particularly past traces) via NETCONF, RESTCONF, gNMI or other polling mechanisms. Finally, storing traces in a YANG datastore enables the use of YANG-Push or gNMI Telemetry as an additional "push" mechanisms. This document does not specify the YANG module in which traces could be stored inside the different components. That said, storing the context information described in this document as part of the recorded traces would allow back-end systems to correlate the information from different components as in the OpenTelemetry implementation. Note to be removed in the future: Some initial ideas are under discussion in the IETF for defining a standard YANG data model for traces. For example see: I-D.quilbeuf-opsawg-configuration-tracing which focusses only on configuration change root cause analysis use case (see the use case desciption below). These ideas are complementary to this draft. | | .------------------. pull or push | | . NETCONF | | . edit-config (trace-id "1", parent-id "A") | Collector | ---------------- | (Metrics, | | | NC/RC/gNMI or YP | Events, | | Controller | --------------------------------> | Logs, | | YANG DataStore| pull or push | Traces) | ---------------- | | : . NETCONF | | : . edit-config (trace-id "1", parent-id "B") | | : . | | --------- --------- | | | Network | | Network | NC/RC/gNMI or YP | | | Element | | Element | --------------------------> | | | YG DS | | YG DS | pull or push | | --------- --------- ------------- Figure 3: An implementation example where the NETCONF protocol is used between the Orchestrator and the Controller and also between the Controller and the Network Elements. M.E.L.T. information is stored in local Yang Datastores and accessed by the collector using "pull" mechanisms using the NETCONF (NC), RESTCONF (RC) or gNMI protocols. A "push" strategy is also possible via YANG-Push or gNMI. ]]>

Use Cases

Provisioning root cause analysis When a provisioning activity fails, errors are typically propagated northbound, however this information may be difficult to troubleshoot and typically, operators are required to navigate logs across all the different components. With the support for trace context propagation as described in this document for NETCONF, the collector will be able to search every trace, event, metric, or log in connection to that trace-id and faciliate the performance of a root cause analysis due to a network changes. The trace information could also be included as an optional resource with the different NETCONF transaction ids described in .

System performance profiling When operating a distributed system such as the one shown in Figure 2, operators are expected to benchmark Key Performance Indicators (KPIs) for the most common tasks. For example, what is the typical delay when provisioning a VPN service across different controllers and devices. Thanks to Application Performance Management (APM) systems, from these KPIs, an operator can detect a normal and abnormal behaviour of the distributed system. Also, an operator can better plan any upgrades or enhancements in the platform. With the support for context propagation as described in this document for NETCONF, much richer system-wide KPIs can be defined and used for troubleshooting as the metrics and traces propagated by the different components share a common context. Troubleshooting for abnormal behaviours can also be troubleshot from the system view down to the individual element.

Billing and auditing In certain circumstances, we could envision tracing infomration used as additional inputs to billing systems. In particular, trace context information could be used to validate that a certain northbound order was carried out in southbound systems.

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. 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-netconf-otlp-context= "urn:ietf:params:xml:ns:yang:ietf-netconf-otlp-context"

NETCONF Extension When performing NETCONF operations by sending NETCONF RPCs, a NETCONF client MAY include trace context information in the form of XML attributes. The defines two HTTP headers; traceparent and tracestate for this purpose. NETCONF clients that are taking advantage of this feature MUST add one w3ctc:traceparent attribute and MAY add one w3ctc:tracestate attribute to the nc:rpc tag. A NETCONF server that receives a trace context attribute in the form of a w3ctc:traceparent attribute SHOULD apply the mutation rules described in . A NETCONF server MAY add one w3ctc:traceparent attribute in the nc:rpc-reply response to the nc:rpc tag above. NETCONF servers MAY also add one w3ctc:traceparent attribute in notification and update message envelopes: notif:notification, yp:push-update and yp:push-change-update. For example, a NETCONF client might send: ]]> In all cases above where a client or server adds a w3ctc:traceparent attribute to a tag, that client or server MAY also add one w3ctc:tracestate attribute to the same tag. The proper encoding and interpretation of the contents of the w3ctc:traceparent attribute is described in section 3.2 except 3.2.1. The proper encoding and interpretation of the contents in the w3ctc:tracestate attribute is described in section 3.3 except 3.3.1 and 3.3.1.1. A NETCONF XML tag can only have zero or one w3ctc:tracestate attributes, so its content MUST always be encoded as a single string. The tracestate field value is a list of list-members separated by commas (,). A list-member is a key/value pair separated by an equals sign (=). Spaces and horizontal tabs surrounding list-members are ignored. There is no limit to the number of list-members in a list. For example, a NETCONF client might send: ]]> As in all XML documents, the order between the attributes in an XML tag has no significance. Clients and servers MUST be prepared to handle the attributes no matter in which order they appear. The tracestate value MAY contain double quotes in its payload. If so, they MUST be encoded according to XML rules, for example: ]]>

Error handling The NETCONF server SHOULD follow the "Processing Model for Working with Trace Context" as specified in . If the server rejects the RPC because of the trace context extension value, the server MUST return an rpc-error with the following values: Additionally, the error-info tag SHOULD contain a otlp-trace-context-error-info structure with relevant details about the error. This structure is defined in the module ietf-netconf-otlp-context.yang. Example of a badly formated trace context extension: ]]> This might give the following error response: protocol operation-failed error OTLP traceparent attribute incorrectly formatted w3ctc:traceparent Bad Format ietf-netconf-otlp-context:bad-format ]]>

Trace Context extension versionning This extension refers to the trace context capability. The W3C traceparent and trace-state headers include the notion of versions. It would be desirable for a NETCONF client to be able to discover the one or multiple versions of these headers supported by a server. We would like to achieve this goal avoiding the deffinition of new NETCONF capabilities for each headers' version. We define a pair YANG modules (ietf-netconf-otlp-context-traceparent-version-1.0.yang and ietf-netconf-otlp-context-tracestate-version-1.0.yang) that SHOULD be included in the YANG library per of the NETCONF server supporting the NETCONF Trace Context extension. These capabilities that will refer to the headers' supported versions. Future updates of this document could include additional YANG modules for new headers' versions.

YANG Modules

YANG module for otlp-trace-context-error-info structure WG List: "; description "When propagating tracing information across applications, client and servers needs to share some specific contextual information. This NETCONF extensions aligns the NETCONF protocol to the W3C trace-context document: https://www.w3.org/TR/2021/REC-trace-context-1-20211123 Copyright (c) IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices 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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2023-07-01 { description "Initial revision"; reference "RFC XXXX"; } identity meta-error { description "Base identity for otlp attribute errors."; } identity missing { base meta-error; description "Indicates an attribute or header that is required (in the current situation) is missing."; } identity bad-format { base meta-error; description "Indicates an attribute or header value where the value is incorrectly formatted."; } identity processing-error { base meta-error; description "Indicates that the server encountered a processing error while processing the attribute or header value."; } typedef meta-error-type { type identityref { base meta-error; } description "Error type"; } sx:structure otlp-trace-context-error-info { container otlp-trace-context-error-info { description "This error is returned by a NETCONF or RESTCONF server when a client sends a NETCONF RPC with additonal attributes or RESTCONF RPC with additional headers for trace context processing, and there is an error related to them. The server has aborted the RPC."; leaf meta-name { type string; description "The name of the problematic or missing meta information. In NETCONF, the qualified XML attribute name. In RESTCONF, the HTTP header name. If a client sent a NETCONF RPC with the attribute w3ctc:traceparent='incorrect-format' this leaf would have the value 'w3ctc:traceparent'"; } leaf meta-value { type string; description "The value of the problematic meta information received by the server. If a client sent a NETCONF RPC with the attribute w3ctc:traceparent='incorrect-format' this leaf would have the value 'incorrect-format'."; } leaf error-type { type meta-error-type; description "Indicates the type of OTLP meta information problem detected by the server. If a client sent an RPC annotated with the attribute w3ctc:traceparent='incorrect-format' this leaf might have the value 'ietf-netconf-otlp-context:bad-format'."; } } } } ]]>

YANG module for traceparent header version 1.0

YANG module for tracestate header version 1.0

Security Considerations TODO Security

IANA Considerations This document registers the following capability identifier URN in the 'Network Configuration Protocol (NETCONF) Capability URNs' registry: This document registers one XML namespace URN in the 'IETF XML registry', following the format defined in (https://tools.ietf.org/html/rfc3688). This document registers three module names in the 'YANG Module Names' registry, defined in RFC 6020: and and

Acknowledgments TBD

References Normative References 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 describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. This document describes a YANG library that provides information about the YANG modules, datastores, and datastore schemas used by a network management server. Simple caching mechanisms are provided to allow clients to minimize retrieval of this information. This version of the YANG library supports the Network Management Datastore Architecture (NMDA) by listing all datastores supported by a network management server and the schema that is used by each of these datastores. Informative References Cisco Systems NETCONF clients and servers often need to have a synchronized view of the server's configuration data stores. The volume of configuration data in a server may be very large, while data store changes typically are small when observed at typical client resynchronization intervals. Rereading the entire data store and analyzing the response for changes is an inefficient mechanism for synchronization. This document specifies an extension to NETCONF that allows clients and servers to keep synchronized with a much smaller data exchange and without any need for servers to store information about the clients. This document describes a mechanism that allows subscriber applications to request a continuous and customized stream of updates from a YANG datastore. Providing such visibility into updates enables new capabilities based on the remote mirroring and monitoring of configuration and operational state. The IETF has produced many modules in the YANG modeling language. The majority of these modules are used to construct data models to model devices or monolithic functions. A small number of YANG modules have been defined to model services (for example, the Layer 3 Virtual Private Network Service Model (L3SM) produced by the L3SM working group and documented in RFC 8049). This document describes service models as used within the IETF and also shows where a service model might fit into a software-defined networking architecture. Note that service models do not make any assumption of how a service is actually engineered and delivered for a customer; details of how network protocols and devices are engineered to deliver a service are captured in other modules that are not exposed through the interface between the customer and the provider.

Changes (to be deleted by RFC Editor)

From version 03 to draft-netconf-trace-ctx-extension-00-00

• Adopted by NETCONF WG
• Moved repository to NETCONF WG
• Changed build system to use martinthomson's excellent framework
• Ran make fix-lint to remove white space at EOL etc.
• Added this change note. No other content changes.

From version 02 to 03

• Changed IANA section to IESG per IANA email
• Created sx:structure and improved error example
• Added ietf-netconf-otlp-context.yang for the sx:structure
• Created a dedicated section for the YANG modules

From version 01 to 02

• Added Error Handling intial section
• Added how to manage versioning by defining YANG modules for each traceparent and trastate versions as defined by W3C.
• Added 'YANG Module Names' to IANA Considerations

From version 00 to 01

• Added new section: Implementation example 2: YANG DataStore
• 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 could be added as part of the tracing information to be exported to the collectors, showing how the two documents are complementary.

TO DO List (to be deleted by RFC Editor)

• Security Considerations
• The W3C is working on a draft document to introduce the concept of "baggage" that we expect part of a future draft for NETCONF and RESTCONF

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. We studied Pros/Cons of each option and decided to propose XML attributes: XML Attributes Pro:

• Literal alignment with W3C specification
• Same encoding for RESTCONF and NETCONF enabling code reuse
• One specification for all current and future rpcs

XML Attributes Cons:

• No YANG modeling, multiple values represented as a single string
• Dependency on W3C for any extension or changes in the future as encoding will be dictated by string encoding

RPCs Input Augmentations Pro:

• YANG model of every leaf
• Re-use of YANG toolkits
• Simple updates by augmentations on existing YANG module
• Possibility to express deviations in case of partial support

RPCs Input Augmentations Cons:

• Need to augment every rpc, including future rpcs would need to consider these augmentations, which is harder to maintain
• There is no literal alignment with W3C standard. However, as mentioned before most of the time there will be modifications to the content
• Would need updated RFP for each change at W3C, which will make adoption of new features slower