Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

T2.0 Shared Library will be used by Components that wish to report Telemetry metrics.

This library and its APIs will allow migration away from the current mechanism for Telemetry that uses log message and grepping (via DCA) to report Component Metrics and information.

This library will insulate Components from needing to know the underlying BUS/IPC used on the device; the T2 Common Library will use RBUS as its platform agnostic IPC, but can use CCSP directly in RDK-B.

NOTE:  The DCA and grepping mechanism will continue to exist in order to support ad-hoc reporting of device/component information.  However, going forward, Components will be migrated to use the T2.0 Shared Library to report Telemetry data in order to reduce the need for grepping on devices.

 

Porting all Components to use T2.0 is outside the scope of the T2.0 team, but will be accomplished via Jira tickets and working closely with Component owners once the T2.0 MVP for DCA port is complete and proven.


T2 Common Library

Telemetry APIs - for use by Components wishing to report metrics/data:

t2_init( char* component)

 

– init BUS/IPC

for 

for component

t2_event_s(char* marker, char* value)

 – 

send marker with string value to T2

t2_event_f(char* marker, double value)

 – 

send marker with double value to T2

t2_event_d(char* marker, int value)

 

 send

send marker with int value to T2

Usage:

  • For count-based XConf markers
    • t2_event_d(“WIFI_INFO_clientdisconnect”, 1);
  • For string-match (_split) XConf markers:
    • t2_event_s("2GRSSI_split", "Test_BOX_WIFI”)
    • t2_event_d("Total_5G_clients_split", num_devs)

T2 Common Library and RBUS

Sequence diagram

from RDKB-25007 illustrating

illustrating T2 Common Library usage of RBUS APIs.

Image Removed

Image Modified


RDKB:

  CcspBus

 CcspBus API for Feed Data

New APIs:

 

int CcspBaseIf_SendTelemetryDataSignal_s ( void* bus_handle,  

  char

 char* marker,  

  char

 char* value);

int CcspBaseIf_SendTelemetryDataSignal_d ( void* bus_handle,  

  char

 char* marker,  

  int

 int value);

int CcspBaseIf_SendTelemetryDataSignal_f ( void* bus_handle,  

  char

 char* marker,  

  double

 double value);

draw.io Diagram
bordertrue
diagramNameRDKBCcspBus API for Feed Data
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth941
height761
revision1