Ethr

Ethr — это кроссплатформенный инструмент для измерения производительности сети, написанный на Go. Цель этого проекта — предоставить нативный инструмент для всестороннего измерения производительности сети: пропускной способности, количества соединений/с, пакетов/с, задержки, потерь и джиттера — для нескольких протоколов, таких как TCP, UDP, HTTP, HTTPS, и для нескольких платформ, таких как Windows, Linux и другие Unix-системы.

Сервер Ethr в действии

Ethr черпает вдохновение в существующих инструментах с открытым исходным кодом для измерения производительности сети и развивает их идеи. Для измерения пропускной способности он похож на iPerf3 для TCP- и UDP-трафика. iPerf3 имеет гораздо больше возможностей, таких как тестирование с ограничением скорости и более богатый набор функций, в то время как Ethr поддерживает несколько потоков, что позволяет масштабироваться до 1024 или даже большего числа соединений, нескольким клиентам одновременно взаимодействовать с одним сервером и т. д. Для измерения задержки он похож на latte в Windows или sockperf в Linux.

По сравнению с другими инструментами Ethr предоставляет больше измерений: например, он измеряет пропускную способность, количество соединений/с, количество пакетов/с, задержку и задержку установки TCP-соединения — всё в одном инструменте. В будущем планируется добавить новые функции (в надежде на вклад сообщества), а также расширить поддержку протоколов, чтобы сделать инструмент комплексным для измерения производительности сети.

Благодаря Go, Ethr является нативно кроссплатформенным, в отличие от компиляции через уровень абстракции, такой как cygwin, который может ограничивать функциональность. Проект стремится унифицировать измерение производительности, объединив функциональность таких инструментов, как iPerf3, ntttcp, psping, sockperf и latte, и предложив единый инструмент для нескольких платформ и нескольких протоколов.

Установка

Загрузка

https://github.com/Microsoft/ethr/releases/latest

Linux

wget https://github.com/microsoft/ethr/releases/latest/download/ethr_linux.zip
unzip ethr_linux.zip

Windows Powershell

wget https://github.com/microsoft/ethr/releases/latest/download/ethr_windows.zip -OutFile ethr_windows.zip
Expand-Archive .\ethr_windows.zip -DestinationPath .

OSX

wget https://github.com/microsoft/ethr/releases/latest/download/ethr_osx.zip
unzip ethr_osx.zip

Сборка из исходного кода

Примечание: для сборки из исходного кода требуется Go версии 1.11 или выше.

Для управления зависимостями Ethr мы используем go-module. Для получения дополнительной информации, пожалуйста, ознакомьтесь с правилами использования go-modules!

git clone https://github.com/Microsoft/ethr.git
cd ethr
go build

Если репозиторий ethr клонирован в дерево $GOPATH/src, убедитесь, что вы вызываете команду go с параметром GO111MODULE=on!

Docker

Соберите образ с помощью команды:

docker build -t microsoft/ethr .

Создайте исполняемый файл:

Linux

docker run -e GOOS=linux -v $(pwd):/out microsoft/ethr make build-docker

Windows

docker run -e BINARY_NAME=ethr.exe -e GOOS=windows -v $(pwd):/out microsoft/ethr make build-docker

OS X

docker run -e BINARY_NAME=ethr -e GOOS=darwin -v $(pwd):/out microsoft/ethr make build-docker

Использование go get

go get github.com/microsoft/ethr

Использование ArchLinux AUR

Предполагая, что вы используете yay (https://github.com/Jguer/yay):

yay -S ethr

Публикация пакета Nuget

Следуйте разделу «Сборка из исходного кода», чтобы собрать ethr.exe.

Измените ethr.nuspec, чтобы добавить новую версию релиза.

vim ethr.nuspec

Создайте пакет nuget (например, Ethr.0.2.1.nupkg)

nuget.exe pack ethr.nuspec

Загрузите пакет на nuget.org.

Использование

Простое использование

Справка:

ethr -h

Сервер:

ethr -s

Сервер с текстовым интерфейсом:

ethr -s -ui

Клиент:

ethr -c <server ip>

Примеры:

// Start server
ethr -s

// Start client for default (bandwidth) test measurement using 1 thread
ethr -c localhost

// Start bandwidth test using 8 threads
ethr -c localhost -n 8

// Start connections/s test using 64 threads to server 10.1.0.11
ethr -c 10.1.0.11 -t c -n 64

// Run Ethr server on port 9999
./ethr -s -port 9999

// Measure TCP connection setup latency to ethr server on port 9999
// Assuming Ethr server is running on server with IP address: 10.1.1.100
./ethr -c 10.1.1.100 -p tcp -t pi -d 0 -4 -port 9999

// Measure TCP connection setup latency to www.github.com at port 443
./ethr -x www.github.com:443 -p tcp -t pi -d 0 -4

// Measure TCP connection setup latency to www.github.com at port 443
// Note: Here port 443 is driven automatically from https
./ethr -x https://www.github.com -p tcp -t pi -d 0 -4

// Measure ICMP ping latency to www.github.com
sudo ./ethr -x www.github.com -p icmp -t pi -d 0 -4

// Run measurement similar to mtr on Linux
sudo ./ethr -x www.github.com -p icmp -t mtr -d 0 -4

// Measure packets/s over UDP by sending small 1-byte packets
./ethr -c 172.28.192.1 -p udp -t p -d 0

Известные проблемы и требования

Windows

Для тестов, связанных с ICMP, таких как Ping, TraceRoute и MyTraceRoute, Windows требует разрешить ICMP через брандмауэр. Это можно сделать в PowerShell с помощью следующих команд. Однако используйте это только в том случае, если это допускает политика безопасности вашей системы.

// Allow ICMP packets via Firewall for IPv4
New-NetFirewallRule -DisplayName "ICMP_Allow_Any" -Direction Inbound -Protocol ICMPv4 -IcmpType Any -Action Allow  -Profile Any -RemotePort Any

// Allow ICMP packets via Firewall for IPv6
New-NetFirewallRule -DisplayName "ICMPV6_Allow_Any" -Direction Inbound -Protocol ICMPv6 -IcmpType Any -Action Allow  -Profile Any -RemotePort Any

Кроме того, для TraceRoute и MyTraceRoute на основе TCP требуется режим администратора, иначе Ethr не сможет получать сообщения ICMP о превышении TTL.

Linux

Для ICMP Ping, ICMP/TCP TraceRoute и MyTraceRoute требуется привилегированный режим через sudo.

Полная командная строка

Общие параметры

	-h 
		Help
	-no 
		Disable logging to file. Logging to file is enabled by default.
	-o <filename>
		Name of log file. By default, following file names are used:
		Server mode: 'ethrs.log'
		Client mode: 'ethrc.log'
	-debug 
		Enable debug information in logging output.
	-4 
		Use only IP v4 version
	-6 
		Use only IP v6 version

Параметры режима сервера

In this mode, Ethr runs as a server, allowing multiple clients to run
performance tests against it.
	-s 
		Run in server mode.
	-ip <string>
		Bind to specified local IP address for TCP & UDP tests.
		This must be a valid IPv4 or IPv6 address.
		Default: <empty> - Any IP
	-port <number>
		Use specified port number for TCP & UDP tests.
		Default: 8888
	-ui 
		Show output in text UI.

Параметры режима клиента

In this mode, Ethr client can only talk to an Ethr server.
	-c <server>
		Run in client mode and connect to <server>.
		Server is specified using name, FQDN or IP address.
	-b <rate>
		Transmit only Bits per second (format: <num>[K | M | G])
		Only valid for Bandwidth tests. Default: 0 - Unlimited
		Examples: 100 (100bits/s), 1M (1Mbits/s).
	-cport <number>
		Use specified local port number in client for TCP & UDP tests.
		Default: 0 - Ephemeral Port
	-d <duration>
		Duration for the test (format: <num>[ms | s | m | h]
		0: Run forever
		Default: 10s
	-g <gap>
		Time interval between successive measurements (format: <num>[ms | s | m | h]
		Only valid for latency, ping and traceRoute tests.
		0: No gap
		Default: 1s
	-i <iterations>
		Number of round trip iterations for each latency measurement.
		Only valid for latency testing.
		Default: 1000
	-ip <string>
		Bind to specified local IP address for TCP & UDP tests.
		This must be a valid IPv4 or IPv6 address.
		Default: <empty> - Any IP
	-l <length>
		Length of buffer to use (format: <num>[KB | MB | GB])
		Only valid for Bandwidth tests. Max 1GB.
		Default: 16KB
	-n <number>
		Number of Parallel Sessions (and Threads).
		0: Equal to number of CPUs
		Default: 1
	-p <protocol>
		Protocol ("tcp", "udp", "http", "https", or "icmp")
		Default: tcp
	-port <number>
		Use specified port number for TCP & UDP tests.
		Default: 8888
	-r 
		For Bandwidth tests, send data from server to client.
	-t <test>
		Test to run ("b", "c", "p", "l", "cl" or "tr")
		b: Bandwidth
		c: Connections/s
		p: Packets/s
		l: Latency, Loss & Jitter
		pi: Ping Loss & Latency
		tr: TraceRoute
		mtr: MyTraceRoute with Loss & Latency
		Default: b - Bandwidth measurement.
	-tos 
		Specifies 8-bit value to use in IPv4 TOS field or IPv6 Traffic Class field.
	-w <number>
		Use specified number of iterations for warmup.
		Default: 1
	-T <string>
		Use the given title in log files for logging results.
		Default: <empty>

Параметры внешнего режима

In this mode, Ethr talks to a non-Ethr server. This mode supports only a
few types of measurements, such as Ping, Connections/s and TraceRoute.
	-x <destination>
		Run in external client mode and connect to <destination>.
		<destination> is specified in URL or Host:Port format.
		For URL, if port is not specified, it is assumed to be 80 for http and 443 for https.
		Example: For TCP - www.microsoft.com:443 or 10.1.0.4:22 or https://www.github.com
		         For ICMP - www.microsoft.com or 10.1.0.4
	-cport <number>
		Use specified local port number in client for TCP & UDP tests.
		Default: 0 - Ephemeral Port
	-d <duration>
		Duration for the test (format: <num>[ms | s | m | h]
		0: Run forever
		Default: 10s
	-g <gap>
		Time interval between successive measurements (format: <num>[ms | s | m | h]
		Only valid for latency, ping and traceRoute tests.
		0: No gap
		Default: 1s
	-ip <string>
		Bind to specified local IP address for TCP & UDP tests.
		This must be a valid IPv4 or IPv6 address.
		Default: <empty> - Any IP
	-n <number>
		Number of Parallel Sessions (and Threads).
		0: Equal to number of CPUs
		Default: 1
	-p <protocol>
		Protocol ("tcp", or "icmp")
		Default: tcp
	-t <test>
		Test to run ("c", "cl", or "tr")
		c: Connections/s
		pi: Ping Loss & Latency
		tr: TraceRoute
		mtr: MyTraceRoute with Loss & Latency
		Default: pi - Ping Loss & Latency.
	-tos 
		Specifies 8-bit value to use in IPv4 TOS field or IPv6 Traffic Class field.
	-w <number>
		Use specified number of iterations for warmup.
		Default: 1
	-T <string>
		Use the given title in log files for logging results.
		Default: <empty>

Статус

Поддержка платформ

Windows

Протестировано: Windows 10, Windows 7 SP1

Не протестировано: другие версии Windows

Linux

Протестировано: Ubuntu Linux 18.04.1 LTS, OpenSuse Leap 15

Не протестировано: другие версии Linux

OSX

Протестировано: OSX протестирован участниками проекта

Другие

В настоящее время другие платформы не тестировались.

Список задач

Ниже приведены пункты списка задач. Мы будем особенно рады вкладу в эти пункты, а также в любые другие функции и исправления ошибок.

Протестировать Ethr на других версиях Windows, других версиях Linux, FreeBSD и других ОС
Поддержка задержки UDP, TraceRoute и MyTraceRoute

Участие в разработке

Этот проект приветствует вклад и предложения. Для большинства вкладов требуется согласие с Лицензионным соглашением участника (CLA), подтверждающим, что вы имеете право и действительно предоставляете нам права на использование вашего вклада. Подробности см. на https://cla.microsoft.com.

Когда вы отправляете pull request, CLA-бот автоматически определит, нужно ли вам предоставить CLA, и соответствующим образом оформит PR (например, ярлык, комментарий). Просто следуйте инструкциям, предоставленным ботом. Вам нужно будет сделать это только один раз во всех репозиториях, использующих наше CLA.

Этот проект принял Правила поведения для проектов с открытым исходным кодом Microsoft. Для получения дополнительной информации см. Часто задаваемые вопросы о правилах поведения или свяжитесь с [email protected] по любым дополнительным вопросам или комментариям.

TCP	Да	Да	Н/Д	Да	Да	Да	Да
UDP	Да	Н/Д	Да	Нет	Н/Д	Нет	Нет
ICMP	Нет	Н/Д	Н/Д	Н/Д	Да	Да	Да

ethr

Популярное

Ethr

Установка

Загрузка

Сборка из исходного кода

Docker

Использование go get

Использование ArchLinux AUR

Публикация пакета Nuget

Использование

Простое использование

Известные проблемы и требования

Windows

Linux

Полная командная строка

Общие параметры

Параметры режима сервера

Параметры режима клиента

Параметры внешнего режима

Статус

Поддержка платформ

Список задач

Участие в разработке