<commit_before>###########
fastd-probe
###########
A fastd_ probing machinery based on gevent_.


************
Introduction
************

Goals
=====
- Conveniently test network connectivity through a fastd tunnel.
- Act as a foundation for different kinds of network probes.

Features
========
- Quick fastd tunnel setup and teardown in less than a second.
- Optionally use the `List of RIPE Atlas Anchors`_ as targets for ping probes,
  see also `Checking your Internet Connectivity with RIPE Atlas Anchors`_.
- Evaluate probe results and panics at an threshold of 75% or more errors.

.. _fastd: https://fastd.readthedocs.io/
.. _gevent: http://www.gevent.org
.. _List of RIPE Atlas Anchors: https://atlas.ripe.net/anchors/list/
.. _Checking your Internet Connectivity with RIPE Atlas Anchors: https://labs.ripe.net/Members/stephane_bortzmeyer/checking-your-internet-connectivity-with-ripe-atlas-anchors


********
Synopsis
********
::

    time sudo fastd-probe

Please also have a look at the provided example configuration file "`fastd-probe.example.ini`_".

.. _fastd-probe.example.ini: https://github.com/fastd-monitor/fastd-probe/blob/master/fastd-probe.example.ini


********
Examples
********
These two examples demonstrate a "success" and a "failure" case.
Both use a ping probe configured with ``targets = RIPE-ATLAS-ANCHORS``,
checking connectivity against all 228 RIPE Atlas Anchors as of 2016-11-20.

----

.. figure:: https://asciinema.org/a/93575.png
    :alt: fastd-probe success
    :target: https://asciinema.org/a/93575

    fastd-probe success: https://asciinema.org/a/93575

----

.. figure:: https://asciinema.org/a/93576.png
    :alt: fastd-probe failure
    :target: https://asciinema.org/a/93576

    fastd-probe failure: https://asciinema.org/a/93576
<commit_msg>Minor doc update again<commit_after>###########
fastd-probe
###########
A fastd_ probing machinery based on gevent_.


************
Introduction
************

Goals
=====
- Conveniently test network connectivity through a fastd tunnel.
- Act as a foundation for different kinds of network probes.

Features
========
- Quick fastd tunnel setup and teardown in less than a second.
- Optionally use the `List of RIPE Atlas Anchors`_ as targets for ping probes,
  see also `Checking your Internet Connectivity with RIPE Atlas Anchors`_.
- Evaluate probe results and panics at an threshold of 75% or more errors.

.. _fastd: https://fastd.readthedocs.io/
.. _gevent: http://www.gevent.org
.. _List of RIPE Atlas Anchors: https://atlas.ripe.net/anchors/list/
.. _Checking your Internet Connectivity with RIPE Atlas Anchors: https://labs.ripe.net/Members/stephane_bortzmeyer/checking-your-internet-connectivity-with-ripe-atlas-anchors


********
Synopsis
********
::

    time sudo fastd-probe

Please also have a look at the provided example configuration file "`fastd-probe.example.ini`_".

.. _fastd-probe.example.ini: https://github.com/fastd-monitor/fastd-probe/blob/master/fastd-probe.example.ini


********
Examples
********
These two examples demonstrate a "success" and a "failure" case.

Both use a ping probe configured with ``targets = RIPE-ATLAS-ANCHORS``,
checking connectivity against all 228 RIPE Atlas Anchors as of 2016-11-20.

----

.. figure:: https://asciinema.org/a/93575.png
    :alt: fastd-probe success
    :target: https://asciinema.org/a/93575

    fastd-probe success: https://asciinema.org/a/93575

----

.. figure:: https://asciinema.org/a/93576.png
    :alt: fastd-probe failure
    :target: https://asciinema.org/a/93576

    fastd-probe failure: https://asciinema.org/a/93576

{'fraction_non_alphanumeric': 0.15191986644407346, 'fraction_numerical': 0.023928770172509738, 'mean_word_length': 3.891156462585034, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3562995', 'n_tokens_mistral': 1258, 'n_tokens_neox': 1157, 'n_words': 333}