Better understand your network routing, fix anycast issues, monitor your CDN and DNS performance,
do uptime monitoring and build your own network tools for personal or public use.

Our project is under active development and not yet ready for production use. But we welcome everyone to contribute:

• Ideas for new features
• PRs and fixes for existing problems
• Quality control and testing of all systems. Report any problems, bugs or bad UX you find
• Documentation. Our readme and documentation need some polish
• Tutorials and articles. Consider writing about our project on your blog or twitter

Globalping is a platform that allows anyone to run networking commands such as ping, traceroute, dig and mtr on probes distributed all around the world. Our goal is to provide a free and simple API for everyone out there to build interesting networking tools and services.

We don't expect most of our users to work with the API directly; instead, we constantly expand and improve our powerful yet simple tools that take full advantage of all the functionality that the Globalping API has to offer. If you're an advanced user, we recommend getting started with the Globalping CLI, or if you prefer a visual representation of the data then our web-tools might be a better place to get started.

Learn more about Globalping on our website www.jsdelivr.com/globalping

You can begin using the platform in a few different ways:

We keep building more and more web tools to cover all kinds of use-cases.

• TODO
• TODO

Simply install our CLI tool to upgrade your debugging capabilities.

#add repo
yum install globalping-cli

And then run your tests in a familiar way:

globalping traceroute google.com --from "Western Europe" --limit "10"
#output

Learn more about Globalping CLI in the dedicated repo.

If you're building something custom or simply want to learn more about all the available options and data we provide check out the Globalping REST API. It's as simple as:

POST https://api.globalping.io/v1/measurements/
{
    "limit": 10,
    "locations": [],
    "target": "jsdelivr.com",
    "type": "ping",
    "measurementOptions": {
        "packets": 5
    }
}

Read the full API documentation

Install our Slack App to interact with the Globalping platform without ever leaving Slack. Allow your NOC, OPS and Support teams to quickly debug networking issues and discuss the results.

It supports a human friendly interface for issuing commands. To begin simply type /globalping help.

Examples:

/globalping {command} {target} from {location} --limit {number of probes}
/globalping ping 8.8.8.8 from Germany
/globalping traceroute jsdelivr.com from South America --limit 2
/globalping help

The location field can process all kinds of different types of location matching, including continents, regions, countries, cities, US states and ASNs. ASNs must be prefixed by "AS", e.g. from AS80085. You can also combine filters, e.g. from hetzner+Finland will ensure the results come from a probe that matches both parameters. Providing no location will default to "world" which will match a probe from a random location in the world.

Our GitHub bot can by triggered by simply mentioning it in any public GitHub issue. It supports a human friendly format of issuing commands.

Examples:

@globalping ping 8.8.8.8 from Germany
@globalping traceroute jsdelivr.com from South America limit 2

At the moment only ping and traceroute commands are supported. The location field can process all kinds of different types of location matching, including continents, regions, countries, cities, US states and ASNs. ASNs must be prefixed by "AS", e.g. from AS80085

Globalping relies on the community to help us expand our network of probes. So while we run our own probes in key locations we still need help from both corporate partners and individials. Consider joining our network and helping everyone by running a probe (or many). You can do it on a rented VPS or Dedicated server that has available capacity or even on a locally hosted Raspberry pi. The only requirement is having an internet accessible device able to run docker containers.

It's as simple as running this command:

docker run -d --network host --restart=always --name globalping-probe ghcr.io/jsdelivr/globalping-probe

And it works for both x86 and ARM architectures.

Notes:

• The probe doesn't open any ports or accept any incoming connections. It can only establish a connection with our API.
• We include regularly updated lists and databases of domains and IPs that are associated with malware or potentially dangerous content and completely ban them on the API level
• The tests scale to the amount of available CPU cores. Our code is very lightweight and shouldn't use too many of your resources, so in most cases we recommend running our probe as is. But if you're worried you can use --cpuset-cpus="0-2" to limit the number of available cores.
• We rate-limit all users on the API level to avoid the abuse of network
• No local network tests are allowed, only public endpoints.

Read more about the Globalping Probe in the dedicated repo.

Our platform has multiple limits to avoid abusive behaviour and at the same time motivate people to contribute to the sustainability of our platform.

These limits are applied per IP address regardless if an API key supplied or not.

• 100 POST requests per minute per IP. No GET limits are implemented to support "real-time" use-cases.
• A single measurement is limited to 200 probes per location and 500 total probes
• other?

Anybody can connect to our API and start using it with no credentials required. In this case we limit the amount of tests an IP address can run. A single test is defined as a succesful measurement we run and return to the user. A limit of 10 tests means the user can run either 10 measurements with the probe limit set to 1 per measurement, or a single measurement with the probe limit set to 10.

• 100 tests per hour
• other?

All registered jsDelivr users get an API key they can use to authenticate themselves and get higher limits

• 200 measurements per hour

By becoming a sponsor of jsDelivr you automatically help us sustain both the jsDelivr CDN and the Globalping platform. Your contributions will be used to help us continue the development of all projects under the jsDelivr Organization

You can do this by registering on jsdelivr.com and becoming a GitHub sponsor. We will then automatically upgrade your account to get a higher limit as defined in each of the available plans.

Feel free to reach out if you need a custom limit for your API key. We're more than happy to provide higher limits to researchers, non-profits and other open source projects.

In order to run the Globalping API locally you will need Node.js 16 and Redis with RedisJSON module. You will also need to run a development instance of the Globalping Probe at the same time when testing.

API uses 3000 port by default. This can be overridden by PORT environment variable.

1. Clone this repository.
2. docker-compose up -d - Run Redis
3. npm install && npm run init:hooks
4. Either npm run build && FAKE_PROBE_IP=1 npm run dev or FAKE_PROBE_IP=1 npm run dev:tsx (no type-checking)

Once the API is live, you can spin up a probe instance by running the following in the probe repository:

1. Clone Globalping Probe repository.
2. npm install && npm run init:hooks
3. npm run build && NODE_ENV=development node dist/index.js

FAKE_PROBE_IP=1 environment variable can be used to make debug easier. When defined, every Probe that connects to the API will get an IP address from the list of predefined "real" addresses.