diff --git a/doc/stream-telemetry/stream-telemetry-hld.md b/doc/stream-telemetry/stream-telemetry-hld.md index 59940ce719b..b580e1a8828 100644 --- a/doc/stream-telemetry/stream-telemetry-hld.md +++ b/doc/stream-telemetry/stream-telemetry-hld.md @@ -839,101 +839,6 @@ sai_create_tam_telemetry_fn(&sai_tam_telemetry_obj, switch_id, attr_count, sai_a Based on the STREAM_TELEMETRY_GROUP on Config DB, to create corresponding counter subscription objects. -Proposal a new subscription mode: OBJECT TYPE and Index - -``` c++ - -typedef enum _sai_tam_counter_subscription_type_t -{ - /** @brief Object based subscription */ - SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_ID_BASE, - - /** @brief Index based subscription */ - SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_INDEX_BASE, - -} sai_tam_counter_subscription_type_t; - -typedef enum _sai_tam_counter_subscription_attr_t -{ - - /** - * @brief Subscribed object - * - * @type sai_object_id_t - * @flags MANDATORY_ON_CREATE | CREATE_ONLY - * @objects SAI_OBJECT_TYPE_BUFFER_POOL, SAI_OBJECT_TYPE_INGRESS_PRIORITY_GROUP, SAI_OBJECT_TYPE_PORT, SAI_OBJECT_TYPE_QUEUE - * @validonly SAI_TAM_COUNTER_SUBSCRIPTION_TYPE == SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_ID_BASE - */ - SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_ID, - - /** - * @brief Subscribed stat enum - * - * @type sai_uint32_t - * @flags MANDATORY_ON_CREATE | CREATE_ONLY - */ - SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_STAT_ID, - - // ... - - /** - * @brief Tam telemetry reporting type - * - * @type sai_tam_reporting_type_t - * @flags MANDATORY_ON_CREATE | CREATE_ONLY - * @default SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_ID_BASE - */ - SAI_TAM_COUNTER_SUBSCRIPTION_TYPE, - - /** - * @brief Subscribed object - * - * @type sai_object_type_t - * @flags MANDATORY_ON_CREATE | CREATE_ONLY - * @validonly SAI_TAM_COUNTER_SUBSCRIPTION_TYPE == SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_INDEX_BASE - */ - SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_TYPE, - - /** - * @brief Subscribed object - * - * @type sai_uint32_t - * @flags MANDATORY_ON_CREATE | CREATE_ONLY - * @validonly SAI_TAM_COUNTER_SUBSCRIPTION_TYPE == SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_INDEX_BASE - */ - SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_INDEX, - -} sai_tam_counter_subscription_attr_t; - -``` - -- Index ID based - -``` c++ - -// Create counter subscription list - -sai_attr_list[0].id = SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_TEL_TYPE; -sai_attr_list[0].value.oid = sai_tam_tel_type_obj; - -sai_attr_list[1].id = SAI_TAM_COUNTER_SUBSCRIPTION_TYPE; -sai_attr_list[1].value.s32 = SAI_TAM_COUNTER_SUBSCRIPTION_OBJECT_INDEX_BASE; - -sai_attr_list[2].id = SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_TYPE; -sai_attr_list[2].value.s32 = SAI_OBJECT_TYPE_PORT; - -sai_attr_list[3].id = SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_INDEX; -sai_attr_list[3].value.u32 = 2; // Calculate this index according to - - -attr_count = 4; - -create_tam_counter_subscription(&sai_tam_counter_subscription_obj, switch_id, attr_count, sai_attr_lis); -// If this stats of object cannot support this poll frequency, this API should return SAI_STATUS_NOT_SUPPORTED. -``` - -- Object ID based - ``` c++ // Create counter subscription list