Skip to content

Commit

Permalink
[DOCUMENTATION] Add api reference documentation for logs (#2497)
Browse files Browse the repository at this point in the history 
* Remove superfluous slash and bring input in lexicographic order.

* Add logs to generated Doxygen documentation.

---------

Co-authored-by: Marc Alff <marc.alff@oracle.com>
  • Loading branch information
@S-Bohn @marcalff
S-Bohn and marcalff authored Jan 21, 2024
1 parent ff13fdd commit 02b984a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/public/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -794,17 +794,19 @@ INPUT = \
../../api/include/opentelemetry/baggage \
../../api/include/opentelemetry/context \
../../api/include/opentelemetry/common \
../../api/include/opentelemetry/logs \
../../api/include/opentelemetry/nostd/shared_ptr.h \
../../api/include/opentelemetry/nostd/span.h \
../../api//include/opentelemetry/nostd/string_view.h \
../../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/instrumentationscope \
../../sdk/include/opentelemetry/sdk/logs \
../../sdk/include/opentelemetry/sdk/metrics \
../../sdk/include/opentelemetry/sdk/resource \
../../sdk/include/opentelemetry/sdk/trace \


Expand Down
3 changes: 2 additions & 1 deletion docs/public/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ OpenTelemetry C++
otel_docs/namespace_opentelemetry__common
otel_docs/namespace_opentelemetry__context
otel_docs/namespace_opentelemetry__metrics
otel_docs/namespace_opentelemetry__logs

.. toctree::
:maxdepth: 1
Expand All @@ -37,7 +38,7 @@ OpenTelemetry C++
otel_docs/namespace_opentelemetry__sdk__instrumentationlibrary
otel_docs/namespace_opentelemetry__sdk__resource
otel_docs/namespace_opentelemetry__sdk__metrics

otel_docs/namespace_opentelemetry__sdk__logs

.. toctree::
:maxdepth: 1
Expand Down

2 comments on commit 02b984a

@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 sdk Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: 02b984a Previous: ff13fdd Ratio
BM_LockFreeBuffer/4 9675140.380859375 ns/iter 3869295.439407369 ns/iter 2.50

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

@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: 02b984a Previous: ff13fdd Ratio
BM_SpanIdDefaultConstructor 0.7509295868690498 ns/iter 0.3105502945619847 ns/iter 2.42
BM_SpanIdConstructor 0.7443949755647881 ns/iter 0.3118630545312404 ns/iter 2.39
BM_SpanIdToLowerBase16 13.440259835191918 ns/iter 6.378453611214723 ns/iter 2.11
BM_SpanIdIsValid 0.6977545190268546 ns/iter 0.3101141950792425 ns/iter 2.25

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

Please sign in to comment.