-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-tgraf-yang-push-observation-time-00.txt
672 lines (474 loc) · 22.4 KB
/
draft-tgraf-yang-push-observation-time-00.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
Network Working Group T. Graf
Internet-Draft Swisscom
Intended status: Standards Track B. Claise
Expires: 9 August 2023 Huawei
A. Huang Feng
INSA-Lyon
5 February 2023
Support of Network Observation Timestamping in YANG Notifications
draft-tgraf-yang-push-observation-time-00
Abstract
This document extends the YANG Notification header to support besides
message export also network observation timestamping. In case of
"push-change-update" notifications to describe when the network state
change was observed. In case of "push-update" from when to when
measurements where accounted.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 9 August 2023.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
Graf, et al. Expires 9 August 2023 [Page 1]
Internet-Draft YANG Notifications Observation Time February 2023
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Extend the Streaming Update Notifications . . . . . . . . . . 2
3. The "ietf-yang-push-netobs-timestamping" YANG Module . . . . 4
3.1. Data Model Overview . . . . . . . . . . . . . . . . . . . 4
3.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8
4. Security Considerations . . . . . . . . . . . . . . . . . . . 10
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 10
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 10
7.1. Normative References . . . . . . . . . . . . . . . . . . 10
7.2. Informative References . . . . . . . . . . . . . . . . . 11
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11
1. Introduction
To correlate network data among different Network Telemetry planes as
described in Section 3.1 of [RFC9232] or among different YANG push
subscription types defined in Section 3.1 of [RFC8641], network
observation timestamping describing when the state change was
observed or from when to when the data was accounted is essential to
understand the timely relationship among these different planes and
YANG push subscription types.
With [I-D.tgraf-netconf-notif-sequencing] the delay between the YANG
Notification export and the arrival at the downstream system storing
the data can be measured. With network observation timestamping
described in this document, the delay between the network observation
and the data export of the YANG push publisher process can be
measured as well, extending the delay measurement scope from the time
the network observation and storing the data.
2. Extend the Streaming Update Notifications
Besides the Subscription ID as described in Section 3.7 of [RFC8641],
the following network observation time metadata objects are part of
"push-update" and "push-change-update" notifications.
Graf, et al. Expires 9 August 2023 [Page 2]
Internet-Draft YANG Notifications Observation Time February 2023
start-observation-time: Describes in the "push-update" notification
in a "periodical" subscription when the accounting has started.
By comparing the "start-observation-time" of two "push-update"
notifications, the the collector can deduce from when to when the
measurements where recorded.
changed-observation-time: Describes in the "push-change-update"
notification in a "on-change" subscription the time when the
network state change was observed after the subscription was
initially established. In case of an "on-change sync on start"
subscription it describes the time when the network state change
was observed before the subscription was established.
Figure 1 provides an example of a JSON encoded, [RFC8259], "push-
change-update" notification message over HTTPS-based
[I-D.ietf-netconf-https-notif] or UDP-based
[I-D.ietf-netconf-udp-notif] transport for the same subscription.
{
"ietf-notification:notification": {
"eventTime": "2023-02-04T16:30:11.22Z",
"sysName": "example-router",
"sequenceNumbe": 187653,
"ietf-yang-push:push-update": {
"id": 1011,
"observation-time": "2023-02-04T16:30:09.44Z",
"module": "ietf-interfaces",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-interfaces",
"revision": "2014-05-08",
"revision-label": "1.0.0",
"datastore-xpath-filter": "ietf-interfaces:interfaces",
"datastore-contents": {
"ietf-interfaces:interface": {
"name": {
"eth0": {
"oper-status": "up"
}
}
}
}
}
}
}
Figure 1: JSON Push Example for a subscription-modified
notification message
Graf, et al. Expires 9 August 2023 [Page 3]
Internet-Draft YANG Notifications Observation Time February 2023
3. The "ietf-yang-push-netobs-timestamping" YANG Module
This YANG module augments the "ietf-yang-push" module with the
observation-time in the "push-update" and "push-change-update"
streaming update notifications.
3.1. Data Model Overview
3.1.1. Tree View
The following is the YANG tree diagram [RFC8340] for the ietf-yang-
push-netobs-timestamping YANG module
module: ietf-yang-push-netobs-timestamping
augment /yp:push-update:
+--ro start-observation-time? yang:date-and-time
augment /yp:push-change-update:
+--ro changed-observation-time? yang:date-and-time
3.1.2. Full Tree View
The following is the YANG tree diagram [RFC8340] for the ietf-yang-
push-netobs-timestamping augmentation within the ietf-subscribed-
notifications, including the RPCs and notifications.
module: ietf-yang-push
augment /sn:establish-subscription/sn:input:
+---w (update-trigger)?
+--:(periodic)
| +---w periodic!
| +---w period centiseconds
| +---w anchor-time? yang:date-and-time
+--:(on-change) {on-change}?
+---w on-change!
+---w dampening-period? centiseconds
+---w sync-on-start? boolean
+---w excluded-change* change-type
augment /sn:establish-subscription/sn:input/sn:target:
+--:(datastore)
+-- datastore identityref
+-- (selection-filter)?
+--:(by-reference)
| +-- selection-filter-ref
| selection-filter-ref
+--:(within-subscription)
+-- (filter-spec)?
Graf, et al. Expires 9 August 2023 [Page 4]
Internet-Draft YANG Notifications Observation Time February 2023
+--:(datastore-subtree-filter)
| +-- datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+-- datastore-xpath-filter? yang:xpath1.0
{sn:xpath}?
augment /sn:modify-subscription/sn:input:
+---w (update-trigger)?
+--:(periodic)
| +---w periodic!
| +---w period centiseconds
| +---w anchor-time? yang:date-and-time
+--:(on-change) {on-change}?
+---w on-change!
+---w dampening-period? centiseconds
augment /sn:modify-subscription/sn:input/sn:target:
+--:(datastore)
+-- datastore identityref
+-- (selection-filter)?
+--:(by-reference)
| +-- selection-filter-ref
| selection-filter-ref
+--:(within-subscription)
+-- (filter-spec)?
+--:(datastore-subtree-filter)
| +-- datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+-- datastore-xpath-filter? yang:xpath1.0
{sn:xpath}?
augment /sn:subscription-started:
+--ro (update-trigger)?
+--:(periodic)
| +--ro periodic!
| +--ro period centiseconds
| +--ro anchor-time? yang:date-and-time
+--:(on-change) {on-change}?
+--ro on-change!
+--ro dampening-period? centiseconds
+--ro sync-on-start? boolean
+--ro excluded-change* change-type
augment /sn:subscription-started/sn:target:
+--:(datastore)
+-- datastore identityref
+-- (selection-filter)?
+--:(by-reference)
| +-- selection-filter-ref
| selection-filter-ref
Graf, et al. Expires 9 August 2023 [Page 5]
Internet-Draft YANG Notifications Observation Time February 2023
+--:(within-subscription)
+-- (filter-spec)?
+--:(datastore-subtree-filter)
| +-- datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+-- datastore-xpath-filter? yang:xpath1.0
{sn:xpath}?
augment /sn:subscription-modified:
+--ro (update-trigger)?
+--:(periodic)
| +--ro periodic!
| +--ro period centiseconds
| +--ro anchor-time? yang:date-and-time
+--:(on-change) {on-change}?
+--ro on-change!
+--ro dampening-period? centiseconds
+--ro sync-on-start? boolean
+--ro excluded-change* change-type
augment /sn:subscription-modified/sn:target:
+--:(datastore)
+-- datastore identityref
+-- (selection-filter)?
+--:(by-reference)
| +-- selection-filter-ref
| selection-filter-ref
+--:(within-subscription)
+-- (filter-spec)?
+--:(datastore-subtree-filter)
| +-- datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+-- datastore-xpath-filter? yang:xpath1.0
{sn:xpath}?
augment /sn:filters:
+--rw selection-filter* [filter-id]
+--rw filter-id string
+--rw (filter-spec)?
+--:(datastore-subtree-filter)
| +--rw datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+--rw datastore-xpath-filter? yang:xpath1.0
{sn:xpath}?
augment /sn:subscriptions/sn:subscription:
+--rw (update-trigger)?
+--:(periodic)
| +--rw periodic!
Graf, et al. Expires 9 August 2023 [Page 6]
Internet-Draft YANG Notifications Observation Time February 2023
| +--rw period centiseconds
| +--rw anchor-time? yang:date-and-time
+--:(on-change) {on-change}?
+--rw on-change!
+--rw dampening-period? centiseconds
+--rw sync-on-start? boolean
+--rw excluded-change* change-type
augment /sn:subscriptions/sn:subscription/sn:target:
+--:(datastore)
+--rw datastore identityref
+--rw (selection-filter)?
+--:(by-reference)
| +--rw selection-filter-ref
| selection-filter-ref
+--:(within-subscription)
+--rw (filter-spec)?
+--:(datastore-subtree-filter)
| +--rw datastore-subtree-filter? <anydata>
| {sn:subtree}?
+--:(datastore-xpath-filter)
+--rw datastore-xpath-filter?
yang:xpath1.0 {sn:xpath}?
rpcs:
+---x resync-subscription {on-change}?
+---w input
+---w id sn:subscription-id
notifications:
+---n push-update
| +--ro id? sn:subscription-id
| +--ro datastore-contents? <anydata>
| +--ro incomplete-update? empty
| +--ro ypnt:start-observation-time? yang:date-and-time
+---n push-change-update {on-change}?
+--ro id? sn:subscription-id
+--ro datastore-changes
| +--ro yang-patch
| +--ro patch-id string
| +--ro comment? string
| +--ro edit* [edit-id]
| +--ro edit-id string
| +--ro operation enumeration
| +--ro target target-resource-offset
| +--ro point? target-resource-offset
| +--ro where? enumeration
| +--ro value? <anydata>
+--ro incomplete-update? empty
Graf, et al. Expires 9 August 2023 [Page 7]
Internet-Draft YANG Notifications Observation Time February 2023
+--ro ypnt:changed-observation-time? yang:date-and-time
3.2. YANG Module
The YANG module has one leave augmenting the model of Subscription to
YANG Notifications [RFC8639].
<CODE BEGINS>
file "[email protected]"
module ietf-yang-push-netobs-timestamping {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-yang-push-netobs-timestamping";
prefix ypnt;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-yang-push {
prefix yp;
reference
"RFC 8641: Subscription to YANG Notifications for Datastore Updates";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Thomas Graf
<mailto:[email protected]>
Benoit Claise
<mailto:[email protected]>
Alex Huang Feng
<mailto:[email protected]>";
description
"Defines YANG push event notification header with the observation
time in push-update and push-change-update notifications.
Copyright (c) 2023 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).
Graf, et al. Expires 9 August 2023 [Page 8]
Internet-Draft YANG Notifications Observation Time February 2023
This version of this YANG module is part of RFC XXXX; see the RFC
itself for full legal notices.";
revision 2023-02-14 {
description
"First revision";
reference
"RFC XXXX: Support of YANG Notifications Observation Time";
}
feature yang-push-change-update-obs-timestamp {
description
"This feature indicates the YANG-push Notifications support
the observation timestamps in the push-change-update notifications.";
}
feature yang-push-update-obs-timestamp {
description
"This feature indicates the YANG-push Notifications support
the observation timestamps in the push-update notifications.";
}
grouping yang-push-update-obs-timestamp {
description
"This grouping adds the start timestamp and the end timestamp of the
observed metrics.";
leaf start-observation-time {
type yang:date-and-time;
description
"This is the time when metrics started counting.";
}
}
grouping yang-push-change-update-obs-timestamp {
description
"This grouping adds the timestamp of the recorded event.";
leaf changed-observation-time {
type yang:date-and-time;
description
"This is the time when event happened.";
}
}
// Event notifications
augment "/yp:push-update" {
description
"This augmentation adds the start timestamp of the counted metrics
in the push-update notification.";
Graf, et al. Expires 9 August 2023 [Page 9]
Internet-Draft YANG Notifications Observation Time February 2023
uses ypnt:yang-push-update-obs-timestamp;
}
augment "/yp:push-change-update" {
description
"This augmentation adds the timestamp of the event in the push-change-update
notification.";
uses ypnt:yang-push-change-update-obs-timestamp;
}
}
<CODE ENDS>
4. Security Considerations
The security considerations for the YANG notifications subscription
mechanism are described in [RFC8641]. This document adds no
additional security considerations.
5. IANA Considerations
TBD: ask the YANG Module name to IANA
TBD: ask a new XML namespace for the xml Schema
6. Acknowledgements
The authors would like to thank xxx for their review and valuable
comments.
7. References
7.1. Normative References
[I-D.tgraf-netconf-notif-sequencing]
Graf, T., Quilbeuf, J., and A. Huang Feng, "Support of
Hostname and Sequencing in YANG Notifications", Work in
Progress, Internet-Draft, draft-tgraf-netconf-notif-
sequencing-00, February 2023,
<https://datatracker.ietf.org/doc/html/draft-tgraf-
netconf-notif-sequencing-00>.
[RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard,
E., and A. Tripathy, "Subscription to YANG Notifications",
RFC 8639, DOI 10.17487/RFC8639, September 2019,
<https://www.rfc-editor.org/info/rfc8639>.
Graf, et al. Expires 9 August 2023 [Page 10]
Internet-Draft YANG Notifications Observation Time February 2023
[RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications
for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641,
September 2019, <https://www.rfc-editor.org/info/rfc8641>.
7.2. Informative References
[I-D.ietf-netconf-https-notif]
Jethanandani, M. and K. Watsen, "An HTTPS-based Transport
for YANG Notifications", Work in Progress, Internet-Draft,
draft-ietf-netconf-https-notif-13, 4 November 2022,
<https://www.ietf.org/archive/id/draft-ietf-netconf-https-
notif-13.txt>.
[I-D.ietf-netconf-udp-notif]
Zheng, G., Zhou, T., Graf, T., Francois, P., Feng, A. H.,
and P. Lucente, "UDP-based Transport for Configured
Subscriptions", Work in Progress, Internet-Draft, draft-
ietf-netconf-udp-notif-08, 12 September 2022,
<https://www.ietf.org/archive/id/draft-ietf-netconf-udp-
notif-08.txt>.
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC9232] Song, H., Qin, F., Martinez-Julia, P., Ciavaglia, L., and
A. Wang, "Network Telemetry Framework", RFC 9232,
DOI 10.17487/RFC9232, May 2022,
<https://www.rfc-editor.org/info/rfc9232>.
Authors' Addresses
Thomas Graf
Swisscom
Binzring 17
CH-8045 Zurich
Switzerland
Email: [email protected]
Benoit Claise
Huawei
Email: [email protected]
Graf, et al. Expires 9 August 2023 [Page 11]
Internet-Draft YANG Notifications Observation Time February 2023
Alex Huang Feng
INSA-Lyon
Lyon
France
Email: [email protected]
Graf, et al. Expires 9 August 2023 [Page 12]