Skip to content

Commit 1f7cf71

Browse files
DOC-11708 Deprecated REST API endpoint for bucket stats (#3894)
1 parent 9aec644 commit 1f7cf71

File tree

4 files changed

+26
-7
lines changed

4 files changed

+26
-7
lines changed

modules/introduction/partials/new-features-80.adoc

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ curl --get -u <username:password> \
8989
-d clusterLabels=none|uuidOnly|uuidAndName
9090
----
9191
92+
https://jira.issues.couchbase.com/browse/MB-66615[MB-66615]::
93+
The REST API `GET /pools/default/buckets/[bucket-name]/stats` (xref:rest-api:rest-bucket-stats.adoc[Getting Bucket Statistics]) is deprecated and replaced with `GET /pools/default/stats/range/[metric_name]/[function-expression]`.
94+
Similarly, to retrieve statistics for multiple metrics, the REST API `POST /pools/default/stats/range` is supported.
95+
+
96+
For more information, see xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic] and xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics].
97+
9298
https://jira.issues.couchbase.com/browse/MB-33315[MB-33315] Allow auto-failover for ephemeral buckets without a replica::
9399
Previously, Couchbase Server always prevented auto-failover on nodes containing an ephemeral bucket that does not have replicas.
94100
You can now configure Couchbase Server Enterprise Edition to allow a node to auto-failover even if it has an ephemeral bucket without a replica.
@@ -98,7 +104,6 @@ When you enable it, Couchbase Server creates empty vBuckets on other nodes to re
98104
If the failed over node rejoins the cluster, Couchbase Server moves the replacement vBuckets back to rejoining node.
99105
This option is useful if your application uses ephemeral buckets for data that's not irreplaceable, such as caches.
100106
This setting is not available in Couchbase Server Community Edition.
101-
102107
+
103108
See xref:learn:clusters-and-availability/automatic-failover.adoc#auto-failover-and-ephemeral-buckets[Auto-Failover and Ephemeral Buckets] and xref:manage:manage-settings/general-settings.adoc#node-availability[Node Availability] for more information.
104109
@@ -108,7 +113,6 @@ Before version 8.0, you could only configure Couchbase Server to auto-failover a
108113
The new `failoverOnDataDiskNonResponsiveness` setting and corresponding settings in the Couchbase Web Console *Settings* page sets the nuber of seconds allowed for read or write operations to complete.
109114
If this period elapses before the operation completes, Couchbase Server triggers an auto-failover for the node.
110115
This setting is off by default.
111-
112116
+
113117
See xref:learn:clusters-and-availability/automatic-failover.adoc#failover-on-data-disk-non-responsiveness[Failover on Data Disk Non-Responsiveness] to learn more about this feature.
114118
See xref:manage:manage-settings/general-settings.adoc#node-availability[Node Availability] and xref:rest-api:rest-cluster-autofailover-enable.adoc[] to learn how to enable it.
@@ -348,6 +352,12 @@ https://jira.issues.couchbase.com/browse/MB-62507[MB-62507]::
348352
XDCR supports Generic Services Log Level configuration using the REST API through the `genericServicesLogLevel` settings.
349353
For more information, see xref:rest-api:rest-xdcr-adv-settings.adoc[XDCR Advanced Settings].
350354
355+
356+
https://jira.issues.couchbase.com/browse/MB-66615[MB-66615]::
357+
To retrieve the XDCR statistics details, instead of the REST API `GET /pools/default/buckets/[source_bucket]/stats/[destination_endpoint]`, Couchbase now supports the REST API `GET /pools/default/stats/range/[statistics_name]`.
358+
+
359+
For more information, see xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic].
360+
351361
[#section-new-features-800-security-authentication]
352362
=== Security and Authentication
353363

modules/rest-api/pages/rest-bucket-stats.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
= Getting Bucket Statistics
2-
:description: pass:q[To retrieve bucket statistics, use the `GET` operation with the `/pools/default/buckets/bucket_name/stats` URI.]
2+
:description: pass:q[See the IMPORTANT note.]
33
:page-topic-type: reference
44
:page-aliases: rest-api:rest-node-retrieve-stats
55

6+
[.deprecated]#Deprecated#
7+
68
[abstract]
79
{description}
810

11+
IMPORTANT: As of Couchbase Server 8.0, the REST API endpoint `GET /pools/default/buckets/<bucket-name>/stats` is deprecated.
12+
For retrieving bucket statistics details, use xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic] or xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics] instead.
13+
914
== HTTP method and URI
1015

1116
Statistics can be retrieved at the bucket level.

modules/rest-api/partials/rest-buckets-table.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,12 @@
2323
| xref:rest-api:rest-retrieve-bucket-nodes.adoc[Listing Nodes by Bucket]
2424

2525
| `GET`
26-
| `/pools/default/buckets/[bucket-name]/stats`
27-
| xref:rest-api:rest-bucket-stats.adoc[Getting Bucket Statistics]
26+
| `/pools/default/stats/range/[metric_name]/[function-expression]`
27+
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]
28+
29+
| `POST`
30+
| `/pools/default/stats/range`
31+
| xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics]
2832

2933
| `GET`
3034
| `/pools/default/buckets/default`

modules/rest-api/partials/rest-xdcr-table.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545

4646
| `GET`
47-
| `/pools/default/buckets/[source_bucket]/stats/[destination_endpoint]`
48-
| xref:rest-api:rest-xdcr-statistics.adoc[Getting Statistics]
47+
| `/pools/default/stats/range/[statistics_name]`
48+
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]
4949

5050
|===

0 commit comments

Comments
 (0)