The official command line client for RIPE Atlas
Project description
RIPE Atlas Tools (Magellan)
The official command-line client for RIPE Atlas.
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”.
Release History
3.0.2 (release 2022-05-23)
Fix “measure spec” command which was broken due to cousteau issue
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)
Features and changes
Add result date and time to traceroute, NTP and SSL renderers
Add support for specifying measurement tags on measurement creation
Add option (–go-web) to open measurement URL in browser
Nicer presentation of 403 errors from the API
Official supported Python versions changed to 2.7, 3.4, 3.5, 3.6 and 3.7
Bug Fixes
Fix cousteau/sagan dependencies
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)
New Features
Add a simple NTP renderer
Changes
Use new cousteau (1.4) & sagan(1.2) versions.
Bug Fixes
Fix for some unicode problems when using colors
Fix issue #177, with gdbm problem.
2.0.2 (released 2016-10-21)
New Features
Add aliases to measurements IDs
Add –traceroute-show-asns to traceroute renderer
Bug Fixes
Stream command was not passing the correct API key. After API became stricter this command started failing.
Handle missing geometry for probes.
Fix issues for AS-paths with only 1 probe
Various fixes for tests
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
1.1.1 (released 2015-11-25)
Output Changes
#103: Removed header from the report command.
Bug Fixes
#105: Measurement report and stream broken on Python3.4.
1.1.0 (released 2015-11-12)
New features
Support for the creation of NTP, SSLCert, and HTTP measurements.
Additional argument in report command to filter results by probe ASN.
Additional renderer that shows the different destination ASNs and some additional stats about them.
Bug Fixes
Various fixes.
Changes
Better testing.
Additional documentation.
1.0.0 (released 2015-11-02)
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file ripe.atlas.tools-3.0.2-py3-none-any.whl
.
File metadata
- Download URL: ripe.atlas.tools-3.0.2-py3-none-any.whl
- Upload date:
- Size: 119.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b7d55e64af832a0055d8b9e2b74a43b5b0a4a8cf8a0ef393f55480346da7788 |
|
MD5 | e7134a6ce6c3b84469bcd13571cbbe04 |
|
BLAKE2b-256 | 3fbff5d25aaef34ef0f528625e73d3cebf5e0c6bf63b4f9bb037f9ba147cc63b |