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.

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

Update Metrics status in README.md #1722

Merged
merged 2 commits into from
Oct 31, 2022
Merged
Changes from all commits
Commits
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
28 changes: 7 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,19 @@ The C++ [OpenTelemetry](https://opentelemetry.io/) client.
| Signal | Status | Project |
| ------- | ----------------------- | ------------------------------------------------------------------------ |
| Traces | Public Release | N/A |
| Metrics | Release Candidate [1,2] | N/A |
| Logs | Experimental [3] | N/A |

* [1]: The metric implementation is in release candidate phase. There would be
few iterations of new feature additions, and bug fixes before it is
publically available. Few breaking changes in API and SDK are expected.
* [2]: The earlier implementation (based on old
specification) is now deprecated, and would be removed once new implementation
is declared stable. The older implementation can be included in build by setting
| Metrics | Public Release [1] | N/A |
| Logs | Experimental [2] | [Release Milestone](https://github.com/open-telemetry/opentelemetry-cpp/milestone/18)|

* [1]: The older metrics implementation (based on old
specification) is now deprecated, and would be removed soon.
This can be included in build by setting
`ENABLE_METRICS_PREVIEW` preprocessor macro, and is included under
`*/_metrics/*` directory.
* [3]: The current Log Signal Implementation is Experimental, and will change as
* [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] |
| ----------- |--------------|-------------------------|
| 1.0.0 | 1.0.0-rc4 | N/A |
| 1.0.0 | 1.0.0 | N/A |
| 1.9.0 | 1.6.0 | N/A |

* [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