diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 856b2f3a84..4c7dbc0478 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -84,7 +84,7 @@ jobs: fail-on-alert: true # Make a commit on `gh-pages` with benchmarks from previous step auto-push: ${{ github.ref == 'refs/heads/master' }} - gh-pages-branch: master + gh-pages-branch: gh-pages benchmark-data-dir-path: benchmarks misc: strategy: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f04808d16a..7612cb8516 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ for more detail on available tox commands. ### Benchmarks -Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python.readthedocs.io/en/latest/benchmarks/index.html). From this page, you can download a JSON file with the performance results. +Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python.readthedocs.io/en/latest/performance/benchmarks.html). From the linked page, you can download a JSON file with the performance results. Running the `tox` tests also runs the performance tests if any are available. Benchmarking tests are done with `pytest-benchmark` and they output a table with results to the console. diff --git a/docs/index.rst b/docs/index.rst index e39b969b2c..5a6a3a7715 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -91,6 +91,14 @@ install instrumentation/** +.. toctree:: + :maxdepth: 1 + :caption: OpenTelemetry Python Performance + :name: performance-tests + :glob: + + performance/** + .. toctree:: :maxdepth: 1 :caption: Examples diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst new file mode 100644 index 0000000000..9c406c0323 --- /dev/null +++ b/docs/performance/benchmarks.rst @@ -0,0 +1,4 @@ +Performance Tests - Benchmarks +============================== + +Click `here `_ to view the latest performance benchmarks for packages in this repo.