Rename the two different ChangePoint classes for clarity

The recent work in #96 to replace the original external dependency on the
so called "signal processing" repository with our own implementation,
introduced new classess ChangePoint and CandidateChangePoint, in
change_point_divisive/base.py but also left in place the original
ChangePoint class in analysis.py. These come together in series.py,
where the newer is renamed as _ChangePoint() and also acts as a parent
to older class, thus aligning their signature as much as possible.

It turns out having two similarly named classes can be a source of
confusion and bugs. For example, in #141  vishnuchalla fixes a bug
that is due to this and has essentially blocked the --orig-edivisive
code path completely.

This patch is an effort to make the existence of two separate
classes very explicit, by renaming them to ChagePointHunter
and ChangePointOtava based on their "lineage".

A test case is added to exercise the --orig-edivisive code path.
The test fails, as predicted by #141. The test is now cmmented out.
The bug is due to a missing cp.metric property in one variation
of the ChangePoint class.

Note that this patch is intended more for discussion than to merge.
13 files changed
tree: 48c5405fe2a65c91b92ec29ad0f407503bfae3ba
  1. .github/
  2. ci-tools/
  3. docs/
  4. examples/
  5. otava/
  6. perf/
  7. tests/
  8. util/
  9. .asf.yaml
  10. .gitignore
  11. .pre-commit-config.yaml
  12. DISCLAIMER
  13. Dockerfile
  14. hatch_build.py
  15. LICENSE
  16. NOTICE
  17. pyproject.toml
  18. README.md
  19. tox.ini
  20. uv.lock
README.md

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, 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/.

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.