Instrument non-UI telemetry probes #158

biancadanforth · 2018-10-09T21:03:01Z

This issue covers instrumenting all non-UI probes. The probes list was generated from METRICS.md (#134).

Events:

detect_price_change
badge_toolbar_button
send_notification
- Add an additional key to probe and METRICS.md for price_last_high
- Update the open_external_page for element of 'system_notification' to add this key and update the doc.
attempt_extraction (see discussion in Add probes for extraction failure #125)
complete_extraction (see discussion in Add probes for extraction failure #125)

The text was updated successfully, but these errors were encountered:

muccimoz · 2018-10-16T21:13:23Z

Being moved to Reserve Backlog to make room Issue #166

* Add `price_prev` extra key for `detect_price_change` event. This will be the same value as `price_orig` if there is only one price entry for the product when updating prices. This will help us answer questions around how much prices change in addition to how frequently. * Update the name of the extension in METRICS.md to Price Wise. * Add Appendix B to METRICS.md which explains how to view recorded telemetry events in about:telemetry.

Add 'detect_price_change' probe * Add `price_prev` extra key for `detect_price_change` event. This will be the same value as `price_orig` if there is only one price entry for the product when updating prices. This will help us answer questions around how much prices change in addition to how frequently. Additionally: * Update the name of the extension in METRICS.md to Price Wise. * Add Appendix B to METRICS.md which explains how to view recorded telemetry events in about:telemetry.

Add badge_toolbar_button and send_notification probes: * Add an additional extra key, 'price_last_high' to 'send_notification' and 'open_external_page' (with 'element' value of 'system_notification') and update METRICS.md. * Add a 'sendTelemetry' flag for the 'sendProductToBackground' function to also be removed when the 'resend' code is removed in './src/extraction/index.js'. * Due to the fix for Issue mozilla#192, I was seeing some extra 'badge_toolbar_button' events (with 'badge_type' of 'add') as we are resending extracted product information 5 and 10 seconds after the product page loads. * Update METRICS.md to clarify when 'badge_toolbar_button' with a 'badge_type' of 'price_alert' fires, since it will continue to fire for the same price alert until that alert is dismissed which is not obvious.

…robes * Update 'method' extra key for 'complete_extraction' event to have values of 'fathom', 'css_selectors', 'open_graph' or 'none' to distinguish between the two fallback extraction methods to Fathom: CSS Selectors or Open Graph attributes. * Note: Since none of our five supported sites use Open Graph attributes currently for product information, we should not expect to see any successful extraction using that method for the MVP. * Important caveats for making conclusions using these probes as-is: * The coverage values that these probes will suggest will not be very accurate initially until we ensure we are extracting on only **product pages** for a supported site, rather than any page on the site (see Issues mozilla#225 and mozilla#181). * Successful extraction does not mean that the information extracted for the product is correct. It only means that _a_ value was extracted for each product feature (i.e. title, image and price) on the page.