Skip to main content

A command line utility that provides a ping like interface for checking tcp/ssl ports and services

Project description

serviceping

Build Status Coverage Version Downloads Supported Python Versions License Documentation

A utility with a "ping" like interface to ping tcp port services.

Table of Contents

Background

This utility was written to simplify troubleshooting network issues related to talking to network services

Install

To install serviceping, first make sure you are running Python 3.6+, then simply:

pip3 install serviceping

Usage

Serviceping provides a command line interface that operates like the ping command but instead of using icmp packets to check for a response from a host. It can perform a tcp network connection to a port on a host or a http or https get request to check a url on a host.

Since tcp and http requests require multiple operations. Each request performs all of the operations end to end for the request. The serviceping command adds a -d flag that will show timings for the different stages the ping request.

usage: serviceping [-h] [-c COUNT] [-i INTERVAL] [-d] destination [destination ...]
positional arguments:
  destination Destination host or URL

optional arguments:
  -h, --help   show this help message and exit
  -c COUNT     Number of pings to send
  -i INTERVAL  Ping interval
  -d           Show timings for the entire connection

Examples

The serviceping tool uses a syntax that mirrors that of the ping commmand.

Ping port 80 (http) on www.yahoo.com

By pinging www.yahoo.com via http (port 80), we can clearly see the multiple hosts responding and the latency of each request.

$ serviceping www.yahoo.com
SERVICEPING www.yahoo.com:80 (98.139.180.149:80).
from www.yahoo.com:80 (98.139.183.24:80): time=2.46 ms
from www.yahoo.com:80 (98.139.180.149:80): time=2.43 ms
--- www.yahoo.com ping statistics ---
2 packets transmitted, 2 received, 0% packet loss, time 1704.0ms
rtt min/avg/max/dev = 2.43/2.44/2.46/4.00 ms
$

Ping port 4443 (https) on www.yahoo.com

Serviceping can also connect to other ports such as the ssl port (443).

$ serviceping www.yahoo.com:443
SERVICEPING www.yahoo.com:443 (98.139.183.24:443).
from www.yahoo.com:443 (98.139.180.149:443): time=2.89 ms
from www.yahoo.com:443 (98.139.180.149:443): time=2.81 ms
--- www.yahoo.com ping statistics ---
2 packets transmitted, 2 received, 0% packet loss, time 1744.0ms
rtt min/avg/max/dev = 2.81/2.85/2.89/6.08 ms
$

Pinging a URL instead of the port

The serviceping command can also specify send ping requests to a url. If a URL is specified, it will perform an http get request and show the response, which is useful when hosts are doing unexpected things in a dns rotation or behind a reverse proxy or vip.

In this example we specify a url of http://cnn.com/

$ serviceping http://cnn.com/
SERVICEPING cnn.com:80 (157.166.255.18:80).
1500 bytes from cnn.com:80 (157.166.255.19:80):response=200 time=87.14 ms
1448 bytes from cnn.com:80 (157.166.226.25:80):response=200 time=64.82 ms
1500 bytes from cnn.com:80 (157.166.255.19:80):response=200 time=62.98 ms
1500 bytes from cnn.com:80 (157.166.255.19:80):response=200 time=78.30 ms
--- cnn.com ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 4372.0ms
rtt min/avg/max/dev = 62.98/73.31/87.14/56.00 ms
$

The output shows that two hosts are responding to this request, and that they are returning different amounts of data in their responses.

Pinging a URL with timings

The detailed timing flag adds timings for each step of each request, which is useful for determining the causes of latency issues or errors.

Here we are doing the previous example with detailed timings.

$ serviceping -d http://cnn.com/
SERVICEPING cnn.com:80 (157.166.255.19:80).
1386 bytes from cnn.com:80 (157.166.255.19:80):response=200 dns=0.21ms connect=68.36ms request=130.02ms all=198.73ms
1386 bytes from cnn.com:80 (157.166.226.25:80):response=200 dns=0.30ms connect=66.72ms request=101.07ms all=168.20ms
1500 bytes from cnn.com:80 (157.166.255.18:80):response=200 dns=0.30ms connect=123.94ms request=203.08ms all=327.43ms
1386 bytes from cnn.com:80 (157.166.226.26:80):response=200 dns=0.28ms connect=68.32ms request=87.94ms all=156.69ms
--- cnn.com ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 5009.0ms
rtt min/avg/max/dev = 156.69/212.76/327.43/138.24 ms
$

Clearly, the host with address 157.166.255.18 is taking significantly longer to establish the tcp connection and handle the http request.

License

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.

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

serviceping-19.12.163209.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

serviceping-19.12.163209-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file serviceping-19.12.163209.tar.gz.

File metadata

  • Download URL: serviceping-19.12.163209.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.7.5

File hashes

Hashes for serviceping-19.12.163209.tar.gz
Algorithm Hash digest
SHA256 7c7be7780d8bf658da72a4b6b1076579c6843cd26bc5ab2716428de2d5f083b9
MD5 06841f4bb69de534484f7596f434ddc7
BLAKE2b-256 e77e64dc22ce342ee9c1f6e770b3d91380942634e1b3f5e6b2acd4be64512e79

See more details on using hashes here.

File details

Details for the file serviceping-19.12.163209-py3-none-any.whl.

File metadata

  • Download URL: serviceping-19.12.163209-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.7.5

File hashes

Hashes for serviceping-19.12.163209-py3-none-any.whl
Algorithm Hash digest
SHA256 e04e86d0945984b7d2a4a9d1253a62802a8b56e27f3cfec87cb2acad3eafa4dc
MD5 f150fd8ac8ec700d6a503c544626a194
BLAKE2b-256 22c3f9e7dcd046be6ef4eab7cdb072710d1c8e86f4e105381b1e264a9b792081

See more details on using hashes here.

Supported by

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