Overview.rst 1.2 KB

1234567891011121314151617181920212223242526
  1. Overview
  2. ========
  3. The OpenTelemetry C++ API enables developers to instrument their
  4. applications and libraries in order to make them ready to create and
  5. emit telemetry data. The OpenTelemetry C++ API exclusively focuses on
  6. instrumentation and does not address concerns like exporting, sampling,
  7. and aggregating telemetry data. Those concerns are addressed by the
  8. OpenTelemetry C++ SDK. This architecture enables developers to
  9. instrument applications and libraries with the OpenTelemetry C++ API
  10. while being completely agnostic of how telemetry data is exported and
  11. processed.
  12. Library design
  13. --------------
  14. The OpenTelemetry C++ API is provided as a header-only library and
  15. supports all recent versions of the C++ standard, down to C++14.
  16. A single application might dynamically or statically link to different
  17. libraries that were compiled with different compilers, while several of
  18. the linked libraries are instrumented with OpenTelemetry. OpenTelemetry
  19. C++ supports those scenarios by providing a stable ABI. This is achieved
  20. by a careful API design, and most notably by providing ABI stable
  21. versions of classes from the standard library. All those classes are
  22. provided in the ``opentelemetry::nostd`` namespace.