Network measurement engine
| branch | Unix | coverage | Windows |
|---|---|---|---|
| master |  |
 |
 |
Measurement Kit is a library that implements open network measurement methodologies (performance, censorship, etc.) for Android, iOS, Windows, macOS, and Linux systems.
It is meant to be embedded by third party applications with specific network measurement needs and/or to be used by researchers as a basis to implement novel tools.
Please, refer to the include/measurement_kit folder documentation for an up-to-date list of available tests.
Measurement Kit exposes a simple C-like API that is described in detail in the include/measurement_kit folder documentation. You can find examples of usage of such API into the example folder.
You need to have the autotools, a C++14 capable C++ compiler, a C++14 capable C++ library, a C11 capable C compiler, and all the dependencies installed. For current information, we encourage you to read the very simple build script that we use on Travis CI to setup a Unix environment, from which you can gather up-to-date information regarding required packages on a Debian like system. To this end, please refer to the content of the .ci/travis folder.
With all the dependencies statisfied, build with:
./autogen.sh
./configure
make
sudo make install # optional, if you want to install to `/usr/local`
sudo /sbin/ldconfig # required only on Linux if you install
The configure script will also provide advice if a dependency is missing. Also,
./configure --help can be useful.
Please check the measurement-kit/homebrew-measurement-kit tap for Homebrew.
We (cross) compile binaries for Windows using the Mingw-w64 compiler distribution. The scripts we use to do that are also part of the measurement-kit/homebrew-measurement-kit tap for Homebrew.
We also build MK using Mingw-w64 on Windows when running AppVeyor integration tests. To see how we do that, please check the .ci/appveyor folder.
For cross-compiling Measurement Kit for Android, please refer to the measurement-kit/homebrew-measurement-kit repository. For integrating Measurement Kit cross-compiled for Android with Java classes that you can use from Android, please see measurement-kit/android-libs. For how to use Measurement Kit in an Android project, please see measurement-kit/android-example.
For cross-compiling Measurement Kit for iOS, please refer to the measurement-kit/homebrew-measurement-kit repository. For integrating Measurement Kit cross-compiled for iOS into a framework that you can use from iOS, please see measurement-kit/mkall-ios. For how to use Measurement Kit in an iOS project, please see measurement-kit/ios-example.
To clone Measurement Kit repository, do:
git clone --recursive https://github.com/measurement-kit/measurement-kit
See CONTRIBUTING.md for more information.