Source code for moztelemetry.spark

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at
import json as json
import logging
from functools import partial
from operator import add
from six import binary_type
from six import iteritems
from six import string_types
from six import viewkeys
from six.moves import reduce

import boto

from .dataset import Dataset
from .histogram import Histogram

logger = logging.getLogger(__name__)

def deprecated(func):
    """This is a decorator which can be used to mark functions
    as deprecated. It will result in a warning being emitted
    when the function is used."""
    def newFunc(*args, **kwargs):
        print("Call to deprecated function %s." % func.__name__)
        return func(*args, **kwargs)
    newFunc.__name__ = func.__name__
    newFunc.__doc__ = func.__doc__
    return newFunc

if not boto.config.has_section('Boto'):
boto.config.set('Boto', 'http_socket_timeout', '10')  #

_chunk_size = 100 * (2 ** 20)
    _conn = boto.connect_s3(host="")

    _bucket = _conn.get_bucket("net-mozaws-prod-us-west-2-pipeline-data", validate=False)
    _bucket_meta = _conn.get_bucket("net-mozaws-prod-us-west-2-pipeline-metadata", validate=False)
except:  # noqa
    pass  # Handy for testing purposes...

_sources = None

class PingCursor(dict):
    """ A subclassed dictionary that defaults to a new instance of
    itself when missing a key. See
    for more details.

    def __getitem__(self, key):
        value = dict.__getitem__(self, key)
        if isinstance(value, dict):
            # cast all subdicts to PingCursor
            value = type(self)(value)
        return value

    def __missing__(self, key):
        value = self[key] = type(self)()
        return value

[docs]@deprecated def get_pings(sc, app=None, build_id=None, channel=None, doc_type='saved_session', fraction=1.0, schema=None, source_name='telemetry', source_version='4', submission_date=None, version=None): """ Returns a RDD of Telemetry submissions for a given filtering criteria. :param sc: an instance of SparkContext :param app: an application name, e.g.: "Firefox" :param channel: a channel name, e.g.: "nightly" :param version: the application version, e.g.: "40.0a1" :param build_id: a build_id or a range of build_ids, e.g.: "20150601000000" or ("20150601000000", "20150610999999") :param submission_date: a submission date or a range of submission dates, e.g: "20150601" or ("20150601", "20150610") :param source_name: source name, set to "telemetry" by default :param source_version: source version, set to "4" by default :param doc_type: ping type, set to "saved_session" by default :param schema: (deprecated) version of the schema to use :param fraction: the fraction of pings to return, set to 1.0 by default """ if schema: print("The 'schema' parameter is deprecated. " "Version 4 is now the only schema supported.") if schema != "v4": raise ValueError("Invalid schema version") dataset = Dataset.from_source('telemetry') filters = ( ('docType', doc_type), ('sourceName', source_name), ('sourceVersion', source_version), ('appName', app), ('appUpdateChannel', channel), ('appVersion', version), ) for key, condition in filters: if condition and condition != '*': dataset = dataset.where(**{key: condition}) # build_id and submission_date can be either strings or tuples or lists, # so they deserve a special treatment special_cases = dict(appBuildId=build_id, submissionDate=submission_date) def range_compare(min_val, max_val, val): return min_val <= val <= max_val for key, value in iteritems(special_cases): if value is not None and value != '*': if isinstance(value, string_types): condition = value elif isinstance(value, (list, tuple)) and len(value) == 2: start, end = value condition = partial(range_compare, start, end) else: raise ValueError(('{} must be either a string or a 2 elements ' 'list/tuple'. format(key))) dataset = dataset.where(**{key: condition}) return dataset.records(sc, sample=fraction)
[docs]@deprecated def get_pings_properties(pings, paths, only_median=False, with_processes=False, histograms_url=None, additional_histograms=None): """ Returns a RDD of a subset of properties of pings. Child histograms are automatically merged with the parent histogram. If one of the paths points to a keyedHistogram name without supplying the actual key, returns a dict of all available subhistograms for that property. :param with_processes: should separate parent and child histograms be included as well? :param paths: paths to properties in the payload, with levels separated by "/". These can be supplied either as a list, eg. ["application/channel", "payload/info/subsessionStartDate"], or as the values of a dict keyed by custom identifiers, eg. {"channel": "application/channel", "ssd": "payload/info/subsessionStartDate"}. :param histograms_url: see histogram.Histogram constructor :param additional_histograms: see histogram.Histogram constructor The returned RDD contains a dict for each ping with the required properties as values, keyed by the original paths (if 'paths' is a list) or the custom identifier keys (if 'paths' is a dict). """ if isinstance(pings.first(), binary_type): pings = p: json.loads(p.decode('utf-8'))) if isinstance(paths, str): paths = [paths] # Use '/' as dots can appear in keyed histograms if isinstance(paths, dict): paths = [(prop_name, path.split("/")) for prop_name, path in iteritems(paths)] else: paths = [(path, path.split("/")) for path in paths] return p: _get_ping_properties(p, paths, only_median, with_processes, histograms_url, additional_histograms)) \ .filter(lambda p: p)
[docs]@deprecated def get_one_ping_per_client(pings): """ Returns a single ping for each client in the RDD. THIS METHOD IS NOT RECOMMENDED: The ping to be returned is essentially selected at random. It is also expensive as it requires data to be shuffled around. It should be run only after extracting a subset with get_pings_properties. """ if isinstance(pings.first(), binary_type): pings = p: json.loads(p.decode('utf-8'))) filtered = pings.filter(lambda p: "clientID" in p or "clientId" in p) if not filtered: raise ValueError("Missing clientID/clientId attribute.") if "clientID" in filtered.first(): client_id = "clientID" # v2 else: client_id = "clientId" # v4 return p: (p[client_id], p)) \ .reduceByKey(lambda p1, p2: p1) \ .map(lambda p: p[1])
def _get_ping_properties(ping, paths, only_median, with_processes, histograms_url, additional_histograms): result = {} for property_name, path in paths: # Cursor will default to `PingCursor()` on missing keys cursor = PingCursor(ping) if path[0] == "payload": path = path[1:] # Translate v4 histogram queries to v2 ones cursor = cursor["payload"] if not cursor: return if path[0] == "histograms" or path[0] == "keyedHistograms": if path[0] == "keyedHistograms" and len(path) == 2: # Include histograms for all available keys. # These are returned as a subdict mapped from the # property_name. kh_keys = viewkeys(cursor["keyedHistograms"][path[1]]) if isinstance(cursor, dict): # Bug 1218576 aggregates child payloads into the # content process as of Firefox 51. Keyed histograms # will be found in one or the other. content_kh = cursor["processes"]["content"]["keyedHistograms"] kh_keys |= viewkeys(content_kh[path[1]]) for payload in cursor.get("childPayloads", []): payload_kh = PingCursor(payload)["keyedHistograms"] kh_keys |= viewkeys(payload_kh[path[1]]) gpu_kh = cursor["processes"]["gpu"]["keyedHistograms"] kh_keys |= viewkeys(gpu_kh[path[1]]) if kh_keys: kh_histograms = {} for kh_key in kh_keys: props = _get_merged_histograms(cursor, kh_key, path + [kh_key], with_processes, histograms_url, additional_histograms) for k, v in iteritems(props): kh_histograms[k] = v.get_value(only_median) if v else None result[property_name] = kh_histograms else: # No available subhistograms. result[property_name] = None else: props = _get_merged_histograms(cursor, property_name, path, with_processes, histograms_url, additional_histograms) for k, v in iteritems(props): result[k] = v.get_value(only_median) if v else None else: prop = _get_ping_property(cursor, path, histograms_url, additional_histograms) result[property_name] = prop return result def _get_ping_property(cursor, path, histograms_url, additional_histograms): is_histogram = False is_keyed_histogram = False if path[0] == "histograms": is_histogram = True elif path[0] == "keyedHistograms": # Deal with histogram names that contain a slash... path = path[:2] + (["/".join(path[2:])] if len(path) > 2 else []) is_keyed_histogram = True try: for field in path: cursor = cursor[field] except: # noqa return None if cursor is None or (isinstance(cursor, dict) and len(cursor) == 0): return None if is_histogram: return Histogram(path[-1], cursor, histograms_url=histograms_url, additional_histograms=additional_histograms) elif is_keyed_histogram: histogram = Histogram(path[-2], cursor, histograms_url=histograms_url, additional_histograms=additional_histograms) = "/".join(path[-2:]) return histogram else: return cursor def _get_merged_histograms(cursor, property_name, path, with_processes, histograms_url, additional_histograms): if path[0] == "histograms" and len(path) != 2: raise ValueError("Histogram access requires a histogram name.") elif path[0] == "keyedHistograms" and len(path) != 3: raise ValueError("Keyed histogram access requires both a histogram name and a label.") # Get parent property parent = _get_ping_property(cursor, path, histograms_url, additional_histograms) # Get children properties if not isinstance(cursor, dict): children = [] else: children = [_get_ping_property(cursor["processes"]["content"], path, histograms_url, additional_histograms)] children += [_get_ping_property(child, path, histograms_url, additional_histograms) for child in cursor.get("childPayloads", [])] children += [_get_ping_property(cursor["processes"]["gpu"], path, histograms_url, additional_histograms)] children = list(filter(lambda h: h is not None, children)) # Merge parent and children merged = ([parent] if parent else []) + children result = {} if with_processes: result[property_name + "_parent"] = parent result[property_name + "_children"] = reduce(add, children) if children else None result[property_name] = reduce(add, merged) if merged else None return result