1426150 - Document health ping sendFailure keys

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Chris H-C :chutten|PTO (back July 13)]

The codes I added for bug 1367110 are rather opaque if you weren't the one who implemented them. Document them.

Proposed text:

eOK: No error.
eUnreachable: The remote server was unreachable.
eChannelOpen: The connection failed when we tried to open the channel.
eRedirect: The connection failed in some way during a redirect.
abort: The same thing as a normal XHR's `abort`: https://developer.mozilla.org/en-US/docs/Web/Events/abort
timeout: The same thing as a normal XHR's `timeout`: https://developer.mozilla.org/en-US/docs/Web/Events/timeout

Comment 1

[Chris H-C :chutten|PTO (back July 13)]

Attachment: bug 1426150 - Augment in-tree docs for health ping sendFailure keys.

The codes by themselves are rather opaque. Adding a short descriptor ought to
help with comprehension.

Review commit: https://reviewboard.mozilla.org/r/214292/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/214292/

Comment 2

[Alessio Placitelli [:Dexter]]

Comment on attachment 8943953 [details]
bug 1426150 - Augment in-tree docs for health ping sendFailure keys.

https://reviewboard.mozilla.org/r/214292/#review220168

Looks good. Just one nit below.

::: toolkit/components/telemetry/docs/data/health-ping.rst:84
(Diff revision 1)
> -* "eOK"
> -* "eRequest"
> -* "eUnreachable"
> -* "eChannelOpen"
> -* "eRedirect"
> -* "abort"
> +* "eOK" - No error.
> +* "eRequest" - There was some error in the request before we started to service it.
> +* "eUnreachable" - The remote server was unreachable.
> +* "eChannelOpen" - The connection failed when we tried to open the channel.
> +* "eRedirect" - The connection failed when being redirected.
> +* "abort" - What XMLHttpRequest means by "abort" (see https://developer.mozilla.org/en-US/docs/Web/Events/abort)

nit: can we make this and the one below a link?

```
(see `MDN <https://developer.mozilla.org/en-US/docs/Web/Events/abort>`_)
```

Comment 3

[Chris H-C :chutten|PTO (back July 13)]

Comment on attachment 8943953 [details]
bug 1426150 - Augment in-tree docs for health ping sendFailure keys.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/214292/diff/1-2/

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5639bfbf4a00
Augment in-tree docs for health ping sendFailure keys. r=Dexter

Comment 5

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/5639bfbf4a00