Openonu-go adapter supports performance metrics configuration and collection from the ONUs. There are two types of performance metrics
The group metrics are managed as a group, meaning we can only set sampling frequency, disable/enable group as a whole and not individual metrics within the group. While in contrast the standalone metrics can be managed individually. A subset of the group metrics are L2 Performance Metrics (PM) whose sampling interval is fixed at 15mins. The following are the supported L2 PMs
The performance metrics configuration is carried out via the PmConfigs protobuf messages.
The meaning of various information elements in the PmConfigs and its default value (if applicable) for openonu-go adapter is documented in the below table.
| Key | Meaning | Default for openonu-go | Additional notes |
|---|---|---|---|
| id | onu device id | onu device id | |
| default_freq | Default sampling rate | 15 * 60 seconds for L2 PMs, otherwise 5 * 60 seconds | Applicable only when freq_override is set to false. Note that the sampling frequency cannot be set for L2 PM counters and is fixed at 15 mins by the OMCI specification |
| grouped | Forces group names and group semantics | True | When this is set to true, it forces group names and group semantics. This is a READ ONLY attribute and cannot be changed from NBI |
| freq_override | Allows Pm to set an individual sample frequency | True | When this is set to true, the group specific sampling rate comes into effect. This is a READ ONLY attribute and cannot be changed from NBI |
| groups | The groups if grouped is true | More details about the groups supported by openonu-go adapter is documented further in this notes. | |
| metrics | The metrics themselves if grouped is false. | Unsupported at the moment | |
| max_skew | How long the next sampling is skewed | 0 | openonu-go adapter metrics collection does not skew metric collection |
The following group metrics are supported by openonu-go adapter.
// OpticalPowerGroupMetrics are supported optical pm names
var OpticalPowerGroupMetrics = map[string]voltha.PmConfig_PmType{
"ani_g_instance_id": voltha.PmConfig_CONTEXT,
"transmit_power_dBm": voltha.PmConfig_GAUGE,
"receive_power_dBm": voltha.PmConfig_GAUGE,
}
// UniStatusGroupMetrics are supported UNI status names
var UniStatusGroupMetrics = map[string]voltha.PmConfig_PmType{
"uni_port_no": voltha.PmConfig_CONTEXT,
"me_class_id": voltha.PmConfig_CONTEXT,
"entity_id": voltha.PmConfig_CONTEXT,
"configuration_ind": voltha.PmConfig_GAUGE,
"oper_status": voltha.PmConfig_GAUGE,
"uni_admin_state": voltha.PmConfig_GAUGE,
}
Note:
configuration_ind is relevant only for PPTP ME (meaning me_class_id = 11) and per G.988 specification, "When a circuit pack is present, this attribute represents its type as one of the values from Table 9.1.5-1."oper_state are 0 (enabled) and 1 (disabled)uni_admin_state are 0 (unlocks) and 1 (locks)oper_state and uni_admin_state are relevant for both PPTP (me_class_id = 11) and VEIP ME (me_class_id = 329), however only uni_admin_state is relevant for UNI-G ME (me_class_id = 264).var EthernetBridgeHistory = map[string]voltha.PmConfig_PmType{
"class_id": voltha.PmConfig_CONTEXT,
"entity_id": voltha.PmConfig_CONTEXT,
"interval_end_time": voltha.PmConfig_CONTEXT,
"parent_class_id": voltha.PmConfig_CONTEXT,
"parent_entity_id": voltha.PmConfig_CONTEXT,
"upstream": voltha.PmConfig_CONTEXT,
"drop_events": voltha.PmConfig_COUNTER,
"octets": voltha.PmConfig_COUNTER,
"packets": voltha.PmConfig_COUNTER,
"broadcast_packets": voltha.PmConfig_COUNTER,
"multicast_packets": voltha.PmConfig_COUNTER,
"crc_errored_packets": voltha.PmConfig_COUNTER,
"undersize_packets": voltha.PmConfig_COUNTER,
"oversize_packets": voltha.PmConfig_COUNTER,
"64_octets": voltha.PmConfig_COUNTER,
"65_to_127_octets": voltha.PmConfig_COUNTER,
"128_to_255_octets": voltha.PmConfig_COUNTER,
"256_to_511_octets": voltha.PmConfig_COUNTER,
"512_to_1023_octets": voltha.PmConfig_COUNTER,
"1024_to_1518_octets": voltha.PmConfig_COUNTER,
}
var EthernetUniHistory = map[string]voltha.PmConfig_PmType{
"class_id": voltha.PmConfig_CONTEXT,
"entity_id": voltha.PmConfig_CONTEXT,
"interval_end_time": voltha.PmConfig_CONTEXT,
"fcs_errors": voltha.PmConfig_COUNTER,
"excessive_collision_counter": voltha.PmConfig_COUNTER,
"late_collision_counter": voltha.PmConfig_COUNTER,
"frames_too_long": voltha.PmConfig_COUNTER,
"buffer_overflows_on_rx": voltha.PmConfig_COUNTER,
"buffer_overflows_on_tx": voltha.PmConfig_COUNTER,
"single_collision_frame_counter": voltha.PmConfig_COUNTER,
"multiple_collisions_frame_counter": voltha.PmConfig_COUNTER,
"sqe_counter": voltha.PmConfig_COUNTER,
"deferred_tx_counter": voltha.PmConfig_COUNTER,
"internal_mac_tx_error_counter": voltha.PmConfig_COUNTER,
"carrier_sense_error_counter": voltha.PmConfig_COUNTER,
"alignment_error_counter": voltha.PmConfig_COUNTER,
"internal_mac_rx_error_counter": voltha.PmConfig_COUNTER,
}
var FecHistory = map[string]voltha.PmConfig_PmType{
"class_id": voltha.PmConfig_CONTEXT,
"entity_id": voltha.PmConfig_CONTEXT,
"interval_end_time": voltha.PmConfig_CONTEXT,
"corrected_bytes": voltha.PmConfig_COUNTER,
"corrected_code_words": voltha.PmConfig_COUNTER,
"uncorrectable_code_words": voltha.PmConfig_COUNTER,
"total_code_words": voltha.PmConfig_COUNTER,
"fec_seconds": voltha.PmConfig_COUNTER,
}
var GemPortHistory = map[string]voltha.PmConfig_PmType{
"class_id": voltha.PmConfig_CONTEXT,
"entity_id": voltha.PmConfig_CONTEXT,
"interval_end_time": voltha.PmConfig_CONTEXT,
"transmitted_gem_frames": voltha.PmConfig_COUNTER,
"received_gem_frames": voltha.PmConfig_COUNTER,
"received_payload_bytes": voltha.PmConfig_COUNTER,
"transmitted_payload_bytes": voltha.PmConfig_COUNTER,
"encryption_key_errors": voltha.PmConfig_COUNTER,
}
The KPI information is published on the kafka bus under the voltha.events topic. For VOLTHA PM information, the kafka key is empty and the value is a JSON message composed of the following key-value pairs.
| key | value | Notes |
|---|---|---|
| type | string | "slice" or "ts". A "slice" is a set of path/metric data for the same time-stamp. A "ts" is a time-series: array of data for same metric |
| ts | float | UTC time-stamp of when the KpiEvent2 was created (seconds since the epoch of January 1, 1970) |
| slice_data | list | One or more sets of metrics composed of a metadata section and a metrics section. |
NOTE: Time-series metrics and corresponding protobuf messages have not been defined.
For KPI slice KPI messages, the slice_data portion of the KpiEvent2 is composed of a metadata section and a metrics section.
The metadata section is used to:
| key | value | Notes |
|---|---|---|
| title | string | "slice" or "ts". A "slice" is a set of path/metric data for the same time-stamp. A "ts" is a time-series: array of data for same metric |
| ts | float | UTC time-stamp of data at the time of collection (seconds since the epoch of January 1, 1970) |
| logical_device_id | string | The logical ID that the device belongs to. This is equivalent to the DPID reported in ONOS for the VOLTHA logical device with the 'of:' prefix removed. |
| device_id | string | The physical device ID that is reporting the metric. |
| serial_number | string | The reported serial number for the physical device reporting the metric. |
| context | map | A key-value map of metric/metric-group specific information. |
The context map is composed of key-value pairs where the key (string) is the label for the context specific value and the value (string) is the corresponding context value. While most values may be better represented as a float/integer, there may be some that are better represented as text. For this reason, values are always represented as strings to allow the ProtoBuf message format to be as simple as possible.
Here is an JSON example of a current KPI published on the kafka bus under the voltha.events topic.
"kpiEvent2":{ "type":"slice", "ts":1611605902528748000, "sliceData":[ { "metadata":{ "title":"OpticalPower", "ts":1611605902515836000, "logicalDeviceId":"1eda0422-f1cc-42e6-9a23-08039e7cdf43", "serialNo":"ALPHe3d1cf70", "deviceId":"1eda0422-f1cc-42e6-9a23-08039e7cdf43", "context":{ "devicetype":"brcm_openomci_onu", "intfID":"0", "onuID":"1" }, "uuid":"" }, "metrics":{ "ani_g_instance_id":32769, "receive_power_dBm":1.2, "transmit_power_dBm":-16.7 } } ] }
voltctl device pmconfig get <onu-device-id>
voltctl device pmconfig group list <onu-device-id>
voltctl device pmconfig groupmetric list <onu-device-id> <group-name>
voltctl device pmconfig frequency set <onu-device-id> <sampling-rate>
Note1: Sampling rate unit is in seconds
Note2: default sample rate is applicable only if frequency override is false
Note3 : The frequency has to be greater than 0 and a multiple of FrequencyGranularity which is currently set to 5.
voltctl device pmconfig group disable <onu-device-id> <group-name>
voltctl device pmconfig group enable <onu-device-id> <group-name>
voltctl device pmconfig group set <onu-device-id> <group-name> <frequency>
Note1 : The frequency has to be greater than 0 and a multiple of FrequencyGranularity which is currently set to 5.
Note2 : The frequency of L2 PM counters is fixed at 15m and cannot be changed.
voltctl -k <kafka-ip:port> event listen --show-body -t 10000 -o json -F
Note: For more event listen options, check voltctl event listen --help command.
voltha.events is the default topic on which the KPI/PM events are pushed by the openonu adapter. This default value can be changed by setting the required value to voltha-adapter-openonu.adapter_open_onu.topics.event_topic in the voltha-adapter-openonu helm chart.
voltha supports following on demand counters:
Ethernet frame extended pm me collects PM data at a point where an Ethernet flow can be observed.Currently, only Physical path termination point Ethernet UNI and Virtual Ethernet interface point ME are supported as parent ME. The protobuf message protomessage reports the pm with below counters for each direction(upstream as well as downstream):
uint64 drop_events uint64 octets uint64 frames uint64 broadcast_frames uint64 multicast_frames uint64 crc_errored_frames uint64 undersize_frames uint64 oversize_frames uint64 frames_64_octets uint64 frames_65_to_127_octets uint64 frames_128_to_255_octets uint64 frames_256_to_511_octets uint64 frames_512_to_1023_octets uint64 frames_1024_to_1518_octets
Note :For the fields which are not supported by onu, the counter value is equivalent to either 2^32 -2 for 32 bit Me or 2^64 - 2 for 64bit Me.
Onu Pon interface stats are collected from olt. The protobuf message protomessage reports the ith pon interface stats on demand.
Note : The fields in onu stats are optional as the some counters may or may not be supported by some vendors.
voltctl device getextval ethernet_frame_extended_pm <onu-device-id>
voltctl device getextval onu_stats <pon-interface-id> <onu-id>
Note : The pon interface id and onu id are of type uint32. Hence the input should be respective pon interface id and onu id in an integer.
Use below command to pull the report from ANI-G self test command
voltctl device getextval onu_pon_optical_info <onu-device-id>
Below is sample output.
POWER_FEED_VOLTAGE__VOLTS: 3.26 RECEIVED_OPTICAL_POWER__dBm: -16.02 MEAN_OPTICAL_LAUNCH_POWER__dBm: 5.5660005 LASER_BIAS_CURRENT__mA: 0.01648 TEMPERATURE__Celsius: 59.5
The following Metrics could be supported in the future.