Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] API Documentation for Metrics SDK and API #1575

Closed
lalitb opened this issue Aug 17, 2022 · 1 comment · Fixed by #1678
Closed

[DOCS] API Documentation for Metrics SDK and API #1575

lalitb opened this issue Aug 17, 2022 · 1 comment · Fixed by #1678
Labels
documentation Improvements or additions to documentation priority:p1 Issues that are blocking
Milestone
Metrics v1.0.0 (GA)

Comments

@lalitb
Copy link
Member

lalitb commented Aug 17, 2022

The otel-cpp documentation is maintained at https://opentelemetry-cpp.readthedocs.io/en/latest/.

As of now. it only contains API documentation for Traces, along with Baggage, Resources, and InstrumentationLibrary.
Need to add API documentation for Metrics.
@lalitb lalitb added this to the Metrics v1.0.0 (GA) milestone Aug 17, 2022
@lalitb lalitb added the priority:p1 Issues that are blocking label Aug 24, 2022
@marcalff
Copy link
Member

marcalff commented Sep 8, 2022

Keeping this issue open, as a proxy, so it gets tracked in cpp milestones.

Doc to be delivered in opentelemetry.io,
see #1589

@marcalff marcalff added the documentation Improvements or additions to documentation label Oct 3, 2022
@lalitb lalitb mentioned this issue Oct 13, 2022
Merged
3 tasks
lalitb added a commit that referenced this issue Oct 14, 2022
@lalitb
Fix:#1575 API Documentation for Metrics SDK and API (#1678)
3ff2ed8 
* add api/sdk API doc

* update doxyfile
ays7 added a commit to ays7/opentelemetry-cpp that referenced this issue Oct 29, 2022
@ays7
Merge commit '9acde87b08b225ce511fa8a20c6cba14f2921518' into ays/thre…
456a0e7 
…ad-local-stack

* commit '9acde87b08b225ce511fa8a20c6cba14f2921518': (36 commits)
  Prepare v1.7.0 release with Metrics API/SDK GA. (open-telemetry#1721)
  Fix: 1712 -  Validate Instrument meta data (name, unit, description) (open-telemetry#1713)
  Document libthrift 0.12.0 doesn't work with Jaeger exporter (open-telemetry#1714)
  Fix:1674, Add Monotonic Property to Sum Aggregation, and unit tests for Up Down Counter (open-telemetry#1675)
  [Metrics SDK] Move Metrics Exemplar processing behind feature flag (open-telemetry#1710)
  [Metrics API/SDK] Change Meter API/SDK to return nostd::unique_ptr for Sync Instruments (open-telemetry#1707)
  [Metrics] Switch to explicit 64 bit integers (open-telemetry#1686)
  Add metrics e2e test to asan & tsan CI (open-telemetry#1670)
  Add otlp-grpc example bazel (open-telemetry#1708)
  [Metrics SDK] Add support for Pull Metric Reader (open-telemetry#1701)
  Fix debug log of OTLP HTTP exporter and ES log exporter (open-telemetry#1703)
  [SEMANTIC CONVENTIONS] Upgrade to version 1.14.0 (open-telemetry#1697)
  Fix a potential precision loss on integer in ReservoirCellIndexFor (open-telemetry#1696)
  fix Histogram crash (open-telemetry#1685)
  Fix:1676 Segfault when short export period is used for metrics  (open-telemetry#1682)
  Add timeout support to MeterContext::ForceFlush (open-telemetry#1673)
  Add CMake OTELCPP_MAINTAINER_MODE (open-telemetry#1650)
  [DOCS] - Minor updates to OStream Metrics exporter documentation (open-telemetry#1679)
  Fix:open-telemetry#1575 API Documentation for Metrics SDK and API (open-telemetry#1678)
  Fixes open-telemetry#249 (open-telemetry#1677)
  ...
yxue pushed a commit to yxue/opentelemetry-cpp that referenced this issue Dec 5, 2022
@lalitb @yxue
Fix:open-telemetry#1575 API Documentation for Metrics SDK and API (op…
a85dfe7 
…en-telemetry#1678)

* add api/sdk API doc

* update doxyfile
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation priority:p1 Issues that are blocking
Projects
None yet
Milestone
Metrics v1.0.0 (GA)
Development

Successfully merging a pull request may close this issue.

Fix:#1575 API Documentation for Metrics SDK and API lalitb/opentelemetry-cpp
2 participants
@lalitb @marcalff