Skip to main content

Measure latency using TCP.

Project description

tcp-latency

PyPI - Python Version PyPI PyPI - License Build Status PyPI - Downloads

About

tcp-latency provides an easy way to measure latency using TCP.

Inspired by other similar tools, tcp-latency comes from the need of running network diagnosis/troubleshooting tasks with Python on serverless infrastructure (as many providers don't include ping/ICMP support) but should work too in any other environment with Python>=36.

Features

  • Runs as a command-line tool or inside your code as a module.
  • Custom parameters for a port, runs, timeout and wait time between runs.
  • IPv4 (e.g 52.26.14.11) and domain (e.g google.com) host support.
  • Human readable output when running as a command-line tool.
  • No external dependencies.
  • Small and extensible.

Usage

tcp-latency can be used both as a module and as a standalone script.

Module

>>> from tcp_latency import measure_latency
>>> measure_latency(host='google.com')
[34.57]
>>> measure_latency(host='52.26.14.11', port=80, runs=10, timeout=2.5)
[433.82, 409.21, 409.25, 307.09, 306.64, 409.45, 306.58, 306.93, 409.25, 409.26]

Note: If omitted, measure_latency() arguments use the same defaults that command-line mode.

Command-line

$ tcplatency -h
usage: tcp-latency [-h] [-p [p]] [-t [t]] [-r [r]] [-w [w]] h

Measure latency using TCP.

positional arguments:
  host

optional arguments:
  -h, --help            show this help message and exit
  -p [p], --port [p]    (default: 443)
  -t [t], --timeout [t]
                        (seconds, float, default: 5)
  -r [r], --runs [r]    number of latency points (int, default: 5)
  -w [w], --wait [w]    between each run (seconds, float, default: 1)
$ tcp-latency google.com
tcp-latency google.com
google.com: tcp seq=0 port=443 timeout=5 time=15.16 ms
google.com: tcp seq=1 port=443 timeout=5 time=15.63 ms
google.com: tcp seq=2 port=443 timeout=5 time=14.86 ms
google.com: tcp seq=3 port=443 timeout=5 time=14.76 ms
google.com: tcp seq=4 port=443 timeout=5 time=14.59 ms
--- google.com tcp-latency statistics ---
5 packets transmitted
rtt min/avg/max = 14.76/15.1025/15.63 ms

$ tcp-latency 52.26.14.11 --port 80 --runs 3 --wait 0.5
tcp-latency 52.26.14.11
52.26.14.11: tcp seq=0 port=80 timeout=5 time=230.2 ms
52.26.14.11: tcp seq=1 port=80 timeout=5 time=228.96 ms
52.26.14.11: tcp seq=2 port=80 timeout=5 time=224.51 ms
--- 52.26.14.11 tcp-latency statistics ---
3 packets transmitted
rtt min/avg/max = 228.96/229.57999999999998/230.2 ms

$ tcp-latency google.com -r 1
tcp-latency google.com
google.com: tcp seq=0 port=443 timeout=5 time=34.36 ms
--- google.com tcp-latency statistics ---
1 packets transmitted

Installation

Via pip:

pip install tcp-latency

How to contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug me until it gets merged and published.

Some things that would be great to have:

  • Add transmitted vs received statistics (e.g packet loss)
  • Add bytes information (ping-like)
  • Add support for machine-readable output (JSON,XML,YAML).
  • Add automated releases with TravisCI.
  • Improve test suite.
  • Improve How to contribute information (pyenv, tox, pre-commit...)

Similar tools

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tcp-latency-0.0.12.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

tcp_latency-0.0.12-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file tcp-latency-0.0.12.tar.gz.

File metadata

  • Download URL: tcp-latency-0.0.12.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.9.0b1+

File hashes

Hashes for tcp-latency-0.0.12.tar.gz
Algorithm Hash digest
SHA256 12579351b0852db3a6ddb36f2d8dbd457a21589ee6b1d867fcc12aed8a29097b
MD5 a15803cdf1550062d2cdeda864925782
BLAKE2b-256 5495dd4032a3562690200074bfc3548c07581205ae5e32c79a63b3f4e47c7c60

See more details on using hashes here.

File details

Details for the file tcp_latency-0.0.12-py3-none-any.whl.

File metadata

  • Download URL: tcp_latency-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.9.0b1+

File hashes

Hashes for tcp_latency-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 abfa0bd094e46f6c64272e2cbc0203900594a068f2a12ba8652f4cca6aec9933
MD5 db584ae16c7907089f7d9bdf39961ad3
BLAKE2b-256 a7290b84d37e410f7b157edda2b3fef52b181171272264380c9d18221feaa019

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page