open-telemetry / open-telemetry/opentelemetry-cpp

Provide a mechanism for external developers to distinguish between internal and public OpenTelemetry APIs.

Open
#1,698 18 comments 0 reactions 1 assignee View on GitHub

@lalitb is already working on this.

Since Nov 2, 2022.

bug do-not-stale
Dominant language
C++
Stars
1.4k
Forks
632
Avg merge
1d 13h
Merged PRs (30d)
75

Description

Building a component which depends on OpenTelemetry-Cpp from vcpkg on WIndows or LInux. This problem only occurs when you have -WX (VS) or -Werror (GCC/Clang) enabled.

The root cause of this is the use of the InMemorySpanExporter type, which is NOT a part of the public facing API surface for OpenTelemetry.

The reason that I used InMemorySpanExporter is that there was no way of discovering that the InMemorySpanExporter type was internal-only.

Please add the ability to distinguish between internal and public opentelemetry types - either by namespace qualified names or by comments on the individual types.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.