Change Detection for Continuous Performance Engineering

Clone this repo:
  1. d2d51c9 Make external service clients optional (#176) by Alex Sorokoumov · 25 hours ago master
  2. da316dd docs: add Sphinx documentation build (#168) by adambernier · 4 days ago
  3. 8a6353a Fix AnalyzedSeries typehint (#174) by Alex Sorokoumov · 8 days ago
  4. f15bb29 Make AnalyzedSeries change points lazy properties (#169) by DanaerLee · 9 days ago
  5. a1ef00d Make CSV importer configurable via ConfigArgParse (#166) by DanaerLee · 10 days ago

Apache Otava – Change Detection for Continuous Performance Engineering

License PyPI version PyPI - Python Version

Apache Otava (incubating) performs statistical analysis of performance test results stored in CSV files, PostgreSQL, BigQuery, InfluxDB 3, or Graphite database. It finds change-points and notifies about possible performance regressions.

A typical use-case of otava is as follows:

  • A set of performance tests is scheduled repeatedly, such as after each commit is pushed.
  • The resulting metrics of the test runs are stored in a time series database (Graphite) or appended to CSV files.
  • Otava is launched by a Jenkins/Cron job (or an operator) to analyze the recorded metrics regularly.
  • Otava notifies about significant changes in recorded metrics by outputting text reports or sending Slack notifications.

Otava is capable of finding even small, but persistent shifts in metric values, despite noise in data. It adapts automatically to the level of noise in data and tries to notify only about persistent, statistically significant changes, be it in the system under test or in the environment.

Unlike in threshold-based performance monitoring systems, there is no need to setup fixed warning threshold levels manually for each recorded metric. The level of accepted probability of false-positives, as well as the minimal accepted magnitude of changes are tunable. Otava is also capable of comparing the level of performance recorded in two different git histories. This can be used for example to validate a feature branch against the main branch, perhaps integrated with a pull request.

See the documentation in https://otava.apache.org/docs/overview/.

Installation

The default package includes the Otava library and CLI, with support for CSV, JSON, and Graphite data:

pip install apache-otava

Install extras for additional integrations. Extras can be combined, or install all to enable every integration:

pip install 'apache-otava[bigquery]'
pip install 'apache-otava[postgres,slack]'
pip install 'apache-otava[all]'

See the installation guide for the complete list of extras.

Supported Python Versions

Apache Otava is tested against Python 3.10, 3.11, 3.12, 3.13, and 3.14.

License

Licensed 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.