Files
tubestation/toolkit/components/telemetry/docs/internals/pingsender.rst
Gabriele Svelto 13e3767437 Bug 1310703 - Introduce the pingsender executable; r=ted
MozReview-Commit-ID: 2SEwwGywahQ
2017-01-16 17:39:22 +01:00

23 lines
1.1 KiB
ReStructuredText

Ping Sender
===========
The ping sender is a minimalistic program whose sole purpose is to deliver a
telemetry ping. It accepts a single parameter which is the URL the ping will
be sent to (as an HTTP POST command) and once started it will wait to read the
ping contents on its stdin stream. Once the ping has been read from stdin the
ping sender will try to post it once, exiting with a non-zero value if it
fails.
The ping sender relies on libcurl for Linux and Mac build and on WinInet for
Windows ones for its HTTP functionality. It currently ignores Firefox or the
system proxy configuration.
In non-debug mode the ping sender doesn't print anything, not even on error,
this is done deliberately to prevent startling the user on architectures such
as Windows that would open a seperate console window just to display the
program output. If you need runtime information to be printed out compile the
ping sender with debuggging enabled.
The pingsender is not supported on Firefox for Android at the moment
(see `bug 1335917 <https://bugzilla.mozilla.org/show_bug.cgi?id=1335917>`_)