Skip to content

Commit 19965c9

Browse files
committed
Added @SInCE annotations for new stats methods and updated CHANGELOG
1 parent c12b082 commit 19965c9

File tree

4 files changed

+30
-1
lines changed

4 files changed

+30
-1
lines changed

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
1111
### Added
1212
- Added client statistics. Users can enable internal driver statistics by
1313
using system property -Dcom.oracle.nosql.sdk.nosqldriver.stats.profile=
14-
[none|regular|more|all] or by using the NoSQLConfig.setStatsProfile() api.
14+
[none|regular|more|all] or by using the NoSQLHandleConfig.setStatsProfile() api.
15+
- Added StatsControl interface as well as methods to control stats in
16+
NoSQLHandleConfig and NoSQLHandle.
17+
- Added to NoSQLHandleConfig:
18+
- get/setStatsInterval
19+
- get/setStatsProfile
20+
- get/setStatsPrettyPrint
21+
- getStatsHandler
22+
- Added to NoSQLHandle:
23+
- getStatsControl
1524

1625
## [5.2.29] 2021-11-18
1726

driver/src/main/java/oracle/nosql/driver/NoSQLHandle.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,8 @@ public SystemResult doSystemRequest(String statement,
575575
* Returns an object that allows control over how statistics are collected.
576576
*
577577
* @return the StatsControl object
578+
*
579+
* @since 5.2.30
578580
*/
579581
public StatsControl getStatsControl();
580582

driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1211,6 +1211,8 @@ public SslContext getSslContext() {
12111211
*
12121212
* @param statsInterval stats logging interval in seconds
12131213
* @return this
1214+
*
1215+
* @since 5.2.30
12141216
*/
12151217
public NoSQLHandleConfig setStatsInterval(int statsInterval) {
12161218
if (statsInterval < 1) {
@@ -1226,6 +1228,8 @@ public NoSQLHandleConfig setStatsInterval(int statsInterval) {
12261228
* Default interval is 600 seconds, i.e. 10 min.
12271229
*
12281230
* @return the current interval in seconds
1231+
*
1232+
* @since 5.2.30
12291233
*/
12301234
public int getStatsInterval() {
12311235
return this.statsInterval;
@@ -1237,6 +1241,8 @@ public int getStatsInterval() {
12371241
*
12381242
* @param statsProfile profile to use
12391243
* @return this
1244+
*
1245+
* @since 5.2.30
12401246
*/
12411247
public NoSQLHandleConfig setStatsProfile(StatsControl.Profile statsProfile)
12421248
{
@@ -1249,6 +1255,8 @@ public NoSQLHandleConfig setStatsProfile(StatsControl.Profile statsProfile)
12491255
* Default profile is NONE.
12501256
*
12511257
* @return the current profile
1258+
*
1259+
* @since 5.2.30
12521260
*/
12531261
public StatsControl.Profile getStatsProfile() {
12541262
return this.statsProfile;
@@ -1261,6 +1269,8 @@ public StatsControl.Profile getStatsProfile() {
12611269
*
12621270
* @param statsPrettyPrint flag to enable JSON pretty print
12631271
* @return this
1272+
*
1273+
* @since 5.2.30
12641274
*/
12651275
public NoSQLHandleConfig setStatsPrettyPrint(boolean statsPrettyPrint) {
12661276
this.statsPrettyPrint = statsPrettyPrint;
@@ -1272,6 +1282,8 @@ public NoSQLHandleConfig setStatsPrettyPrint(boolean statsPrettyPrint) {
12721282
* Default is disabled.
12731283
*
12741284
* @return the current JSON pretty print flag
1285+
*
1286+
* @since 5.2.30
12751287
*/
12761288
public boolean getStatsPrettyPrint() {
12771289
return this.statsPrettyPrint;
@@ -1283,6 +1295,8 @@ public boolean getStatsPrettyPrint() {
12831295
* @param statsHandler User defined StatsHandler.
12841296
*
12851297
* @return this
1298+
*
1299+
* @since 5.2.30
12861300
*/
12871301
public NoSQLHandleConfig setStatsHandler(
12881302
StatsControl.StatsHandler statsHandler) {
@@ -1294,6 +1308,8 @@ public NoSQLHandleConfig setStatsHandler(
12941308
* Returns the registered statistics handler, otherwise null.
12951309
*
12961310
* @return this
1311+
*
1312+
* @since 5.2.30
12971313
*/
12981314
public StatsControl.StatsHandler getStatsHandler() {
12991315
return this.statsHandler;

driver/src/main/java/oracle/nosql/driver/StatsControl.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
*
8383
* For a detailed statistics log entries structure and values see
8484
* {@link oracle.nosql.driver}</p>
85+
*
86+
* @since 5.2.30
8587
*/
8688
public interface StatsControl {
8789

0 commit comments

Comments
 (0)