Change Point Analysis

.github/workflows/run_perf_alert_tool.yml

@@ -0,0 +1,52 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# To learn more about GitHub Actions in Apache Beam check the CI.md
+
+name: Run performance alerting tool on Python load tests.
+
+on:
+  schedule:
+    - cron: '5 * * * *' # TODO: Change the window of the cron job.
+
+jobs:
+  python_run_change_point_analysis:
+    name: Run Change Point Analysis.
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+      - name: Get Apache Beam Build dependencies
+        working-directory: ./sdks/python
+        run: pip install pip setuptools --upgrade && pip install -r build-requirements.txt
+      - name: Install Apache Beam
+        working-directory: ./sdks/python
+        run: pip install -e .[gcp]
+      - name: Install signal-processing-algorithms
+        run: pip install signal-processing-algorithms
+      - name: Install Pandas, yaml, requests
+        run: pip install pandas PyYAML requests
+      - name: Run Change Point Analysis.
+        working-directory: ./sdks/python/apache_beam/testing/analyzers
+        shell: bash
+        run: python analysis.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

sdks/python/apache_beam/testing/analyzers/README.md

@@ -0,0 +1,134 @@
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+
+# Performance alerts for Beam Python performance and load tests
+
+
+##  Alerts 
+
+Performance regressions or improvements detected with the [Change Point Analysis](https://en.wikipedia.org/wiki/Change_detection) using [edivisive](https://github.com/apache/beam/blob/0a91d139dea4276dc46176c4cdcdfce210fc50c4/.test-infra/jenkins/job_InferenceBenchmarkTests_Python.groovy#L30)
+analyzer are automatically filed as Beam GitHub issues with a label `perf-alert`.
+
+The GitHub issue description will contain the information on the affected test and metric by providing the metric values for N consecutive runs with timestamps
+before and after the observed change point. Observed change point is pointed as `Anomaly` in the issue description.
+
+Example: [sample perf alert GitHub issue](https://github.com/AnandInguva/beam/issues/83).
+
+If a performance alert is created on a test, a GitHub issue will be created and the GitHub issue metadata such as GitHub issue
+URL, issue number along with the change point value and timestamp are exported to BigQuery. This data will be used to analyze the next change point observed on the same test to
+update already created GitHub issue or ignore performance alert by not creating GitHub issue to avoid duplicate issue creation.
+
+##  Config file structure 
+The config file defines the structure to run change point analysis on a given test. To add a test to the config file,
+please follow the below structure.
+
+**NOTE**: The Change point analysis only supports reading the metric data from Big Query for now.
+
+```
+# the test_1 must be a unique id.
+test_1:
+  test_name: apache_beam.testing.benchmarks.inference.pytorch_image_classification_benchmarks
+  source: big_query
+  metrics_dataset: beam_run_inference
+  metrics_table: torch_inference_imagenet_results_resnet152
+  project: apache-beam-testing
+  metric_name: mean_load_model_latency_milli_secs
+  labels:
+    - run-inference
+  min_runs_between_change_points: 5
+  num_runs_in_change_point_window: 7
+```
+
+**NOTE**: `test_name` should be in the format `apache_beam.foo.bar`. It should point to a single test target. 
+
+**Note**: If the source is **BigQuery**, the metrics_dataset, metrics_table, project and metric_name should match with the values defined for performance/load tests.
+The above example uses this [test configuration](https://github.com/apache/beam/blob/0a91d139dea4276dc46176c4cdcdfce210fc50c4/.test-infra/jenkins/job_InferenceBenchmarkTests_Python.groovy#L30)
+to fill up the values required to fetch the data from source.
+
+### Different ways to avoid false positive change points
+
+**min_runs_between_change_points**: As the metric data moves across the runs, the change point analysis can place the
+change point in a slightly different place. These change points refer to the same regression and are just noise.
+When we find a new change point, we will search up to the `min_runs_between_change_points` in both directions from the
+current change point. If an existing change point is found within the distance, then the current change point will be
+suppressed.
+
+**num_runs_in_change_point_window**: This defines how many runs to consider from the most recent run to be in change point window.
+Sometimes, the change point found might be way back in time and could be irrelevant. For a test, if a change point needs to be
+reported only when it was observed in the last 7 runs from the current run,
+setting `num_runs_in_change_point_window=7` will achieve it.
+
+##  Register a test for performance alerts 
+
+If a new test needs to be registered for the performance alerting tool, please add the required test parameters to the
+config file.
+
+## Triage performance alert issues
+
+All the performance/load tests metrics defined at [beam/.test-infra/jenkins](https://github.com/apache/beam/tree/master/.test-infra/jenkins) are imported to [Grafana dashboards](http://104.154.241.245/d/1/getting-started?orgId=1) for visualization. Please 
+find the alerted test dashboard to find a spike in the metric values.
+
+For example, for the below configuration,
+* test: `apache_beam.testing.benchmarks.inference.pytorch_image_classification_benchmarks`
+* metric_name: `mean_load_model_latency_milli_secs`
+
+Grafana dashboard can be found at http://104.154.241.245/d/ZpS8Uf44z/python-ml-runinference-benchmarks?orgId=1&viewPanel=7
+
+If the dashboard for a test is not found, you can use the 
+code below to generate a plot for the given test, metric_name. 
+
+If the performance/load test store the results in BigQuery using this [schema](https://github.com/apache/beam/blob/83679216cce2d52dbeb7e837f06ca1d57b31d509/sdks/python/apache_beam/testing/load_tests/load_test_metrics_utils.py#L66),
+then use the following code to fetch the metric_values for a `metric_name` for the last `30` runs and display a plot using matplotlib.
+
+**NOTE**: Install matplotlib and pandas using `pip install matplotlib pandas`.
+```
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from apache_beam.testing.load_tests import load_test_metrics_utils
+from apache_beam.testing.load_tests.load_test_metrics_utils import BigQueryMetricsFetcher
+
+bq_project = 'apache-beam-testing'
+bq_dataset = '<bq-dataset-name>'
+bq_table = '<bq-table>'
+metric_name = '<perf-alerted-metric-name>'
+
+query = f"""
+      SELECT *
+      FROM {bq_project}.{bq_dataset}.{bq_table}
+      WHERE CONTAINS_SUBSTR(({load_test_metrics_utils.METRICS_TYPE_LABEL}), '{metric_name}')
+      ORDER BY {load_test_metrics_utils.SUBMIT_TIMESTAMP_LABEL} DESC
+      LIMIT 30
+    """
+
+big_query_metrics_fetcher = BigQueryMetricsFetcher()
+metric_data: pd.DataFrame = big_query_metrics_fetcher.fetch(query=query)
+# sort the data to view it in chronological order.
+metric_data.sort_values(
+      by=[load_test_metrics_utils.SUBMIT_TIMESTAMP_LABEL], inplace=True)
+
+metric_data.plot(x=load_test_metrics_utils.SUBMIT_TIMESTAMP_LABEL,
+                 y=load_test_metrics_utils.VALUE_LABEL)
+plt.show()
+```
+
+If you confirm there is a change in the pattern of the values for a test, find the timestamp of when that change happened
+and use that timestamp to find possible culprit commit. 
+
+If the performance alert is a `false positive`, close the issue as `Close as not planned`.

sdks/python/apache_beam/testing/analyzers/__init__.py

@@ -0,0 +1,16 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

sdks/python/apache_beam/testing/analyzers/constants.py

@@ -0,0 +1,68 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""The file defines global variables for performance analysis."""
+
+_BQ_PROJECT_NAME = 'apache-beam-testing'
+_BQ_DATASET = 'beam_perf_storage'
+
+_UNIQUE_ID = 'test_id'
+_ISSUE_CREATION_TIMESTAMP_LABEL = 'issue_timestamp'
+_CHANGE_POINT_TIMESTAMP_LABEL = 'change_point_timestamp'
+_CHANGE_POINT_LABEL = 'change_point'
+_TEST_NAME = 'test_name'
+_METRIC_NAME = 'metric_name'
+_ISSUE_NUMBER = 'issue_number'
+_ISSUE_URL = 'issue_url'
+# number of results to display on the issue description
+# from change point index in both directions.
+_NUM_RESULTS_TO_DISPLAY_ON_ISSUE_DESCRIPTION = 10
+_NUM_DATA_POINTS_TO_RUN_CHANGE_POINT_ANALYSIS = 100
+# Variables used for finding duplicate change points.
+_DEFAULT_MIN_RUNS_BETWEEN_CHANGE_POINTS = 5
+_DEFAULT_NUM_RUMS_IN_CHANGE_POINT_WINDOW = 20
+
+_PERF_TEST_KEYS = {
+    'test_name', 'metrics_dataset', 'metrics_table', 'project', 'metric_name'
+}
+
+_SCHEMA = [{
+    'name': _UNIQUE_ID, 'field_type': 'STRING', 'mode': 'REQUIRED'
+},
+           {
+               'name': _ISSUE_CREATION_TIMESTAMP_LABEL,
+               'field_type': 'TIMESTAMP',
+               'mode': 'REQUIRED'
+           },
+           {
+               'name': _CHANGE_POINT_TIMESTAMP_LABEL,
+               'field_type': 'TIMESTAMP',
+               'mode': 'REQUIRED'
+           },
+           {
+               'name': _CHANGE_POINT_LABEL,
+               'field_type': 'FLOAT64',
+               'mode': 'REQUIRED'
+           }, {
+               'name': _METRIC_NAME, 'field_type': 'STRING', 'mode': 'REQUIRED'
+           }, {
+               'name': _TEST_NAME, 'field_type': 'STRING', 'mode': 'REQUIRED'
+           }, {
+               'name': _ISSUE_NUMBER, 'field_type': 'INT64', 'mode': 'REQUIRED'
+           }, {
+               'name': _ISSUE_URL, 'field_type': 'STRING', 'mode': 'REQUIRED'
+           }]