[V3] Legacy metrics migration

[xuesichao]

Issue #1320 :

Description of changes:
Update the legacy getStats metrics to standardized metrics.

Testing:

Can these tested using a demo application? Please provide reproducible step-by-step instructions.

Yes, browser demo. Tested in browser demo in Chrome, Firefox and Safari and confirmed the change works as expected.

• Install JS SDK with this change in browser demo
• Run meeting demo with npm run start:hot to enable debugging
• Add breakpoint here:

  amazon-chime-sdk-js/src/statscollector/DefaultStatsCollector.ts

  Line 437 in e67ada2

  this.sendClientMetricProtobuf(clientMetricFrame);

• Open demo demo in Chrome/Firefox/Safari
• Debug the demo and check if the metrics are collected correctly:
  • clientMetricFrame
  • filteredRawMetricReports
  • getObservableMetrics()
  • getObservableVideoMetrics()
  • getRTCStatsReport()

Checklist:

1. Have you successfully run npm run build:release locally?
   Yes

2. Do you add, modify, or delete public API definitions? If yes, has that been reviewed and approved?
   Yes

3. Do you change the wire protocol, e.g. the request method? If yes, has that been reviewed and approved?
   Yes

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[xuesichao]

The changes are messy and trivial. Suggest reviewing the changes commit by commit. Will squash the commits and rebase in the end.

[ltrung]

Can you put in the title V3?

[vidya-mohan]

Nice job! Not blocking- you may wish to quickly review existing guides that reference these for eg availableSendBandwidth etc and modify to the new one

[xuesichao]

Nice job! Not blocking- you may wish to quickly review existing guides that reference these for eg availableSendBandwidth etc and modify to the new one

@vidya-mohan FAQ is the only doc that mentions the metric specs, updated the FAQ to remove the legacy specs.

[xuesichao]

My concern was that migration doc is used once when going from 2->3. API docs are consumed everytime after. Its okay to soft link it to the documentation in migration docs but wonder if IDEs will auto-populate and it would be natural for developers to check on the API documentation when they are actively coding

I agree with you that it is very helpful to mention that. These are interface definitions which should not be that specific in my opinion. The current statement is clear enough.

I would prefer writing a guide on these metrics later.

[hensmi-amazon]

lgtm!