Chromium Code Reviews| Index: tools/py_event_log_analyzer/README |
| diff --git a/tools/py_event_log_analyzer/README b/tools/py_event_log_analyzer/README |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..7300a83923edead4682d602327590b37d2cea2d4 |
| --- /dev/null |
| +++ b/tools/py_event_log_analyzer/README |
| @@ -0,0 +1,47 @@ |
| +This file describes how to set up and use the RTP log analyzer. |
| + |
| +Run the tool as follows: |
| + |
| + python rtp_analyzer.py <rtc event log> |
| + |
| +where <rtc event log> is a protobuf dump of the RTC event stream. Such |
|
ivoc
2016/05/24 11:50:17
I recommend rephrasing this a bit, for example: wh
aleloi
2016/05/24 15:54:39
Done.
|
| +dumps are generated by Chrome through chrome://webrtc-internals |
|
ivoc
2016/05/24 11:50:17
I would rephrase to make it more clear that there
aleloi
2016/05/24 15:54:39
Done.
|
| + |
| +The script has been tested to work in python versions 3.4.1 and 2.7.6, |
| +but should work in all python versions for which there is a version |
| +of the dependencies. |
| + |
| +Dependencies |
| +------------ |
| + |
| +The analyzer script needs *numpy* (http://www.numpy.org/) and |
| +*matplotlib* (http://matplotlib.org/). These libraries can probably be |
|
ivoc
2016/05/24 11:50:17
I don't think it's safe to assume all of our users
aleloi
2016/05/24 15:54:39
Done.
|
| +installed with your systems package manager, e.g. |
| + |
| + sudo apt-get install python-numpy python-matplotlib |
| + |
| +in Debian-based systems |
| + |
| +If you use python 2, you also need *enum34* |
|
ivoc
2016/05/24 11:50:17
This might be a small/personal thing, but I prefer
aleloi
2016/05/24 15:54:39
Done.
|
| +(https://pypi.python.org/pypi/enum34) and *future* |
| +(https://pypi.python.org/pypi/future). These packages can be installed |
| +through pip, (https://docs.python.org/2.7/installing/). |
| + |
| +You also need a version of Protocol Buffers. One is distributed along |
|
ivoc
2016/05/24 11:50:17
Same here, I would recommend: A version of the Pro
aleloi
2016/05/24 15:54:39
Done.
|
| +with WebRTC in `thirdparty/protobuf/python`. This tool also needs a |
| +file `rtc_event_log_pb2.py` which is automatically generated from |
| +`webrtc/call/rtc_event_log.proto` and placed in |
| +`out/<TARGET>/pyproto/webrtc/call/` with every WebRTC compilation. To |
| +use it, you have to compile WebRTC before using this tool. |
|
ivoc
2016/05/24 11:50:17
To generate it, WebRTC should be compiled before u
aleloi
2016/05/24 15:54:39
Done.
|
| + |
| +An alternative to compiling WebRTC is to install your own version of |
| +Protocol Buffers and the `protoc`, the Protocol Buffer compiler. On |
|
ivoc
2016/05/24 11:50:17
"the" should be removed here, so: ...Buffers and '
aleloi
2016/05/24 15:54:39
Done.
|
| +Debian-based systems, it is |
|
ivoc
2016/05/24 11:50:17
Again, too linux/debian specific. Would remove: On
aleloi
2016/05/24 15:54:39
Done.
|
| + |
| + sudo apt-get install protobuf-compiler python-protobuf |
| + |
| +If you use your own version of protobuf, generate the python file in |
| +this folder with |
| + |
| + protoc -I $WEBRTC_ROOT/webrtc/call $WEBRTC_ROOT/webrtc/call/rtc_event_log.proto --python-out ./ |
| + |