ByteBlower GUI OpenMetrics Exporter

The main advantages (v2.18) of the Prometheus exporter are:

• Infinitely longer test runs
• Slightly more flows

Prometheus Configuration

Below is an example Prometheus configuration, here 2 ByteBlower GUIs are being scraped for results. These results are available on TCP port 8123. They are available as a text-format specified by Prometheus. These metrics can also be viewed from a web browser.

 
scrape configs:
  - job_name: "ByteBlower GUI"
    static_configs:
      - targets: ["10.8.0.10:8123", "10.8.0.11:8123"]
       

The ByteBlower GUI will update the traffic results every second. Larger scenarios or reduced network connectivity between ByteBlower Server and GUI (e.g., VPN) reduce this rate.

Throughput metrics

The throughput is exported form the ByteBlower GUI through byteblower_gui_traffic_bytes This metric is represented by a counter. As a result there's both a _total and _created variant available.

• byteblower_gui_traffic_bytes_total: The total amount of bytes since the counter was created.
• byteblower_gui_traffic_bytes_created: The unix timestamp representing when the counter was created.

This counter reports the total amount of bytes. This amount is reset at the start of each scenario. This counter is used both for FrameBlasting and TCP flows.

The following labels are added by the ByteBlower GUI on this metric:

• flow: The name of the flow that generates the traffic.
• port: Name of the ByteBlower port.
• direction: Whether this traffic was received (rx) or transmitted (tx).

In practice the above means:

• FrameBlasting: unidirectional traffic, 2 lines for each flow. A ByteBlower port will either be transmitting (direction="tx") or receiving (direction="rx").
• TCP: bidirectional traffic, 4 lines for each flow. Each port will have both rx and tx

Deprecated: Results are also exported from the gauge bbgui_scenario_throughput_bytes. This metric is deprecated.

Latency metrics

Latency is reported by the following gauges:

• byteblower_gui_latency_average_seconds: the average latency in seconds, taken over the last second.
• byteblower_gui_latency_minimum_seconds: the minimum latency in seconds, taken over the last second.
• byteblower_gui_latency_maximum_seconds: the maximum latency in seconds, taken over the last second.
• byteblower_gui_latency_jitter_seconds: the latency jitter in seconds, taken over the last second.

The following labels are added on these metrics:

• flow: The name of the flow where the latency is measured on.
• source: The name of the ByteBlower Port that transmits the traffic.
• destination: The name of the ByteBlower Port where the traffic is received.
• latency_type: Currently always one-way.

This metric is only available for FrameBlasting flows.

Out-Of-Sequence metrics

Out-of-Sequence results are available from the metric byteblower_gui_out_of_sequence. This counter is available on each FrameBlasting Flow where out-of-sequence is enabled.

Like the throughput counter, this metric is restarted at the beginning of each scenario. The reported unit is the total number of reordered packets.

The following labels are added on these metrics:

• flow: The name of the flow where the out-of-sequence measurement takes place.
• port: The name of the ByteBlower Port that counts the reordered packets.