38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# WebRTC Internals Exporter
|
||
A Chromium browser extension that allows to collect WebRTC stats and export them to a Prometheus PushGateway service.
|
||
|
||
## Install
|
||
|
||
### Using the Chrome Web Store
|
||
[Link](https://chromewebstore.google.com/detail/webrtc-internals-exporter/jbgkajlogkmfemdjhiiicelanbipacpa)
|
||
|
||
### Using the packed extension
|
||
Download the `.crx` file from the [releases page](https://github.com/vpalmisano/webrtc-internals-exporter/releases) and drop it
|
||
into the [chrome://extensions/](chrome://extensions/) page.
|
||
Alternatively, you can download a `.zip` or `tar.gz` file from the releases page
|
||
and load the decompressed folder as an unpacked extension.
|
||
|
||
Ref. https://developer.chrome.com/docs/extensions/mv3/hosting/
|
||
|
||
### From sources
|
||
Run the `./build.sh` script and load the `build` folder as an unpacked extension
|
||
in your Chromium browser after enabling the developer mode.
|
||
|
||
## Usage
|
||
1. Visit the extension options page, set the PushGateway URL and, optionally, the username and password.
|
||
2. Load the page where you want to collect the stats and click on the extension icon to enable the stats collection on that URL (disabled by default).
|
||
3. The stats will be collected and sent to the PushGateway service. You can use the provided [Grafana dashboard](https://github.com/vpalmisano/webrtc-internals-exporter/tree/main/grafana) to visualize them.
|
||
|
||
## Debugging
|
||
The extension logs are available in the browser console after setting:
|
||
```js
|
||
localStorage.setItem("webrtc-internal-exporter:debug", "true")
|
||
```
|
||
|
||
The running PeerConnections objects can be manually inspected using the following
|
||
command in the browser console:
|
||
```js
|
||
> webrtcInternalExporter.peerConnections
|
||
Map(1) {'b03c3616-3f91-42b5-85df-7dbebefae8bd' => RTCPeerConnection}
|
||
```
|