hazelcast / hazelcast/hazelcast-cpp-client
[TRACKING ISSUE] Deprecate STATISTICS properties
- Dominant language
- C++
- Stars
- 91
- Forks
- 54
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 5
Description
The tracking issue for the Java side PR.
See https://github.com/hazelcast/hazelcast/pull/19219 for details.
---
The following properties are not used anymore since 4.0
```
public static final HazelcastProperty STATISTICS_ENABLED = new HazelcastProperty("hazelcast.client.statistics.enabled",
false);
/**
* The period in seconds the statistics run.
*/
public static final HazelcastProperty STATISTICS_PERIOD_SECONDS = new HazelcastProperty(
"hazelcast.client.statistics.period.seconds", 3, SECONDS);
```
I traced it back to this pr. It seems that we are checking metricsConfig instead.
This pr:
1. puts @Deprecated to the property documents on ClientProperties class.
2. If user sets statistics, make sure it will set metrics config as well. This is because there
were no warning or documentation about the removal. According to doc, these properties still used.
So we fix the behaviour.
3. If both properties are set, ignore old STATISTICS properties.
4. Adds javadoc to ClientProperty and MetricsConfig to explain the effects of using these properties
fixes https://github.com/hazelcast/hazelcast/issues/18579
Checklist:
- [X] Labels (`Team:`, `Type:`, `Source:`, `Module:`) and Milestone set
- [X] Add `Add to Release Notes` label if changes should be mentioned in release notes or `Not Release Notes content` if changes are not relevant for release notes
- [X] Request reviewers if possible
- [X] New public APIs have `@Nonnull/@Nullable` annotations
- [X] New public APIs have `@since` tags in Javadoc
- [ ] Send backports/forwardports if fix needs to be applied to past/future releases
Contributor guide
Assessment
This issue has not been assessed yet.