Extensible Telemetry Guide

{
    "items": [
        {
            "identity": <key goes here>,
            "value": <value goes here>,
        },
        {
            "identity": <key goes here>,
            "value": <value goes here>,
        },
        ...
    ]
}

[
    {
        "key": <key goes here>,
        "value": <value goes here>,
    },
    {
        "key": <key goes here>,
        "value": <value goes here>,
    },
    ...
]

"""
    Service Name: interface_in_out_bytes
    Schema:
        Key: String, represents interface name.
        Value: Json String with two possible keys:
            rx: integer value, represents received bytes.
            tx: integer value, represents transmitted bytes.
    DOS: eos
    Data collected using command: 'show interfaces'
    Type of Collector: BaseTelemetryCollector
    Storage Schema Path: aos.sdk.telemetry.schemas.generic
    Application Schema: {
        'type': 'object',
        'properties': {
            'identity': {
                'type': 'string',
            },
            'value': {
                'type': 'object',
                'properties': {
                    'rx': {
                        'type': 'number',
                    },
                    'tx': {
                        'type': 'number',
                    }
                },
                'required': ['rx', 'tx'],
            }
        }
    }

"""
import json
from aos.sdk.system_agent.base_telemetry_collector import BaseTelemetryCollector


# Inheriting from BaseTelemetryCollector
class InterfaceRxTxCollector(BaseTelemetryCollector):

    # Overriding collect method
    def collect(self):

        # Obtaining the command output using the device instance.
        collected_data = self.device.get_json('show interfaces')

        # Data is in the format
        # "interfaces": {
        #     "<interface_name>": {
        #         ....
        #         "interfaceCounters": {
        #         ....
        #         "inOctets": int
        #         "outOctets": int
        #         ....
        #         }
        #     }
        #     ...
        # }

        # Parse the data as per the schema and structure required.
        parsed_data = json.dumps({
            'items': [
                {
                    'identity': intf_name,
                    'value': json.dumps({
                        'rx': intf_stats['interfaceCounters'].get('inOctets'),
                        'tx': intf_stats['interfaceCounters'].get('outOctets'),
                    })
                } for intf_name, intf_stats in collected_data['interfaces'].iteritems()
                if 'interfaceCounters' in intf_stats
            ]
        })

        # Post the data to the framework
        self.post_data(parsed_data)


# Define collector_plugin class to return the Collector
def collector_plugin(_device):
    return InterfaceRxTxCollector

"""
    Service Name: iba_bgp
    Schema:
        Key: JSON String, specifies local IP and peer IP.
        Value: String. ‘1’ if state is established ‘2’ otherwise
    DOS: eos
    Data collected using command: 'show ip bgp summary vrf all'
    Storage Schema Path: aos.sdk.telemetry.schemas.iba_string_data
    Application Schema: {
        'type': 'object',
        'properties': {
            key: {
                'type': 'object',
                'properties': {
                    'local_ip': {
                        'type': 'string',
                    },
                    'peer_ip': {
                        'type': 'string',
                    }
                },
                'required': ['local_ip', 'peer_ip'],
            },
            'value': {
                'type': 'string',
            }
        }
    }
"""

from aos.sdk.system_agent.base_telemetry_collector import IBATelemetryCollector

def parse_text_output(collected):
    result = [
        {'key': {'local_ip': str(vrf_info['routerId']), 'peer_ip': str(peer_ip)},
         'value': str(
             1 if session_info['peerState'] == 'Established' else 2)}
        for vrf_info in collected['vrfs'].itervalues()
        for peer_ip, session_info in vrf_info['peers'].iteritems()]
    return result

# Inheriting from BaseTelemetryCollector
class IbaBgpCollector(BaseTelemetryCollector):
    # Overriding collect method
    def collect(self):
        # Obtaining the command output using the device instance.
        collected_data = self.device.get_json('show ip bgp summary vrf all')
    # Parse the data as per the schema and structure required and
    # post to framework.
        self.post_data(parse_text_output(collected_data))

# Define collector_plugin class to return the Collector
def collector_plugin(device):
    return IbaBgpCollector