Story (Required)

As an OpenShift user, I would like to capture the memory usage (average and maximum) for SBO performance test run.  

Background (Required)

SBO performance test can be run on demand as part of PR checks or regularly (weekly) and we want to capture the metadata for the test run i.e. openshift_version, commit id, PR number, base branch (incase of PR check) and the results.

Approach(Required)

Use track API of segment to send the data using events

1. "sbo_performance_test_run_memory" as below

analytics.track('sbo_performance_test_run_memory_0ae2191', 'SBO Performance Test Run Memory', {
    'openshift_version': '4.11.7-nightly',
    'run_type': 'PR', #enum value: PR/weekly
    'commit_id': '0ae2191',
    'pr_number': 2182,
    'branch': 'master',
    'average': 70,
    'average_threshold': 85,
    'maximum': 90,
    'maximum_threshold': 95,
    'value_unit': 'MiB',
}) 

2. "performance_test_run_failure" as below

analytics.track('sbo_performance_test_run_failure_0ae2191', 'SBO Performance Test Run Failure', {
    'openshift_version': '4.11.7-nightly',
    'run_type': 'PR', #enum value: PR/weekly
    'commit_id': '0ae2191',
    'pr_number': 2182,
    'branch': 'master',
    'failure_reason': 'CI',

}) 

Demo requirements(Required)

Small demo validating that submitted kpi data is stored.

Dependencies

Account Setup is completed as part of https://issues.redhat.com/browse/APPSVC-1215

Acceptance Criteria

Development: Data is available for one or two iteration

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

Legend

Unknown

Verified

Unsatisfied