[netconf] Yangdoctors last call review of draft-ietf-netconf-trace-ctx-extension-02

Xufeng Liu via Datatracker <noreply@ietf.org> Sun, 10 November 2024 14:22 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: netconf@ietf.org
Delivered-To: netconf@ietfa.amsl.com
Received: from [10.244.8.181] (unknown [104.131.183.230]) by ietfa.amsl.com (Postfix) with ESMTP id 4E6FCC14F696; Sun, 10 Nov 2024 06:22:56 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Xufeng Liu via Datatracker <noreply@ietf.org>
To: yang-doctors@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 12.27.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <173124857583.554557.6355583747835693012@dt-datatracker-5f77bcf4bd-4q5pd>
Date: Sun, 10 Nov 2024 06:22:55 -0800
Message-ID-Hash: W6T5IBVQSVHWPK7XOKELG4JEQMGA3QDS
X-Message-ID-Hash: W6T5IBVQSVHWPK7XOKELG4JEQMGA3QDS
X-MailFrom: noreply@ietf.org
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-netconf.ietf.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: draft-ietf-netconf-trace-ctx-extension.all@ietf.org, last-call@ietf.org, netconf@ietf.org
X-Mailman-Version: 3.3.9rc6
Reply-To: Xufeng Liu <xufeng.liu.ietf@gmail.com>
Subject: [netconf] Yangdoctors last call review of draft-ietf-netconf-trace-ctx-extension-02
List-Id: NETCONF WG list <netconf.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/55RiabodGwfUM5_UP8S7N2dPOew>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netconf>
List-Help: <mailto:netconf-request@ietf.org?subject=help>
List-Owner: <mailto:netconf-owner@ietf.org>
List-Post: <mailto:netconf@ietf.org>
List-Subscribe: <mailto:netconf-join@ietf.org>
List-Unsubscribe: <mailto:netconf-leave@ietf.org>

Reviewer: Xufeng Liu
Review result: Ready with Issues

This is a review of the YANG modules in
draft-ietf-netconf-trace-ctx-extension-02.

1) Even though the module ietf-trace-context is simple, I still find a tree
diagram beneficial. Can you please consider including one such as the following?

module: ietf-trace-context

  structure trace-context-error-info:
    +-- trace-context-error-info
       +-- meta-name?    string
       +-- meta-value?   string
       +-- error-type?   meta-error-type

2) Sec 2.1. serves as a data instance example.  In the <error-info>,  there is
<ietf-trace-context:trace-context-error-info>, which happens to match either
the structure name or the container name. According to RFC 8791, both seem to
be parts of the data instance (as shown in Sec. A.5.). Is it intended to have
the duplicated structure and container?

3) Is it intended to have all leaves in trace-context-error-info optional with
no default values? What would an empty structure or container indicate?

4) Modules ietf-trace-ctx-traceparent-1.0 and ietf-trace-ctx-tracestate-1.0
seem to be used for capabilities only, without any YANG data nodes. It would be
good to have some explicit explanations in the description to say that this is
intentional (as I was expecting some content in the module initially).

5) It is not conventional to have the version number as a part of the module
name, as used by modules ietf-trace-ctx-traceparent-1.0 and
ietf-trace-ctx-tracestate-1.0 (Sec 4.1, 4.8 of RFC 8407).

6) It would be good to have an example YANG Library instance to show how
modules ietf-trace-ctx-traceparent-1.0 and ietf-trace-ctx-tracestate-1.0 are
used. Are they should be parts of config-modules or state-modules?

Thanks,
- Xufeng