forked from open-telemetry/opentelemetry-collector
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Start documenting requirements. (open-telemetry#15)
Addresses open-telemetry#4.
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Requirements | ||
|
||
* The API must have zero dependencies and be header-only. | ||
|
||
Pros: allows you to drop it into a source tree (i.e. vendor it) without changing | ||
the build or adding a dependency. | ||
|
||
* The SDK should have minimal dependencies. | ||
|
||
* Exporters can bring in transport dependencies, e.g. Stackdriver exporter | ||
depends on gRPC. | ||
|
||
* Support both static linking and dynamic loading. | ||
|
||
Dynamic loading is required because some vendors want to drop in their own | ||
implementation of the SDK. It also allows low-dependency builds. | ||
|
||
This also requires a stable C++ ABI. There is quite a bit of interest in this. | ||
|
||
This means STL types can't be used in the interface. | ||
|
||
* OpenTelemetry should not _require_ a dedicated thread for background work and | ||
exporters. |