Benchmark documentation (#1205)

open-telemetry · Feb 12, 2022 · e89e5b3 · e89e5b3 · github-actions · Feb 12, 2022
1 parent 7485102
commit e89e5b3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst
@@ -0,0 +1,6 @@
+Performance Tests - Benchmarks
+==============================
+
+Click `here <https://open-telemetry.github.io/opentelemetry-cpp/benchmarks/index.html>`_ to view the latest performance benchmarks for packages in this repo.
+
+Please note that the flutation in the results are mainly because [machines with different CPUs](https://github.com/benchmark-action/github-action-benchmark/issues/79) are used for tests.
diff --git a/docs/public/index.rst b/docs/public/index.rst
@@ -36,6 +36,14 @@ OpenTelemetry C++
    otel_docs/namespace_opentelemetry__sdk__instrumentationlibrary
    otel_docs/namespace_opentelemetry__sdk__resource
 
+.. toctree::
+    :maxdepth: 1
+    :caption: Performance
+    :name: performance-tests
+    :glob:
+
+    performance/**
+
 .. toctree::
    :maxdepth: 1
    :caption: Further Reading