Support for User Defined Metrics

build.py

@@ -12,7 +12,7 @@
 USE_OPENAPIART_DIR = None
 
 # supported values - branch name or None
-USE_OPENAPIART_BRANCH = None
+USE_OPENAPIART_BRANCH = "x-field-uds"
 
 OPENAPIART_REPO = "https://github.com/open-traffic-generator/openapiart.git"
 

config/config.yaml

@@ -64,6 +64,18 @@ components:
           items:
             $ref: '../lldp/lldp.yaml#/components/schemas/Lldp'
           x-field-uid: 9
+        receive_bins:
+          x-status:
+            status: under_review
+            information: There may be changes in receive_bins configuration
+          description: |-
+            A list of bins that can be configured on the traffic generator, 
+            allowing for the retrieval of metrics based on the configured bins/buckets.
+          type: array
+          items:
+            $ref: '../receive_bins/receive_bins.yaml#/components/schemas/ReceiveBins'
+          x-field-uid: 10
+
     Config.Options:
       description: |-
         Global configuration options.

flow/packet-headers/ethernet.yaml

@@ -44,3 +44,38 @@ components:
             default: 0
             features: [count, metric_tags]
           x-field-uid: 4
+
+    Filter.Ethernet:
+      description: Ethernet packet header
+      type: object
+      properties:
+        dst:
+          x-field-uds:
+            description: >-
+              Destination MAC address
+            format: mac
+            default: "00:00:00:00:00:00"
+          x-field-uid: 1
+        src:
+          x-field-uds:
+            description: >-
+              Source MAC address
+            format: mac
+            default: "00:00:00:00:00:00"
+          x-field-uid: 2
+        ether_type:
+          x-field-uds:
+            description: >-
+              Ethernet type
+            format: integer
+            default: 65535
+            length: 16
+          x-field-uid: 3
+        pfc_queue:
+          x-field-uds:
+            description: >-
+              Priority flow control queue
+            format: integer
+            length: 3
+            default: 0
+          x-field-uid: 4

flow/packet-headers/ipv4.yaml

@@ -403,3 +403,208 @@ components:
             default: 0
             features: [count, metric_tags]
           x-field-uid: 6
+
+    Filter.Ipv4:
+      description: IPv4 packet header
+      type: object
+      properties:
+        version:
+          x-field-uds:
+            description: >-
+              Version
+            format: integer
+            length: 4
+            default: 4
+          x-field-uid: 1
+        header_length:
+          x-field-uds:
+            description: >-
+              Header length
+            format: integer
+            default: 5
+            length: 4
+          x-field-uid: 2
+        priority:
+          $ref: "#/components/schemas/Filter.Ipv4.Priority"
+          x-field-uid: 3
+        total_length:
+          x-field-uds:
+            description: >-
+              Total length
+            format: integer
+            default: 46
+            length: 16
+          x-field-uid: 4
+        identification:
+          x-field-uds:
+            description: >-
+              Identification
+            format: integer
+            length: 16
+            default: 0
+          x-field-uid: 5
+        reserved:
+          x-field-uds:
+            description: >-
+              Reserved flag.
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 6
+        dont_fragment:
+          x-field-uds:
+            description: >-
+              Dont fragment flag
+              If the dont_fragment flag is set and fragmentation is required to
+              route the packet then the packet is dropped.
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 7
+        more_fragments:
+          x-field-uds:
+            description: >-
+              More fragments flag
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 8
+        fragment_offset:
+          x-field-uds:
+            description: >-
+              Fragment offset
+            format: integer
+            length: 5
+            default: 0
+          x-field-uid: 9
+        time_to_live:
+          x-field-uds:
+            description: >-
+              Time to live
+            format: integer
+            length: 8
+            default: 64
+          x-field-uid: 10
+        protocol:
+          x-field-uds:
+            description: >-
+              Protocol, default is 61 any host internal protocol
+            format: integer
+            length: 8
+            default: 61
+          x-field-uid: 11
+        src:
+          x-field-uds:
+            description: >-
+              Source address
+            format: ipv4
+            default: 0.0.0.0
+          x-field-uid: 12
+        dst:
+          x-field-uds:
+            description: >-
+              Destination address
+            format: ipv4
+            default: 0.0.0.0
+          x-field-uid: 13
+    Filter.Ipv4.Priority:
+      description: A container for ipv4 raw, tos, dscp ip priorities.
+      type: object
+      properties:
+        choice:
+          type: string
+          default: dscp
+          x-field-uid: 1
+          x-enum:
+            raw:
+              x-field-uid: 1
+            tos:
+              x-field-uid: 2
+            dscp:
+              x-field-uid: 3
+        raw:
+          x-field-uds:
+            description: >-
+              Raw priority
+            format: integer
+            length: 8
+            default: 0
+          x-field-uid: 2
+        tos:
+          $ref: "#/components/schemas/Filter.Ipv4.Tos"
+          x-field-uid: 3
+        dscp:
+          $ref: "#/components/schemas/Filter.Ipv4.Dscp"
+          x-field-uid: 4
+    Filter.Ipv4.Dscp:
+      description: Differentiated services code point (DSCP) packet field.
+      type: object
+      properties:
+        phb:
+          x-field-uds:
+            description: >-
+              Per hop behavior
+            format: integer
+            length: 6
+            default: 0
+          x-field-uid: 1
+        ecn:
+          x-field-uds:
+            description: >-
+              Explicit congestion notification
+            format: integer
+            length: 2
+            default: 0
+          x-field-uid: 2
+    Filter.Ipv4.Tos:
+      description: Type of service (TOS) packet field.
+      type: object
+      properties:
+        precedence:
+          x-field-uds:
+            description: >-
+              Precedence
+            format: integer
+            length: 3
+            default: 0
+          x-field-uid: 1
+        delay:
+          x-field-uds:
+            description: >-
+              Delay
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 2
+        throughput:
+          x-field-uds:
+            description: >-
+              Throughput
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 3
+        reliability:
+          x-field-uds:
+            description: >-
+              Reliability
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 4
+        monetary:
+          x-field-uds:
+            description: >-
+              Monetary
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 5
+        unused:
+          x-field-uds:
+            description: >-
+              Unused
+            format: integer
+            length: 1
+            default: 0
+          x-field-uid: 6

flow/packet-headers/ipv6.yaml

@@ -86,3 +86,70 @@ components:
             default: ::0
             features: [count, metric_tags]
           x-field-uid: 8
+
+    Filter.Ipv6:
+      description: IPv6 packet header
+      type: object
+      properties:
+        version:
+          x-field-uds:
+            description: >-
+              Version number
+            format: integer
+            length: 4
+            default: 6
+          x-field-uid: 1
+        traffic_class:
+          x-field-uds:
+            description: >-
+              Traffic class
+            format: integer
+            length: 8
+            default: 0
+          x-field-uid: 2
+        flow_label:
+          x-field-uds:
+            description: >-
+              Flow label
+            format: integer
+            length: 20
+            default: 0
+          x-field-uid: 3
+        payload_length:
+          x-field-uds:
+            description: >-
+              Payload length
+            format: integer
+            length: 16
+            default: 0
+          x-field-uid: 4
+        next_header:
+          x-field-uds:
+            description: >-
+              Next header
+            format: integer
+            length: 8
+            default: 59
+          x-field-uid: 5
+        hop_limit:
+          x-field-uds:
+            description: >-
+              Hop limit
+            format: integer
+            length: 8
+            default: 64
+          x-field-uid: 6
+        src:
+          x-field-uds:
+            description: >-
+              Source address
+            format: ipv6
+            default: ::0
+          x-field-uid: 7
+        dst:
+          x-field-uds:
+            description: >-
+              Destination address
+            format: ipv6
+            default: ::0
+          x-field-uid: 8

flow/packet-headers/mpls.yaml

@@ -41,3 +41,40 @@ components:
             default: 64
             features: [count, metric_tags]
           x-field-uid: 4
+
+    Filter.Mpls:
+      description: MPLS packet header
+      type: object
+      properties:
+        label:
+          x-field-uds:
+            description: >-
+              Label of routers
+            format: integer
+            length: 20
+            default: 16
+          x-field-uid: 1
+        traffic_class:
+          x-field-uds:
+            description: >-
+              Traffic class
+            format: integer
+            length: 3
+            default: 0
+          x-field-uid: 2
+        bottom_of_stack:
+          x-field-uds:
+            description: >-
+              Bottom of stack
+            format: integer
+            length: 1
+            default: 1
+          x-field-uid: 3
+        time_to_live:
+          x-field-uds:
+            description: >-
+              Time to live
+            format: integer
+            length: 8
+            default: 64
+          x-field-uid: 4

flow/packet-headers/snmpv2c.yaml

@@ -366,5 +366,5 @@ components:
 
 
 
-        
-    
+
+