Intent to Ship: WebRTC Diagnostic Logging API

[Chromestatus]

Contact emails

gui...@google.com

Explainer

https://github.com/WICG/webrtc-diagnostic-logging/blob/main/explainer.md

Specification

https://w3c.github.io/webrtc-extensions/#diagnostic-logging

Summary

The WebRTC Web Diagnostic Logging API allows authorized web applications to trigger the collection of WebRTC diagnostic data so that it can be used for local debugging. It also allows an application to share the WebRTC diagnostic data with the user agent vendor, subject to user authorization, with the purpose of providing information that can help fix bugs in or improve the user agent. Diagnostic logs are enabled with the enterprise policy [WebRtcDiagnosticLogCollectionAllowedForOrigins](https://chromeenterprise.google/policies/#WebRtcDiagnosticLogCollectionAllowedForOrigins).

Blink component

Blink>WebRTC

Web Feature ID

webrtc

Motivation

WebRTC applications often encounter complex connectivity or media quality issues that are difficult to reproduce in local environments. To debug these issues in production, sometimes it is helpful for developers to have access to internal state and performance metrics. This also applies to issues in the user agent. The WebRTC Web Diagnostic Logging API allows authorized web applications to trigger the collection of WebRTC diagnostic data so that it can be used for local debugging. It also allows an application to share the WebRTC diagnostic data with the user agent vendor, subject to user authorization, with the purpose of providing information that can help fix bugs in or improve the user agent.

Initial public proposal

https://github.com/w3c/webrtc-extensions/issues/124

TAG review

https://github.com/w3ctag/design-reviews/issues/1250

TAG review status

Pending

Origin Trial Name

WebRTC Diagnostic Logging API

Goals for experimentation

We want to test to what extent the API properly supports the following use cases: * Allowing enterprises to collect diagnostic data about WebRTC in order to assist in debugging online problems * Collaborate with UA vendors to fix UA WebRTC bugs.

Chromium Trial Name

RTCDiagnosticLogging

Origin Trial documentation link

https://github.com/WICG/webrtc-diagnostic-logging/blob/main/explainer.md

WebFeature UseCounter name

kV8RTC_StartDiagnosticLogging_Method

Risks

Interoperability and Compatibility

No information provided

Gecko: No signal (https://github.com/mozilla/standards-positions/issues/1436) Mozilla's representative in the WebRTC WG approved adding this feature to the WebRTC Extensions spec. See https://github.com/w3c/webrtc-extensions/pull/255#issuecomment-5620215770

WebKit: No signal (https://github.com/WebKit/standards-positions/issues/699) Apple's representative in the WebRTC WG approved adding this feature to the WebRTC Extensions spec. See https://github.com/w3c/webrtc-extensions/pull/255#pullrequestreview-5168267473

Web developers: Positive An origin trial partner has expressed positive views. Some developers (bytedance, alcatel/lucent) have expressed interest in the use cases supported by this feature before it was developed, but have not provided direct feedback afterwards. https://github.com/w3c/webrtc-extensions/issues/124

Other signals:

Ergonomics

N/A

Activation

N/A

WebView application risks

Does this intent deprecate or change behavior of existing APIs, such that it has potentially high risk for Android WebView-based applications?

N/A

Debuggability

No information provided

Will this feature be supported on all six Blink platforms (Windows, Mac, Linux, ChromeOS, Android, and Android WebView)?

Yes
Supported on desktop platforms.

Is this feature fully tested by web-platform-tests?

Yes
https://crsrc.org/c/third_party/blink/web_tests/wpt_internal/webrtc/

Flag name on about://flags

No information provided

Finch feature name

RTCDiagnosticLogging

Rollout plan

Will ship enabled for all users

Requires code in //chrome?

True

Tracking bug

https://crbug.com/481412281

Launch bug

https://launch.corp.google.com/launch/4419765

Measurement

https://chromestatus.com/metrics/feature/timeline/popularity/5941

Availability expectation

Feature is available only in Chromium browsers for the foreseeable future, but has consensus in the W3C WebRTC WG.

Adoption expectation

Feature is used by specific partner(s) to provide functionality within 12 months of launch in Chrome.

Estimated milestones

Shipping on desktop	156
Origin trial desktop first	151
Origin trial desktop last	156

Anticipated spec changes

Open questions about a feature may be a source of future web compat or interop issues. Please list open issues (e.g. links to known github issues in the project for the feature specification) whose resolution may introduce web compat/interop risk (e.g., changing to naming or structure of the API in a non-backward-compatible way).

No information provided

Link to entry on the Chrome Platform Status

https://chromestatus.com/feature/5091582546149376?gate=5180737343062016

Links to previous Intent discussions

Intent to Experiment: https://groups.google.com/a/chromium.org/d/msgid/blink-dev/6a3a6980.3af95f39.2b348.0333.GAE%40google.com

This intent message was generated by Chrome Platform Status.