Skip to content

Commit

Permalink
Fix:#1575 API Documentation for Metrics SDK and API (#1678)
Browse files Browse the repository at this point in the history
* add api/sdk API doc

* update doxyfile
  • Loading branch information
lalitb authored Oct 14, 2022
1 parent f29703b commit 3ff2ed8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/public/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -799,11 +799,13 @@ INPUT = \
../../api//include/opentelemetry/nostd/string_view.h \
../../api/include/opentelemetry/nostd/unique_ptr.h \
../../api/include/opentelemetry/nostd/variant.h \
../../api/include/opentelemetry/metrics \
../../api/include/opentelemetry/trace \
../../sdk/include/opentelemetry/sdk/instrumentationscope \
../../sdk/include/opentelemetry/sdk/instrumentationlibrary \
../../sdk/include/opentelemetry/sdk/resource \
../../sdk/include/opentelemetry/sdk/trace
../../sdk/include/opentelemetry/sdk/metrics \
../../sdk/include/opentelemetry/sdk/trace \


# This tag can be used to specify the character encoding of the source files
Expand Down
3 changes: 3 additions & 0 deletions docs/public/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ OpenTelemetry C++
otel_docs/namespace_opentelemetry__baggage
otel_docs/namespace_opentelemetry__common
otel_docs/namespace_opentelemetry__context
otel_docs/namespace_opentelemetry__metrics

.. toctree::
:maxdepth: 1
Expand All @@ -35,6 +36,8 @@ OpenTelemetry C++
otel_docs/namespace_opentelemetry__sdk__trace
otel_docs/namespace_opentelemetry__sdk__instrumentationlibrary
otel_docs/namespace_opentelemetry__sdk__resource
otel_docs/namespace_opentelemetry__sdk__metrics


.. toctree::
:maxdepth: 1
Expand Down

1 comment on commit 3ff2ed8

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'OpenTelemetry-cpp api Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: 3ff2ed8 Previous: f29703b Ratio
BM_SpinLockThrashing/2/process_time/real_time 1.2080364227294922 ms/iter 0.2394450467405761 ms/iter 5.05
BM_ProcYieldSpinLockThrashing/2/process_time/real_time 0.8383467306498609 ms/iter 0.23797857741143788 ms/iter 3.52
BM_NaiveSpinLockThrashing/2/process_time/real_time 0.9569349423260756 ms/iter 0.23844157378685657 ms/iter 4.01

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.