Telemetry Report v2.0 final version

[mickeyspiegel]

• Separated the Telemetry Report Header description into separate sections for 'Telemetry Reports Outer Header' (first 8 octets that appear once in a packet, and 'Individual Report Header' that may be repeated, one per report in the packet.
• Within the 'Individual Report Header', created subsections for 'Telemetry Report Contents' when 'RepType' == 'INT', and for 'Inner Report Contents' when 'InType' == 'TLV'
• Reworded section on Embedded Telemetry Metadata to match the v2.0 structure, where the truncated packet fragments reside within each Individual Report Header
• Lots of minor editorial and formatting cleanup
• Added definition of 'node', and changed 'switch' and 'device' to 'node' where appropriate
• Changed 'aggregated' vs 'individual' terminology to 'stacked' vs 'per hop'
• Reserved Domain Specific ID value 0x0000 as default well known ID, for which all DSMdBits are treated as reserved
• Updated references
• Added telemetry_report_latest.pdf that links to telemetry_report_v2_0.pdf

[mickeyspiegel]

There are still some things left to do, but the sections reorganizing the descriptions of the telemetry report header format are ready and should be reviewed.

Some open items:

• The Parsing Considerations section does not align with the current format, either needs to be revised or dropped.
• The examples are pretty rough, should probably go to the same level of detail as some of the INT examples with respect to metadata, but transport can be ignored.
• The whole spec could use a re-read and scrub for editorial fixes and any lingering misalignment due to text from older versions

[mickeyspiegel]

Also need a new INT-MX figure

[rsivakolundu]

I like the Group Header wording.

-Ramesh

On Mon, May 18, 2020 at 12:01 PM JK Lee notifications@github.com wrote:

@jklr commented on this pull request.

In telemetry/specs/telemetry_report.mdk https://github.com/p4lang/p4-applications/pull/81#discussion_r426833766:

-TLVType (4b): TLV Type – TLV data type.

-0 – Domain Specific Extension Data

-1 - Ethernet

-2 – IPv4

-3 – IPv6

-4-15 – Reserved.

+* Variable Optional Domain Specific Metadata

• : The metadata corresponding to the DSMdBits, 4 octets or a multiple of

• 4 octets for each bit.

+### Inner Report Contents for InType 1 (TLV) (4+ octets) { #tlv }

As a 2nd thought, the term "inner" seems confusing because we have "Telemetry Reports Outer Header" up there. The outer header is for the entire coalesced report pkt, and the inner header is for each individual report. The outer vs inner are applied to two different objects.

One idea is to change "Telemetry Reports Outer Header" => "Telemetry Report Group Header", where a group may have one or more individual reports in it. We can define the term 'group' first and use it else where.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/p4lang/p4-applications/pull/81#discussion_r426833766, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZZHFWPSFLB243MATGT3BTRSGA2BANCNFSM4NBIZ6DQ .

[mickeyspiegel]

From my perspective, all that is left now is the examples, INT-MX figure, and resolution of any new comments from this point.

[rsivakolundu]

How can I help?

-Ramesh

On Mon, May 18, 2020 at 3:24 PM Mickey Spiegel notifications@github.com wrote:

From my perspective, all that is left now is the examples, INT-MX figure, and resolution of any new comments from this point.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/p4lang/p4-applications/pull/81#issuecomment-630467522, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZZHFTJJDCMMSNGL2YMNYTRSGYTXANCNFSM4NBIZ6DQ .

[mickeyspiegel]

@rsivakolundu Put some details in your examples, along the lines of what is in INT 2.1.

I cannot put any time into this tomorrow, not yet sure about Wednesday.

[rsivakolundu]

Will spend some time on it tomorrow.

Thanks

-Ramesh

On Mon, May 18, 2020 at 10:12 PM Mickey Spiegel notifications@github.com wrote:

@rsivakolundu https://github.com/rsivakolundu Put some details in your examples, along the lines of what is in INT 2.1.

I cannot put any time into this tomorrow, not yet sure about Wednesday.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/p4lang/p4-applications/pull/81#issuecomment-630584377, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZZHFS5OOXXBPHZPP3BXYLRSIILNANCNFSM4NBIZ6DQ .

[mickeyspiegel]

Done adding examples and figures. This is ready for final review.

[mickeyspiegel]

@rsivakolundu We should be clear about TLVLength. Does it include the first four bytes starting with TLVType and TLVLength or not?