summary_parser.py

import json
from time import time

from ...constants import UNKNOWN_RESULT
from ...utils import get_value_by_pattern


def parse_summary_file(path):
    """
    Read data from an OLTPBench-generated summary file.

    Parameters
    ----------
    path : str
        Path to an OLTPBench-generated summary file.

    Returns
    -------
    metadata : dict
        An object containing metadata information.
    timestamp : int
        The timestamp when the benchmark was created.
        Measured in milliseconds since January 1, 1970, 00:00:00 GMT.
    benchmark_type : str
        The benchmark that was run (e.g., tatp, noop).
    parameters : dict
        Information about the parameters with which the test was run.
    metrics : dict
        The summary measurements that were gathered from the test.
    """
    def get_latency_val(latency_dist, pattern):
        value = get_value_by_pattern(latency_dist, pattern, None)
        return float("{:.4}".format(float(value))) if value else value

    with open(path) as summary_file:
        summary = json.load(summary_file)
        latency_dist = summary.get('Latency Distribution', {})

        metadata = {
            'noisepage': {
                'db_version': '1.0.0'
            }
        }
        timestamp = int(get_value_by_pattern(summary, 'Current Timestamp (milliseconds)', str(time())))
        benchmark_type = summary.get('Benchmark Type', UNKNOWN_RESULT)
        parameters = {
            'scale_factor': summary.get('scalefactor', '-1.0'),
            'terminals': int(summary.get('terminals', -1))
        }
        metrics = {
            'throughput': get_value_by_pattern(summary, 'Throughput (requests/second)', '-1.0'),
            'latency': {key: get_latency_val(latency_dist, pattern)
                        for key, pattern in [
                            ('l_25', '25th Percentile Latency (microseconds)'),
                            ('l_75', '75th Percentile Latency (microseconds)'),
                            ('l_90', '90th Percentile Latency (microseconds)'),
                            ('l_95', '95th Percentile Latency (microseconds)'),
                            ('l_99', '99th Percentile Latency (microseconds)'),
                            ('avg', 'Average Latency (microseconds)'),
                            ('median', 'Median Latency (microseconds)'),
                            ('min', 'Minimum Latency (microseconds)'),
                            ('max', 'Maximum Latency (microseconds)')
                        ]}
        }

        return metadata, timestamp, benchmark_type, parameters, metrics