mozetl.search package

Submodules

mozetl.search.aggregates module

Firefox Desktop Search Count Datasets

This job produces derived datasets that make it easy to explore search count data.

The search_aggregates job is used to populate an executive search dashboard. For more information, see Bug 1381140.

The search_clients_daily job produces a dataset keyed by (client_id, submission_date, search_counts.engine, search_counts.source). This allows for deeper analysis into user level search behavior.

mozetl.search.aggregates.add_derived_columns(exploded_search_counts)

Adds the following columns to the provided dataset:

type: One of ‘in-content-sap’, ‘follow-on’, ‘chrome-sap’,

‘ad-click’ or ‘search-with-ads’.

addon_version: The version of the followon-search@mozilla addon, or None

mozetl.search.aggregates.agg_first(col)

mozetl.search.aggregates.agg_search_data(main_summary, grouping_cols, agg_functions)

Augment, Explode, and Aggregate search data

The augmented and exploded dataset has the same columns as main_summary with the addition of the following:

engine: A key in the search_counts field representing a search engine.

e.g. ‘hoolie’

source: A key in the search_counts field representing a search source

e.g. ‘urlbar’

tagged-sap: Sum of all searches with partner codes from an SAP tagged-follow-on: Sum of all searches with partner codes from a downstream query sap: Sum of all searches originating from a direct user interaction with the Firefox UI addon_version: The version of the followon-search@mozilla.com addon

mozetl.search.aggregates.explode_search_counts(main_summary)

mozetl.search.aggregates.gen_click_command(etl_job)

Wrap an ETL job with click arguements

mozetl.search.aggregates.generate_rollups(submission_date, output_bucket, output_prefix, output_version, transform_func, input_bucket='telemetry-parquet', input_prefix='main_summary/v4', save_mode='error', orderBy=[])

Load main_summary, apply transform_func, and write to S3

mozetl.search.aggregates.get_ad_click_count(ad_click_count)

mozetl.search.aggregates.get_search_addon_version(active_addons)

mozetl.search.aggregates.get_search_with_ads_count(search_with_ads)

mozetl.search.aggregates.search_aggregates(main_summary)

mozetl.search.aggregates.search_aggregates_etl(submission_date, bucket, prefix, **kwargs)

mozetl.search.aggregates.search_clients_daily(main_summary)

mozetl.search.aggregates.search_clients_daily_etl(submission_date, bucket, prefix, **kwargs)

Module contents