Data Collection

This document describes the types of data that Shield collects.

Uptake

Shield monitors the execution of recipes and reports to Firefox Telemetry the amount of successful and failed runs. This data is reported using Uptake Telemetry under the shield-recipe-client namespace.

Runner Status

Once per-fetch and execution of recipes, one of the following statuses is reported under the key shield-recipe-client/runner:

RUNNER_INVALID_SIGNATURE

Shield failed to verify the signature of the fetched recipes.

RUNNER_NETWORK_ERROR

There was a network-related error while fetching recipes.

RUNNER_SERVER_ERROR

The data returned by the server when fetching the recipe is invalid in some way.

RUNNER_SUCCESS

The operation completed successfully. Individual failures with actions and recipes may have been reported separately.

Action Status

For each action available from the Shield service, one of the following statuses is reported under the key shield-recipe-client/action/<action name>:

ACTION_NETWORK_ERROR

There was a network-related error while fetching actions

ACTION_PRE_EXECUTION_ERROR

There was an error while running the pre-execution hook for the action.

ACTION_POST_EXECUTION_ERROR

There was an error while running the post-execution hook for the action.

ACTION_SERVER_ERROR

The data returned by the server when fetching the action is invalid in some way.

ACTION_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 shield-recipe-client/recipe/<recipe id>:

RECIPE_ACTION_DISABLED

The action for this recipe failed in some way and was disabled, so the recipe could not be executed.

RECIPE_EXECUTION_ERROR

An error occurred while executing the recipe.

RECIPE_INVALID_ACTION

The action specified by the recipe was invalid and it could not be executed.

RECIPE_SUCCESS

The recipe was executed successfully.