Skip to content

Commit

Permalink
Update metrics status to Release Candidate (open-telemetry#1570)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lalitb
lalitb authored Aug 17, 2022
1 parent 6e6e33c commit ef4136e
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,32 @@ The C++ [OpenTelemetry](https://opentelemetry.io/) client.

## Project Status

| Signal | Status | Project |
| ------- | ---------------------- | ------------------------------------------------------------------------ |
| Traces | Public Release | N/A |
| Metrics | Alpha [1] | N/A |
| Logs | Experimental [2] | N/A |

* [1]: The metric collection pipeline is available for testing purpose. Not
ready for production. The earlier implementation (based on old
specification) can be included in build by setting
| 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
`ENABLE_METRICS_PREVIEW` preprocessor macro, and is included under
`*/_metrics/*` directory. This would be eventually removed once the
ongoing implemetation is stable.
* [2]: The current Log Signal Implementation is Experimental, and will change as
`*/_metrics/*` directory.
* [3]: 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 |
| API Version | Core Version | Contrib Version [1] |
| ----------- |--------------|-------------------------|
| 1.0.0 | 1.0.0-rc4 | N/A [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.
Expand Down

0 comments on commit ef4136e

Please sign in to comment.