Bug 1543817: Document different Normandy uptake telemetry values r=mythmon
authorEthan Glasser-Camp <ethan@betacantrips.com>
Mon, 15 Apr 2019 21:41:30 +0000
changeset 469591 be3f40425b52
parent 469590 2f68e9e0c239
child 469606 a83cab75b00d
child 469607 38ecdf260ccd
push id35874
push userccoroiu@mozilla.com
push dateTue, 16 Apr 2019 04:04:58 +0000
treeherdermozilla-central@be3f40425b52 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmythmon
bugs1543817
milestone68.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1543817: Document different Normandy uptake telemetry values r=mythmon Depends on D27363 Differential Revision: https://phabricator.services.mozilla.com/D27597
toolkit/components/normandy/docs/data-collection.rst
--- a/toolkit/components/normandy/docs/data-collection.rst
+++ b/toolkit/components/normandy/docs/data-collection.rst
@@ -11,80 +11,125 @@ is reported using :ref:`telemetry/collec
 
 Runner Status
 ^^^^^^^^^^^^^
 Once per-fetch and execution of recipes, one of the following statuses is
 reported under the key ``normandy/runner``:
 
 .. data:: RUNNER_INVALID_SIGNATURE
 
+   :Telemetry value: signature_error
+
    Normandy failed to verify the signature of the fetched recipes.
 
 .. data:: RUNNER_NETWORK_ERROR
 
+   :Telemetry value: network_error
+
    There was a network-related error while fetching recipes.
 
 .. data:: RUNNER_SERVER_ERROR
 
+   :Telemetry value: server_error
+
    The data returned by the server when fetching the recipe is invalid in some
    way.
 
 .. data:: RUNNER_SUCCESS
 
+   :Telemetry value: success
+
    The operation completed successfully. Individual failures with actions and
    recipes may have been reported separately.
 
 Action Status
 ^^^^^^^^^^^^^
 For each action available from the Normandy service, one of the
 following statuses is reported under the key
 ``normandy/action/<action name>``:
 
 .. data:: ACTION_NETWORK_ERROR
 
+   :Telemetry value: network_error
+
    There was a network-related error while fetching actions
 
 .. data:: ACTION_PRE_EXECUTION_ERROR
 
+   :Telemetry value: custom_1_error
+
    There was an error while running the pre-execution hook for the action.
 
 .. data:: ACTION_POST_EXECUTION_ERROR
 
+   :Telemetry value: custom_2_error
+
    There was an error while running the post-execution hook for the action.
 
 .. data:: ACTION_SERVER_ERROR
 
+   :Telemetry value: server_error
+
    The data returned by the server when fetching the action is invalid in some
    way.
 
 .. data:: ACTION_SUCCESS
 
+   :Telemetry value: success
+
    The operation completed successfully. Individual failures with recipes may
    be reported separately.
 
 Recipe Status
 ^^^^^^^^^^^^^
 For each recipe that is fetched and executed, one of the following statuses is
 reported under the key ``normandy/recipe/<recipe id>``:
 
 .. data:: RECIPE_ACTION_DISABLED
 
+   :Telemetry value: custom_1_error
+
    The action for this recipe failed in some way and was disabled, so the recipe
    could not be executed.
 
+.. data:: RECIPE_DIDNT_MATCH_FILTER
+
+   :Telemetry value: backoff
+
+   The recipe included a Jexl filter that the client did not match, so
+   the recipe was not executed.
+
 .. data:: RECIPE_EXECUTION_ERROR
 
+   :Telemetry value: apply_error
+
    An error occurred while executing the recipe.
 
+.. data:: RECIPE_FILTER_BROKEN
+
+   :Telemetry value: content_error
+
+   An error occurred while evaluating the Jexl filter for this
+   recipe. Sometimes this represents a bug in the Jexl filter
+   parser/evaluator, such as in `bug 1477156
+   <https://bugzilla.mozilla.org/show_bug.cgi?id=1477156>`_, or it can
+   represent an error fetching some data that a Jexl recipe needs such
+   as `bug 1447804
+   <https://bugzilla.mozilla.org/show_bug.cgi?id=1447804>`_.
+
 .. data:: RECIPE_INVALID_ACTION
 
+   :Telemetry value: download_error
+
    The action specified by the recipe was invalid and it could not be executed.
 
 .. data:: RECIPE_SUCCESS
 
+   :Telemetry value: success
+
    The recipe was executed successfully.
 
 
 Additionally, Normandy reports a `keyed scalar`_ to measure recipe
 freshness. This scalar is called ``normandy.recipe_freshness``, and it
 corresponds to the ``last_modified`` date of each recipe (using its ID
 as the key), reported as seconds since 1970 in UTC.