-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-netana-nmop-network-anomaly-semantics-03.txt
896 lines (664 loc) · 34.3 KB
/
draft-netana-nmop-network-anomaly-semantics-03.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
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
NMOP T. Graf
Internet-Draft W. Du
Intended status: Experimental Swisscom
Expires: 10 March 2025 A. Huang Feng
INSA-Lyon
V. Riccobene
A. Roberto
Huawei
6 September 2024
Semantic Metadata Annotation for Network Anomaly Detection
draft-netana-nmop-network-anomaly-semantics-03
Abstract
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.
Discussion Venues
This note is to be removed before publishing as an RFC.
Discussion of this document takes place on the Operations and
Management Area Working Group Working Group mailing list
([email protected]), which is archived at
https://mailarchive.ietf.org/arch/browse/nmop/.
Source for this draft and an issue tracker can be found at
https://github.com/network-analytics/draft-netana-nmop-network-
anomaly-semantics/.
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/.
Graf, et al. Expires 10 March 2025 [Page 1]
Internet-Draft Network Anomaly Semantics September 2024
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 10 March 2025.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
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. Conventions and Definitions . . . . . . . . . . . . . . . . . 3
2.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
3. Observed Symptoms . . . . . . . . . . . . . . . . . . . . . . 4
4. Semantic Metadata . . . . . . . . . . . . . . . . . . . . . . 7
4.1. Overview of the Model for the Symptom Semantic
Metadata . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 11
5. Security Considerations . . . . . . . . . . . . . . . . . . . 14
6. Implementation status . . . . . . . . . . . . . . . . . . . . 14
6.1. Antagonist . . . . . . . . . . . . . . . . . . . . . . . 14
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 14
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 14
8.1. Normative References . . . . . . . . . . . . . . . . . . 14
8.2. Informative References . . . . . . . . . . . . . . . . . 15
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15
1. Introduction
[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
Graf, et al. Expires 10 March 2025 [Page 2]
Internet-Draft Network Anomaly Semantics September 2024
network plane affects another negatively.
In order to fine tune Service Disruption Detection as described in
[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.
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.
2. Conventions and Definitions
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 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
2.1. Terminology
This document makes use of the terms defined in
[I-D.netana-nmop-network-anomaly-architecture] and
[I-D.ietf-nmop-terminology].
The following terms are used as defined in
[I-D.netana-nmop-network-anomaly-architecture]:
* Outlier Detection
* Service Disruption Detection
* Service Disruption Detection System
The following terms are used as defined in
[I-D.ietf-nmop-terminology]:
* System
* Detect
* Event
* State
Graf, et al. Expires 10 March 2025 [Page 3]
Internet-Draft Network Anomaly Semantics September 2024
* Relevance
* Problem
* Symptom
* Cause
* Alarm
3. Observed Symptoms
In this section observed network Symptoms are specified and
categorized according to the following scheme:
Action: 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.
Reason: 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.
Cause: For each reason one or more cause describe the cause why the
network node has chosen that action.
Table 1 consolidates for the forwarding plane a list of common
Symptoms with their Actions, Reasons and Causes.
Graf, et al. Expires 10 March 2025 [Page 4]
Internet-Draft Network Anomaly Semantics September 2024
+=========+==============+========================+
| Action | Reason | Cause |
+=========+==============+========================+
| Missing | Previous | Time |
+---------+--------------+------------------------+
| Drop | Unreachable | next-hop |
+---------+--------------+------------------------+
| Drop | Unreachable | link-layer |
+---------+--------------+------------------------+
| Drop | Unreachable | Time To Life expired |
+---------+--------------+------------------------+
| Drop | Unreachable | Fragmentation needed |
| | | and Don't Fragment set |
+---------+--------------+------------------------+
| Drop | Administered | Access-List |
+---------+--------------+------------------------+
| Drop | Administered | Unicast Reverse Path |
| | | Forwarding |
+---------+--------------+------------------------+
| Drop | Administered | Discard Route |
+---------+--------------+------------------------+
| Drop | Administered | Policed |
+---------+--------------+------------------------+
| Drop | Administered | Shaped |
+---------+--------------+------------------------+
| Drop | Corrupt | Bad Packet |
+---------+--------------+------------------------+
| Drop | Corrupt | Bad Egress Interface |
+---------+--------------+------------------------+
| Delay | Min | - |
+---------+--------------+------------------------+
| Delay | Mean | - |
+---------+--------------+------------------------+
| Delay | Max | - |
+---------+--------------+------------------------+
Table 1: Describing Symptoms and their Actions,
Reason and Cause for Forwarding Plane
Table 2 consolidates for the control plane a list of common symptoms
with their actions, reasons and causes.
+==============+=============+====================================+
| Action | Reason | Cause |
+==============+=============+====================================+
| Reachability | Update | Imported |
+--------------+-------------+------------------------------------+
| Reachability | Update | Received |
Graf, et al. Expires 10 March 2025 [Page 5]
Internet-Draft Network Anomaly Semantics September 2024
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Received |
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Peer Down |
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Suppressed |
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Stale |
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Route Policy Filtered |
+--------------+-------------+------------------------------------+
| Reachability | Withdraw | Maximum Number of Prefixes Reached |
+--------------+-------------+------------------------------------+
| Adjacency | Established | Peer |
+--------------+-------------+------------------------------------+
| Adjacency | Established | Link-Layer |
+--------------+-------------+------------------------------------+
| Adjacency | Locally | Peer |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Remotely | Peer |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Locally | Link-Layer |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Remotely | Link-Layer |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Locally | Administrative |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Remotely | Administrative |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Locally | Maximum Number of Prefixes Reached |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Remotely | Maximum Number of Prefixes Reached |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Locally | Transport Connection Failed |
| | Teared Down | |
+--------------+-------------+------------------------------------+
| Adjacency | Remotely | Transport Connection Failed |
| | Teared Down | |
+--------------+-------------+------------------------------------+
Graf, et al. Expires 10 March 2025 [Page 6]
Internet-Draft Network Anomaly Semantics September 2024
Table 2: Describing Symptoms and their Actions, Reason and
Cause for Control Plane
Table 3 consolidates for the management plane a list of common
Symptoms with their Actions, Reasons and Causes.
+===========+==================+============+
| Action | Reason | Cause |
+===========+==================+============+
| Interface | Up | Link-Layer |
+-----------+------------------+------------+
| Interface | Down | Link-Layer |
+-----------+------------------+------------+
| Interface | Errors | - |
+-----------+------------------+------------+
| Interface | Discards | - |
+-----------+------------------+------------+
| Interface | Unknown Protocol | - |
+-----------+------------------+------------+
Table 3: Describing Symptoms and their
Actions, Reason and Cause for Management
Plane
4. Semantic Metadata
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[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.
4.1. Overview of the Model for the Symptom Semantic Metadata
Figure 1 contains the YANG tree diagram [RFC8340] of the Figure 2
which augments the [I-D.netana-nmop-network-anomaly-lifecycle]
defined ietf-relevant-state.
Graf, et al. Expires 10 March 2025 [Page 7]
Internet-Draft Network Anomaly Semantics September 2024
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.
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
Figure 1: YANG tree diagram for ietf-network-anomaly-symptom-cbl
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.
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]
Graf, et al. Expires 10 March 2025 [Page 8]
Internet-Draft Network Anomaly Semantics September 2024
+--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
Graf, et al. Expires 10 March 2025 [Page 9]
Internet-Draft Network Anomaly Semantics September 2024
+--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
Graf, et al. Expires 10 March 2025 [Page 10]
Internet-Draft Network Anomaly Semantics September 2024
| +--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
Figure 2: YANG tree diagram for ietf-relevant-state
4.2. YANG Module
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.
<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";
}
Graf, et al. Expires 10 March 2025 [Page 11]
Internet-Draft Network Anomaly Semantics September 2024
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 {
Graf, et al. Expires 10 March 2025 [Page 12]
Internet-Draft Network Anomaly Semantics September 2024
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>
Figure 3: ietf-symptom-semantic-metadata YANG Module
Graf, et al. Expires 10 March 2025 [Page 13]
Internet-Draft Network Anomaly Semantics September 2024
5. Security Considerations
The security considerations.
6. Implementation status
This section provides pointers to existing open source
implementations of this draft. Note to the RFC-editor: Please remove
this before publishing.
6.1. Antagonist
A tool called Antagonist has been implemented and refined during the
IETF 119 and 120 hackathons, in order to validate the application of
the YANG models defined in this draft. Antagonist provides visual
support for two important use cases in the scope of this document:
* the generation of a ground truth in relation to Symptoms and
Problems in timeseries data
* the visual validation of results produced by automated network
anomaly detection tools.
The open source code can be found here: [Antagonist]
7. Acknowledgements
The authors would like to thank Reshad Rahman for his review and
valuable comment.
8. References
8.1. Normative References
[Antagonist]
Riccobene, V., Roberto, A., Du, W., Graf, T., and H. Huang
Feng, "Antagonist: Anomaly tagging on historical data",
<https://github.com/vriccobene/antagonist>.
[I-D.ietf-nmop-terminology]
Davis, N., Farrel, A., Graf, T., Wu, Q., and C. Yu, "Some
Key Terms for Network Fault and Problem Management", Work
in Progress, Internet-Draft, draft-ietf-nmop-terminology-
06, 17 October 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-nmop-
terminology-06>.
Graf, et al. Expires 10 March 2025 [Page 14]
Internet-Draft Network Anomaly Semantics September 2024
[I-D.netana-nmop-network-anomaly-architecture]
Graf, T., Du, W., and P. Francois, "An Architecture for a
Network Anomaly Detection Framework", Work in Progress,
Internet-Draft, draft-netana-nmop-network-anomaly-
architecture-00, 8 July 2024,
<https://datatracker.ietf.org/doc/html/draft-netana-nmop-
network-anomaly-architecture-00>.
[I-D.netana-nmop-network-anomaly-lifecycle]
Riccobene, V., Roberto, A., Graf, T., Du, W., and A. H.
Feng, "Experiment: Network Anomaly Lifecycle", Work in
Progress, Internet-Draft, draft-netana-nmop-network-
anomaly-lifecycle-03, 8 July 2024,
<https://datatracker.ietf.org/doc/html/draft-netana-nmop-
network-anomaly-lifecycle-03>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[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>.
8.2. Informative References
[I-D.claise-opsawg-collected-data-manifest]
Claise, B., Quilbeuf, J., Lopez, D., Martinez-Casanueva,
I. D., and T. Graf, "A Data Manifest for Contextualized
Telemetry Data", Work in Progress, Internet-Draft, draft-
claise-opsawg-collected-data-manifest-06, 10 March 2023,
<https://datatracker.ietf.org/doc/html/draft-claise-
opsawg-collected-data-manifest-06>.
Authors' Addresses
Thomas Graf
Swisscom
Binzring 17
CH-8045 Zurich
Switzerland
Email: [email protected]
Graf, et al. Expires 10 March 2025 [Page 15]
Internet-Draft Network Anomaly Semantics September 2024
Wanting Du
Swisscom
Binzring 17
CH-8045 Zurich
Switzerland
Email: [email protected]
Alex Huang Feng
INSA-Lyon
Lyon
France
Email: [email protected]
Vincenzo Riccobene
Huawei
Dublin
Ireland
Email: [email protected]
Antonio Roberto
Huawei
Dublin
Ireland
Email: [email protected]
Graf, et al. Expires 10 March 2025 [Page 16]