-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-netana-nmop-network-anomaly-semantics-03.xml
1070 lines (819 loc) · 35.4 KB
/
draft-netana-nmop-network-anomaly-semantics-03.xml
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
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="2"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="exp" docName="draft-netana-nmop-network-anomaly-semantics-03"
ipr="trust200902">
<front>
<title abbrev="Network Anomaly Semantics">Semantic Metadata Annotation for
Network Anomaly Detection</title>
<author fullname="Thomas Graf" initials="T" surname="Graf">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zurich</city>
<code>8045</code>
<country>Switzerland</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Wanting Du" initials="W" surname="Du">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zurich</city>
<code>8045</code>
<country>Switzerland</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Alex Huang Feng" initials="A." surname="Huang Feng">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Vincenzo Riccobene" initials="V." surname="Riccobene">
<organization>Huawei</organization>
<address>
<postal>
<street/>
<city>Dublin</city>
<region/>
<code/>
<country>Ireland</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Antonio Roberto" initials="A." surname="Roberto">
<organization>Huawei</organization>
<address>
<postal>
<street/>
<city>Dublin</city>
<region/>
<code/>
<country>Ireland</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<date day="06" month="September" year="2024"/>
<area>Operations and Management</area>
<workgroup>NMOP</workgroup>
<abstract>
<t>This document explains why and how semantic metadata annotation helps
to test, validate and compare Outlier and Symptom detection, supports
supervised and semi-supervised machine learning development, enables data
exchange among network operators, vendors and academia and make anomalies
for humans apprehensible. The proposed semantics uniforms the network
anomaly data exchange between and among operators and vendors to improve
their Service Disruption Detection Systems.</t>
</abstract>
<note removeInRFC="true">
<name>Discussion Venues</name>
<t>Discussion of this document takes place on the Operations and
Management Area Working Group Working Group mailing list
([email protected]), which is archived at <eref
target="https://mailarchive.ietf.org/arch/browse/nmop/"/>.</t>
<t>Source for this draft and an issue tracker can be found at <eref
target="https://github.com/network-analytics/draft-netana-nmop-network-anomaly-semantics/"/>.</t>
</note>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t><xref target="I-D.netana-nmop-network-anomaly-architecture"/>
provides an overall introduction into how anomaly detection is being
applied into the IP network domain and which operational data is needed.
It approaches the problem space by automating what a Network Engineer
would normally do when verifying a network connectivity service. Monitor
from different network plane perspectives to understand wherever one
network plane affects another negatively.</t>
<t>In order to fine tune Service Disruption Detection as described in <xref
target="I-D.netana-nmop-network-anomaly-lifecycle"/>, the results
provided as analytical data need to be reviewed by a Network Engineer.
Keeping the human out of the monitoring but still involving him in the
alarm verification loop.</t>
<t>This document describes what information is needed to understand the
output of the Service Disruption Detection for a Network Engineer, but also
at the same time is semantically structured that it can be used for Service
Disruption Detection System testing by comparing the results systematically
and set a baseline for supervised machine learning which requires labeled
operational data.</t>
</section>
<section anchor="Conventions_and_Definitions"
title="Conventions and Definitions">
<t>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
<xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when,
they appear in all capitals, as shown here.</t>
<section anchor="Terminology" title="Terminology">
<t>This document makes use of the terms defined in <xref
target="I-D.netana-nmop-network-anomaly-architecture"/> and <xref
target="I-D.ietf-nmop-terminology"/>.</t>
<t>The following terms are used as defined in <xref
target="I-D.netana-nmop-network-anomaly-architecture"/>:</t>
<t><list style="symbols">
<t>Outlier Detection</t>
<t>Service Disruption Detection</t>
<t>Service Disruption Detection System</t>
</list></t>
<t>The following terms are used as defined in <xref
target="I-D.ietf-nmop-terminology"/>:</t>
<t><list style="symbols">
<t>System</t>
<t>Detect</t>
<t>Event</t>
<t>State</t>
<t>Relevance</t>
<t>Problem</t>
<t>Symptom</t>
<t>Cause</t>
<t>Alarm</t>
</list></t>
</section>
</section>
<section anchor="Observed_Symptoms" title="Observed Symptoms">
<t>In this section observed network Symptoms are specified and
categorized according to the following scheme:</t>
<dl>
<dt>Action:</dt>
<dd>
<t>Which action the network node performed for a packet in the
Forwarding Plane, a path or adjacency in the Control Plane or state
or statistical changes in the Management Plane. For Forwarding Plane
we distinguish between missing, where the drop occurred outside the
measured network node, drop and on-path delay, which was measured on
the network node. For Control Plane we distinguish between
reachability, which refers to a change in the routing or forwarding
information base (RIB/FIB) and adjacency which refers to a change in
peering or link-layer resolution. For Management Plane we refer to
state or statistical changes on interfaces.</t>
</dd>
</dl>
<dl>
<dt>Reason:</dt>
<dd>
<t>For each action, one or more reasons describe why this action was
used. For Drops in Forwarding Plane we distinguish between
Unreachable because network layer reachability information was
missing, Administered because an administrator configured a rule
preventing the forwarding for this packet and Corrupt where the
network node was unable to determine where to forward to due to
packet, software or hardware error. For on-path delay we distinguish
between Minimum, Average and Maximum Delay for a given flow. For
Control Plane wherever a the reachability was updated or withdrawn
or the adjacency was established or teared down. For Management
Plane we distinguish between interfaces states up and down, and
statistical errors, discards or unknown protocol counters.</t>
</dd>
</dl>
<dl>
<dt>Cause:</dt>
<dd>
<t>For each reason one or more cause describe the cause why the
network node has chosen that action.</t>
</dd>
</dl>
<t><xref target="symptom_forwarding_plane_actions_table"/> consolidates
for the forwarding plane a list of common Symptoms with their Actions,
Reasons and Causes.</t>
<table align="center" anchor="symptom_forwarding_plane_actions_table">
<name slugifiedName="symptom_forwarding_plane_actions">Describing
Symptoms and their Actions, Reason and Cause for Forwarding
Plane</name>
<thead>
<tr>
<th align="left" colspan="1" rowspan="1">Action</th>
<th align="left" colspan="1" rowspan="1">Reason</th>
<th align="left" colspan="1" rowspan="1">Cause</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" colspan="1" rowspan="1">Missing</td>
<td align="left" colspan="1" rowspan="1">Previous</td>
<td align="left" colspan="1" rowspan="1">Time</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Unreachable</td>
<td align="left" colspan="1" rowspan="1">next-hop</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Unreachable</td>
<td align="left" colspan="1" rowspan="1">link-layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Unreachable</td>
<td align="left" colspan="1" rowspan="1">Time To Life expired</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Unreachable</td>
<td align="left" colspan="1" rowspan="1">Fragmentation needed and
Don't Fragment set</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Administered</td>
<td align="left" colspan="1" rowspan="1">Access-List</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Administered</td>
<td align="left" colspan="1" rowspan="1">Unicast Reverse Path
Forwarding</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Administered</td>
<td align="left" colspan="1" rowspan="1">Discard Route</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Administered</td>
<td align="left" colspan="1" rowspan="1">Policed</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Administered</td>
<td align="left" colspan="1" rowspan="1">Shaped</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Corrupt</td>
<td align="left" colspan="1" rowspan="1">Bad Packet</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Drop</td>
<td align="left" colspan="1" rowspan="1">Corrupt</td>
<td align="left" colspan="1" rowspan="1">Bad Egress Interface</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Delay</td>
<td align="left" colspan="1" rowspan="1">Min</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Delay</td>
<td align="left" colspan="1" rowspan="1">Mean</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Delay</td>
<td align="left" colspan="1" rowspan="1">Max</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
</tbody>
</table>
<t><xref target="symptom_control_plane_actions_table"/> consolidates for
the control plane a list of common symptoms with their actions, reasons
and causes.</t>
<table align="center" anchor="symptom_control_plane_actions_table">
<name slugifiedName="symptom_control_plane_actions">Describing
Symptoms and their Actions, Reason and Cause for Control Plane</name>
<thead>
<tr>
<th align="left" colspan="1" rowspan="1">Action</th>
<th align="left" colspan="1" rowspan="1">Reason</th>
<th align="left" colspan="1" rowspan="1">Cause</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Update</td>
<td align="left" colspan="1" rowspan="1">Imported</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Update</td>
<td align="left" colspan="1" rowspan="1">Received</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Received</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Peer Down</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Suppressed</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Stale</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Route Policy
Filtered</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Reachability</td>
<td align="left" colspan="1" rowspan="1">Withdraw</td>
<td align="left" colspan="1" rowspan="1">Maximum Number of
Prefixes Reached</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Established</td>
<td align="left" colspan="1" rowspan="1">Peer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Established</td>
<td align="left" colspan="1" rowspan="1">Link-Layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Locally Teared Down</td>
<td align="left" colspan="1" rowspan="1">Peer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Remotely Teared Down</td>
<td align="left" colspan="1" rowspan="1">Peer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Locally Teared Down</td>
<td align="left" colspan="1" rowspan="1">Link-Layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Remotely Teared Down</td>
<td align="left" colspan="1" rowspan="1">Link-Layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Locally Teared Down</td>
<td align="left" colspan="1" rowspan="1">Administrative</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Remotely Teared Down</td>
<td align="left" colspan="1" rowspan="1">Administrative</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Locally Teared Down</td>
<td align="left" colspan="1" rowspan="1">Maximum Number of
Prefixes Reached</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Remotely Teared Down</td>
<td align="left" colspan="1" rowspan="1">Maximum Number of
Prefixes Reached</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Locally Teared Down</td>
<td align="left" colspan="1" rowspan="1">Transport Connection
Failed</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Adjacency</td>
<td align="left" colspan="1" rowspan="1">Remotely Teared Down</td>
<td align="left" colspan="1" rowspan="1">Transport Connection
Failed</td>
</tr>
</tbody>
</table>
<t><xref target="symptom_management_plane_actions_table"/> consolidates
for the management plane a list of common Symptoms with their Actions,
Reasons and Causes.</t>
<table align="center" anchor="symptom_management_plane_actions_table">
<name slugifiedName="symptom_management_plane_actions">Describing
Symptoms and their Actions, Reason and Cause for Management
Plane</name>
<thead>
<tr>
<th align="left" colspan="1" rowspan="1">Action</th>
<th align="left" colspan="1" rowspan="1">Reason</th>
<th align="left" colspan="1" rowspan="1">Cause</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" colspan="1" rowspan="1">Interface</td>
<td align="left" colspan="1" rowspan="1">Up</td>
<td align="left" colspan="1" rowspan="1">Link-Layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Interface</td>
<td align="left" colspan="1" rowspan="1">Down</td>
<td align="left" colspan="1" rowspan="1">Link-Layer</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Interface</td>
<td align="left" colspan="1" rowspan="1">Errors</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Interface</td>
<td align="left" colspan="1" rowspan="1">Discards</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
<tr>
<td align="left" colspan="1" rowspan="1">Interface</td>
<td align="left" colspan="1" rowspan="1">Unknown Protocol</td>
<td align="left" colspan="1" rowspan="1">-</td>
</tr>
</tbody>
</table>
</section>
<section anchor="Semantic_Metadata" title="Semantic Metadata">
<t>Metadata adds additional context to data. For instance, in networks
the software version of a network node where Management Plane metrics
are obtained from as described in<xref
target="I-D.claise-opsawg-collected-data-manifest"/>. Where in Semantic
Metadata the meaning or ontology of the annotated data is being
described. In this section a YANG model is defined in order to provide a
structure for the metadata related to anomalies happening in the
network. The module is intended to describe the metadata used to
"annotate" the operational data collected from the network nodes, which
can include time series data and logs, as well as other forms of data
that is "time-bounded". The aspects discussed so far in this document
are grouped under the concept of "anomaly" which represents a collection
of Symptoms. The anomaly overall has a set of parameters that describe
the overall behavior of the network in a given time-window including all
the observed Symptoms and Outliers.</t>
<section anchor="symptom-model-tree"
title="Overview of the Model for the Symptom Semantic Metadata">
<t><xref target="ietf-network-anomaly-symptom-tree"/> contains the YANG
tree diagram <xref target="RFC8340"/> of the <xref
target="ietf-relevant-state-tree"/> which augments the <xref target="I-D.netana-nmop-network-anomaly-lifecycle"/> defined
ietf-relevant-state.</t>
<t>For each Symptom, the following parameters have been assigned: Action,
Reason and Cause to describe the Symptom, a concern score indicating how
critical the Symptom is and with Forwarding, Control and Management to
which network plane the Symptom can be attributed to.</t>
<t><figure anchor="ietf-network-anomaly-symptom-tree"
title="YANG tree diagram for ietf-network-anomaly-symptom-cbl">
<artwork><![CDATA[
module: ietf-network-anomaly-symptom-cbl
augment /rsn:relevant-state/rsn:anomalies/rsn:symptom:
+--rw action? string
+--rw reason? string
+--rw cause? string
+--rw (plane)?
+--:(forwarding)
| +--rw forwarding? empty
+--:(control)
| +--rw control? empty
+--:(management)
+--rw management? empty
augment /rsn:relevant-state-notification/rsn:anomalies/rsn:symptom:
+-- action? string
+-- reason? string
+-- cause? string
+-- (plane)?
+--:(forwarding)
| +-- forwarding? empty
+--:(control)
| +-- control? empty
+--:(management)
+-- management? empty
]]></artwork>
</figure></t>
<t>The module augments the anomaly-grouping of the relevant-state
container and the relevant-state-notification notification of
ietf-relevant-state. The relevant-state container is used for modifying
the Symptom data in the Postmortem system. Where the
relevant-state-notification notification is used for messaging from the
Alarm Aggregation to the Postmortem and the Alarm and Problem
Management system.</t>
<t><figure anchor="ietf-relevant-state-tree"
title="YANG tree diagram for ietf-relevant-state">
<artwork><![CDATA[
module: ietf-relevant-state
+--rw relevant-state
+--rw id yang:uuid
+--rw description? string
+--rw start-time yang:date-and-time
+--rw end-time? yang:date-and-time
+--rw anomalies* [id version]
+--rw id yang:uuid
+--rw version yang:counter32
+--rw state identityref
+--rw description? string
+--rw start-time yang:date-and-time
+--rw end-time? yang:date-and-time
+--rw confidence-score score
+--rw (pattern)?
| +--:(drop)
| | +--rw drop? empty
| +--:(spike)
| | +--rw spike? empty
| +--:(mean-shift)
| | +--rw mean-shift? empty
| +--:(seasonality-shift)
| | +--rw seasonality-shift? empty
| +--:(trend)
| | +--rw trend? empty
| +--:(other)
| +--rw other? string
+--rw annotator!
| +--rw name string
| +--rw (annotator-type)?
| +--:(human)
| | +--rw human? empty
| +--:(algorithm)
| +--rw algorithm? empty
+--rw symptom!
| +--rw id yang:uuid
| +--rw concern-score score
| +--rw smcblsymptom:action? string
| +--rw smcblsymptom:reason? string
| +--rw smcblsymptom:cause? string
| +--rw (smcblsymptom:plane)?
| +--:(smcblsymptom:forwarding)
| | +--rw smcblsymptom:forwarding? empty
| +--:(smcblsymptom:control)
| | +--rw smcblsymptom:control? empty
| +--:(smcblsymptom:management)
| +--rw smcblsymptom:management? empty
+--rw service!
+--rw id
| yang:uuid
+--rw smtopology:vpn-service-container
| +--rw smtopology:vpn-service* [vpn-id]
| +--rw smtopology:vpn-id string
| +--rw smtopology:vpn-name? string
| +--rw smtopology:site-ids* string
+--rw smtopology:vpn-node-termination-container
+--rw smtopology:vpn-node-termination*
[hostname route-distinguisher]
+--rw smtopology:hostname inet:host
+--rw smtopology:route-distinguisher string
+--rw smtopology:peer-ip*
| inet:ip-address
+--rw smtopology:next-hop*
| inet:ip-address
+--rw smtopology:interface-id* int32
notifications:
+---n relevant-state-notification
+--ro id yang:uuid
+--ro description? string
+--ro start-time yang:date-and-time
+--ro end-time? yang:date-and-time
+--ro anomalies* [id version]
+--ro id yang:uuid
+--ro version yang:counter32
+--ro state identityref
+--ro description? string
+--ro start-time yang:date-and-time
+--ro end-time? yang:date-and-time
+--ro confidence-score score
+--ro (pattern)?
| +--:(drop)
| | +--ro drop? empty
| +--:(spike)
| | +--ro spike? empty
| +--:(mean-shift)
| | +--ro mean-shift? empty
| +--:(seasonality-shift)
| | +--ro seasonality-shift? empty
| +--:(trend)
| | +--ro trend? empty
| +--:(other)
| +--ro other? string
+--ro annotator!
| +--ro name string
| +--ro (annotator-type)?
| +--:(human)
| | +--ro human? empty
| +--:(algorithm)
| +--ro algorithm? empty
+--ro symptom!
| +--ro id yang:uuid
| +--ro concern-score score
| +--ro smcblsymptom:action? string
| +--ro smcblsymptom:reason? string
| +--ro smcblsymptom:cause? string
| +--ro (smcblsymptom:plane)?
| +--:(smcblsymptom:forwarding)
| | +--ro smcblsymptom:forwarding? empty
| +--:(smcblsymptom:control)
| | +--ro smcblsymptom:control? empty
| +--:(smcblsymptom:management)
| +--ro smcblsymptom:management? empty
+--ro service!
+--ro id
| yang:uuid
+--ro smtopology:vpn-service-container
| +--ro smtopology:vpn-service* [vpn-id]
| +--ro smtopology:vpn-id string
| +--ro smtopology:vpn-name? string
| +--ro smtopology:site-ids* string
+--ro smtopology:vpn-node-termination-container
+--ro smtopology:vpn-node-termination*
[hostname route-distinguisher]
+--ro smtopology:hostname inet:host
+--ro smtopology:route-distinguisher string
+--ro smtopology:peer-ip*
| inet:ip-address
+--ro smtopology:next-hop*
| inet:ip-address
+--ro smtopology:interface-id* int32
]]></artwork>
</figure></t>
</section>
<section anchor="YANG-Symptom-Module" title="YANG Module">
<t>The YANG module has one typdef defining the score and a grouping
defining Action, Reason and Cause and how it attributes to the
network planes.</t>
<t><figure anchor="ietf-symptom-semantic-metadata-module"
title="ietf-symptom-semantic-metadata YANG Module">
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-network-anomaly-symptom-cbl {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-network-anomaly-symptom-cbl";
prefix smcblsymptom;
import ietf-relevant-state {
prefix rsn;
reference
"RFC XXX: Relevant State and Relevant State Notification";
}
organization "IETF NMOP (Network Management Operations) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Thomas Graf
<mailto:[email protected]>
Wanting Du
<mailto:[email protected]>
Alex Huang Feng
<mailto:[email protected]>
Vincenzo Riccobene
<mailto:[email protected]>
Antonio Roberto
<mailto:[email protected]>";
description
"This module defines the semantic grouping to be used by a
Service Disruption Detection Systems. The defined objects is
used to augment the anomaly container. Describing the
symptoms action, reason and and oncern-score.
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).
This version of this YANG module is part of RFC XXXX; see the RFC
itself for full legal notices.";
revision 2024-10-18 {
description
"Initial version";
reference
"RFC XXX: Semantic Metadata Annotation for Network Anomaly Detection";
}
typedef score {
type uint8 {
range "0 .. 100";
}
}
grouping cbl-symptom {
leaf action {
type string;
description "action";
}
leaf reason {
type string;
description
"reason";
}
leaf cause {
type string;
description
"cause";
}
choice plane {
description
"Network Plane affected by the symptom";
case forwarding {
leaf forwarding {
type empty;
}
}
case control {
leaf control {
type empty;
}
}
case management {
leaf management {
type empty;
}
}
}
}
augment /rsn:relevant-state/rsn:anomalies/rsn:symptom {
uses cbl-symptom;
}
augment /rsn:relevant-state-notification/rsn:anomalies/rsn:symptom {
uses cbl-symptom;
}
}
<CODE ENDS>]]></artwork>
</figure></t>
</section>
</section>
<section anchor="Security" title="Security Considerations">
<t>The security considerations.</t>