Skip to content

Commit

Permalink
Update Metrics status in README.md (#1722)
Browse files Browse the repository at this point in the history
* update metrics status

* add project column
  • Loading branch information
lalitb authored Oct 31, 2022
1 parent 9acde87 commit e5590c5
Showing 1 changed file with 7 additions and 21 deletions.
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

1 comment on commit e5590c5

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'OpenTelemetry-cpp api Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: e5590c5 Previous: 9acde87 Ratio
BM_SpinLockThrashing/2/process_time/real_time 1.2013521687737827 ms/iter 0.2528168739528831 ms/iter 4.75
BM_ProcYieldSpinLockThrashing/2/process_time/real_time 0.7212739629843801 ms/iter 0.2453526206638502 ms/iter 2.94
BM_NaiveSpinLockThrashing/2/process_time/real_time 0.7282445305272153 ms/iter 0.2580812223738421 ms/iter 2.82

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.