[TAM] Granular counter subscription #1670

j-bos · 2022-12-01T02:24:23Z

Enhancements to TAM API to enable a high-speed polling feature to repeatedly poll one or a few counters at short time intervals.

A new telemetry type for granular counter subscription to request specific counters at runtime.
Introduce SAI_TAM_COUNTER_SUBSCRIPTION object to represent subscribed counters and allow the user to associate a label for the counter in telemetry reports.
Add a time units configuration to specify units for the report interval. Default is backwards-compatible to the current units (microseconds).

j-bos · 2022-12-09T19:26:32Z

Capturing here comments from review on SAI weekly call:

PERIODIC may not be needed. Use existing attribute for the counter polling interval.
Move document to .md format

inc/saitam.h

rck-innovium · 2023-01-16T06:03:44Z

doc/TAM/Timeslice-Telemetry-and-Granular-Counter-Subscription.md

+
+| Node ID | Time-0 timestamp | Time-1 timestamp | Time-2 timestamp | Time-3 timestamp | Time-4 timestamp | Time-5 timestamp |
+| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
+| Counter-ID 0 | Counter-0 at Time-0 | Counter-0 at Time-1 | Counter-0 at Time-2 | Counter-0 at Time-3 | Counter-0 at Time-4 | Counter-0 at Time-5  |


What is the mapping between the counter-id in the report to the actual SAI Object id?

How is the node-id mapped to a particular SAI switch instance?

doc/TAM/Timeslice-Telemetry-and-Granular-Counter-Subscription.md

rck-innovium

We need capability APIs to expose:

the timeslice interval that can be supported by the device
the max number and types of counters that can be polled in one polling interval atomically

doc/TAM/Timeslice-Telemetry-and-Granular-Counter-Subscription.md

j-bos · 2023-04-06T15:39:56Z

Significant Updates:

Decouple the telemetry report format from this subscription proposal. Existing report types like proto or ipfix may be used.
A counter label is required for the collector to identify a counter. Since this needs to be bound to a specific object (with object id), introduce a new object to represent the relationship.

JaiOCP

Looks Good

inc/saitam.h

kcudnik · 2023-06-29T15:16:08Z

/azp run

azure-pipelines · 2023-06-29T15:16:15Z

Azure Pipelines successfully started running 1 pipeline(s).

rlhui · 2023-08-08T19:14:37Z

@rck-innovium would you like to approve this or any concern/feedback?

rck-innovium · 2023-08-09T10:29:32Z

doc/TAM/Granular-Counter-Subscription.md

+sai_attr.value.oid = sai_tam_obj;
+
+sai_set_queue_attribute_fn(
+    sai_queue,


Typo? Instead of sai_queue, it should be sai_queue_obj used as SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_ID earlier.

If yes, this is a redundancy in this new API model.

Yes, it is a typo (more like a missed edit when adding _obj to follow the style of other examples).

Agree it is a redundancy. I also considered the alternative of just using the TAM attachment point at the switch as an on/off for a TAM defined for this kind of counter collection. What are your thoughts on that?

In particular, it might increase extensibility to other objects which do not currently have a defined TAM bind-point (and be a bit easier to use since the telemetry can be enabled/disabled all-at-once if desired (rather than object-by-object)

@JaiOCP , I would like to get your thoughts on this as well. Whether we can/should just use an attachment to switch for this kind of telemetry.

doc/TAM/Granular-Counter-Subscription.md

rck-innovium · 2023-08-09T10:36:22Z

@rck-innovium would you like to approve this or any concern/feedback?

@rlhui @j-bos

The current spec has changed quiet a bit from what was last discussed in the community. The comment about mapping the counter id in the report to the SAI OID has been addressed using the labels.

However, the other changes including the new API needs more discussion. I believe that the example workflow may have some typos and/or missing attributes. I want to ensure that there is no redundancy in the proposed API model.

Typos and/or missing attributes in the given workflow:

SAI_TAM_TEL_TYPE_ATTR_COUNTER_SUBSCRIPTION_LIST is missing in the example workflow. Do we construct a TAM object that references the TAM counter subscription object?
SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_ID points to the target queue_obj_id. And later, we bind the TAM object to the queue_obj_id using SAI_QUEUE_ATTR_TAM. The example uses different variable names for the queue OID. Is this a typo? If yes, we should avoid this bidirectional reference?

inc/saitam.h

kcudnik · 2023-08-17T13:15:35Z

please fix build errors

j-bos · 2023-08-17T15:44:11Z

please fix build errors

Thanks, looks related to the git history scanning, will squash the commits.

inc/saitam.h

Signed-off-by: Jason Bos <jbos@cisco.com>

j-bos · 2023-12-06T21:11:06Z

SAI_TAM_COUNTER_SUBSCRIPTION_ATTR_OBJECT_ID points to the target queue_obj_id. And later, we bind the TAM object to the queue_obj_id using SAI_QUEUE_ATTR_TAM. The example uses different variable names for the queue OID. Is this a typo? If yes, we should avoid this bidirectional reference?

Removed the bidirectional reference as discussed over email. Documentation now indicates binding to the switch is used to enable/disable the feature in a simpler way after the subscriptions are created.

The primary purpose of this is to bring in support for compiling on Debian Bookworm. This brings in the following changes: * Update the Doxyfile for doxygen in Debian Bookworm (opencomputeproject/SAI#1946) * Enable sai_uint16_t in ProcessStructValueType Struct Member (opencomputeproject/SAI#1949) * [meta] Add support for port stat extensions (opencomputeproject/SAI#1947) * [meta] Add custom range start end values check (opencomputeproject/SAI#1945) * Cable diagnostics attribute added (opencomputeproject/SAI#1894) * Add attributes to disable L3 rewrites (opencomputeproject/SAI#1924) * Add MAC remote loopback to the port loopback enums. (opencomputeproject/SAI#1934) * [TAM] Granular counter subscription (opencomputeproject/SAI#1670) Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>

j-bos force-pushed the telemetry branch from 5c1a60c to af41a7c Compare December 15, 2022 06:56

j-bos commented Jan 12, 2023

View reviewed changes

inc/saitam.h Outdated Show resolved Hide resolved

rck-innovium suggested changes Jan 16, 2023

View reviewed changes

rck-innovium reviewed Jan 16, 2023

View reviewed changes

doc/TAM/Timeslice-Telemetry-and-Granular-Counter-Subscription.md Outdated Show resolved Hide resolved

rck-innovium reviewed Jan 17, 2023

View reviewed changes

doc/TAM/Timeslice-Telemetry-and-Granular-Counter-Subscription.md Outdated Show resolved Hide resolved

j-bos changed the title ~~[TAM] Periodic and Timeslice telemetry~~ [TAM] Granular counter subscription Mar 30, 2023

j-bos force-pushed the telemetry branch 3 times, most recently from 6680bf9 to ac2c323 Compare April 6, 2023 15:13

kcudnik approved these changes Apr 11, 2023

View reviewed changes

JaiOCP approved these changes May 22, 2023

View reviewed changes

j-bos commented May 23, 2023

View reviewed changes

inc/saitam.h Outdated Show resolved Hide resolved

j-bos force-pushed the telemetry branch from d81ce1a to 52f6c93 Compare May 30, 2023 07:14

kcudnik reviewed May 30, 2023

View reviewed changes

inc/saitam.h Show resolved Hide resolved

kcudnik approved these changes Aug 9, 2023

View reviewed changes

rck-innovium reviewed Aug 9, 2023

View reviewed changes

doc/TAM/Granular-Counter-Subscription.md Show resolved Hide resolved

kcudnik reviewed Aug 10, 2023

View reviewed changes

inc/saitam.h Show resolved Hide resolved

kcudnik approved these changes Aug 17, 2023

View reviewed changes

j-bos force-pushed the telemetry branch from 7e24aa8 to ed49d9f Compare August 17, 2023 15:50

j-bos force-pushed the telemetry branch from ed49d9f to 1ba273e Compare September 26, 2023 22:07

kcudnik reviewed Sep 27, 2023

View reviewed changes

inc/saitam.h Outdated Show resolved Hide resolved

j-bos force-pushed the telemetry branch from 27acc94 to 0d95283 Compare October 4, 2023 20:47

kcudnik approved these changes Oct 5, 2023

View reviewed changes

srikrishnagopu reviewed Oct 26, 2023

View reviewed changes

inc/saitam.h Show resolved Hide resolved

inc/saitam.h Show resolved Hide resolved

srikrishnagopu approved these changes Oct 27, 2023

View reviewed changes

j-bos added 2 commits December 6, 2023 20:57

[TAM] Granular Counter Subscription

e923f19

Signed-off-by: Jason Bos <jbos@cisco.com>

Reorder set/get functions

dabc3af

Signed-off-by: Jason Bos <jbos@cisco.com>

j-bos force-pushed the telemetry branch from 0d95283 to dabc3af Compare December 6, 2023 20:58

Update example to indicate TAM should be bound to the switch

79320ed

Signed-off-by: Jason Bos <jbos@cisco.com>

rck-innovium approved these changes Dec 17, 2023

View reviewed changes

rlhui merged commit 6f0550e into opencomputeproject:master Dec 18, 2023
3 checks passed

saiarcot895 mentioned this pull request Jan 26, 2024

Make changes to support compiling on Bookworm (with GCC 12) sonic-net/sonic-sairedis#1344

Merged

j-bos deleted the telemetry branch March 7, 2024 08:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TAM] Granular counter subscription #1670

[TAM] Granular counter subscription #1670

j-bos commented Dec 1, 2022 •

edited

Loading

j-bos commented Dec 9, 2022 •

edited

Loading

rck-innovium Jan 16, 2023

rck-innovium left a comment

j-bos commented Apr 6, 2023

JaiOCP left a comment

kcudnik commented Jun 29, 2023

azure-pipelines bot commented Jun 29, 2023

rlhui commented Aug 8, 2023

rck-innovium Aug 9, 2023

j-bos Aug 10, 2023

j-bos Aug 10, 2023

rck-innovium commented Aug 9, 2023

kcudnik commented Aug 17, 2023

j-bos commented Aug 17, 2023

j-bos commented Dec 6, 2023 •

edited

Loading

[TAM] Granular counter subscription #1670

[TAM] Granular counter subscription #1670

Conversation

j-bos commented Dec 1, 2022 • edited Loading

j-bos commented Dec 9, 2022 • edited Loading

rck-innovium Jan 16, 2023

Choose a reason for hiding this comment

rck-innovium left a comment

Choose a reason for hiding this comment

j-bos commented Apr 6, 2023

JaiOCP left a comment

Choose a reason for hiding this comment

kcudnik commented Jun 29, 2023

azure-pipelines bot commented Jun 29, 2023

rlhui commented Aug 8, 2023

rck-innovium Aug 9, 2023

Choose a reason for hiding this comment

j-bos Aug 10, 2023

Choose a reason for hiding this comment

j-bos Aug 10, 2023

Choose a reason for hiding this comment

rck-innovium commented Aug 9, 2023

kcudnik commented Aug 17, 2023

j-bos commented Aug 17, 2023

j-bos commented Dec 6, 2023 • edited Loading

j-bos commented Dec 1, 2022 •

edited

Loading

j-bos commented Dec 9, 2022 •

edited

Loading

j-bos commented Dec 6, 2023 •

edited

Loading