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

Add proj status, and API compatibility matrix in README.md #945

Merged
merged 4 commits into from
Aug 12, 2021
Merged

Add proj status, and API compatibility matrix in README.md #945

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c8b5950
add project status, and compatibility matrix
lalitb Aug 12, 2021
d26f77c
format
lalitb Aug 12, 2021
d88672c
Merge branch 'main' into proj-status
lalitb Aug 12, 2021
cf51afd
Update README.md
ThomsonTan Aug 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ Status](https://github.com/open-telemetry/opentelemetry-cpp/actions/workflows/ci

The C++ [OpenTelemetry](https://opentelemetry.io/) client.

## Project Status

| Signal | Status | Project |
| ------- | ---------------------- | ------------------------------------------------------------------------ |
| Traces | Release Candidate | [1.0.0](https://github.com/open-telemetry/opentelemetry-cpp/milestone/9) |
| Metrics | Development paused [1] | N/A |
| Logs | Experimental [2] | N/A |

* [1]: The development of the metrics API and SDK has paused due to limited development resources, prioritization of a stable Traces release, and waiting for availability of stable Metrics ( API + SDK ) design from the OpenTelemetry specification. The current implementation can be included in build by setting `ENABLE_METRICS_PREVIEW` preprocessor macro.
* [2]: The current Log Signal Implementation is Experimental, and will change as the current OpenTelemetry Log specification matures. The current implementation can be included in build by setting `ENABLE_LOGS_PREVIEW` preprocessor macro.

## OpenTelemetry Specification Compatibility Matrix

| API Version | Core version | Contrib Version |
| ----------- |--------------|-------------------------|
| 1.0.0 | 1.0.0-rc4 | N/A [1] |

* [1]: We don't have releases for opentelemetry-cpp contrib repo. This may change in future.

## Supported C++ Versions

Code shipped from this repository generally supports the following versions of
Expand Down