ripe.atlas.tools 3.0.1

Full Documentation

Everything is up on ReadTheDocs

How Does it Work?

Presently, the setup is pretty crude. You can create a ping or traceroute measurement with limited options from the command line:

$ ripe-atlas measure ping --target example.com

# or you can omit --target for most measurement types
$ ripe-atlas measure ping example.com

$ ripe-atlas measure ping --packets 7 --size 42 --target example.com

$ ripe-atlas measure traceroute --target example.com

$ ripe-atlas measure traceroute --packets 2 --target example.com

$ ripe-atlas measure dns --query-argument example.com

# or you can omit --query-argument for DNS measuremetns
$ ripe-atlas measure dns example.com

$ ripe-atlas measure dns --use-probe-resolver --query-type AAAA --query-argument example.com

This will create a one-off measurement and then wait for the results to roll in, formatting them as they do.

You can also use it to connect to a stream of formatted data. This command will start streaming out all of the results from one of our oldest measurements:

$ ripe-atlas stream 1001

Or you can generate a simple report:

$ ripe-atlas report 1001

Configuration is done by way of a config file, and modifying it can be done from the command line:

$ ripe-atlas configure --set authorisation.create=MY_API_KEY

Can I Contribute?

Absolutely. Please read our guide on how to contribute.

Colophon

This project was code-named by means of a poll. In order to conform to the RIPE Atlas theme, it had to be named for an explorer, and so the winning suggestion was for Magellan, “in memory of those times when RTT was ~3 years”.

3.0.1 (release 2022-02-24)

• Updated cousteau dependency to the non-alpha release

3.0.0 (release 2022-02-23)

• API keys can now be passed in environment variables

• probe-search by –location now works, as long as the user specifies their own Google Geocoding API key

• Modernized tests and switched to GitHub actions

• The default renderer for ping measurements is now more consistent and more similar to other ping tools, including having a statistical summary at the end

• measure, report and stream commands now all use the same set of renderers

• “measure spec” command which takes a JSON blob to create measurements

• Allow measure –target to be specified as a positional arg (or –query-argument for DNS)

• Move to latest cousteau version (python-socketio)

• Various other fixes to code and documentation

• Official supported Python versions changed to 3.6, 3.7, 3.8, 3.9 and 3.10

2.3.0 (released 2018-11-23)

2.2.3 (released 2017-01-17)

Bug Fixes

• Fix for distribution issues that prevented the command-line scripts from working

2.2.2 (released 2017-10-12)

Features and changes

• Align various option defaults, minimums and maximums with API reality, including…

• … allow the set of options necessary for “TCP ping” measurements https://labs.ripe.net/Members/wilhelm/measuring-your-web-server-reachability-with-tcp-ping

• Add compact DNS results renderer

• Fix some unicode output issues

2.1 (released 2016-04-21)

2.0.2 (released 2016-10-21)

2.0.1 (released 2016-04-20)

Changes

• Corrected references in the docs to obsolete command names.

• Fixed broken 2.0.0 egg.

2.0.0 (released 2016-04-20)

Changes

• Renamed and merged some commands for clarity, preserving the old names as deprecated aliases.

• Improved help text and usage output.

• Support for bash auto-completion.

1.2.3 (released 2016-03-08)

Changes

• Usage of newest Cousteau/Sagan library.

• Support of API keys for fetching results on report command.

• Default radius for probes filtering is changed to 15.

• Several changes for supporting Windows.

1.2.2 (released 2016-01-13)

New Features

• Cleaner and more consistent implementation of the renderer plugable architecture.

• Usage of newest Cousteau library.

1.2.1 (released 2015-12-15)

Bug Fixes

• Restored some required template files.

1.2.0 (released 2015-12-15)

Output Changes

• #119: Support HTTP results.

• #122: Allow packagers to set the user agent.

1.1.1 (released 2015-11-25)

1.1.0 (released 2015-11-12)

1.0.0 (released 2015-11-02)

• Initial release.