Skip to content

Commit

Permalink
Setup the debugging tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
LVala committed Aug 6, 2024
1 parent 15eee61 commit 952176a
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 2 deletions.
24 changes: 24 additions & 0 deletions guides/advanced/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Debugging and observability

WebRTC is a very complex technology with a lot of moving pieces under the hood, which can make debugging very challanging.
Furtunately, there quite a lot of tools and techiniques created to make this process a bit easier.

This tutorial will teach you a range of WebRTC debugging metchods - from simple to advanced ones. We will go through
how you can inspect and monitor information about ICE connection establishment, negotiation and RTP packets streams both
from the web browser and Elixir side of things.

## WebRTC Internals


## Elixir WebRTC Dashboard

## getStats

## browser with logs

## dumping packets from browser

## turning off certs to see packets in Wireshark


mention debugging guide in "WebRTC for the curious"
Binary file added guides/assets/webrtc_internals_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guides/assets/webrtc_internals_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 9 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ defmodule ExWebRTC.MixProject do
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
description: "Implementation of the W3C WebRTC API",
aliases: aliases(),
package: package(),
deps: deps(),

Expand Down Expand Up @@ -72,9 +73,15 @@ defmodule ExWebRTC.MixProject do
]
end

defp docs() do
defp aliases do
[docs: ["docs", &copy_images/1]]
end

defp copy_images(_), do: File.cp_r!("guides/assets", "doc/assets")

defp docs do
intro_guides = ["intro", "negotiation", "forwarding", "consuming"]
advanced_guides = ["modifying", "mastering_transceivers"]
advanced_guides = ["modifying", "mastering_transceivers", "debugging"]

[
main: "readme",
Expand Down

0 comments on commit 952176a

Please sign in to comment.