Skip to content

Commit

Permalink
Use gh-pages to save performance benchmarks results
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanielRN committed Dec 11, 2020
1 parent 496ed8b commit 67c4e4d
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>

instrumentation/**

.. toctree::
:maxdepth: 1
:caption: OpenTelemetry Python Performance
:name: performance-tests
:glob:

performance/**

.. toctree::
:maxdepth: 1
:caption: Examples
Expand Down
4 changes: 4 additions & 0 deletions docs/performance/benchmarks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Performance Tests - Benchmarks
==============================

Click `here <https://open-telemetry.github.io/opentelemetry-python/benchmarks/index.html>`_ to view the latest performance benchmarks for packages in this repo.

0 comments on commit 67c4e4d

Please sign in to comment.