From 81aae639ac6cb7da31c83a042e019eb47ab588af Mon Sep 17 00:00:00 2001 From: Paula Date: Tue, 31 Oct 2023 15:46:50 +0100 Subject: [PATCH 1/2] release notes for active aql query cursor metric --- .../release-notes/version-3.12/whats-new-in-3-12.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md b/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md index 3e85579ec3..b8e18d5b44 100644 --- a/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md +++ b/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md @@ -241,5 +241,17 @@ of outgrowing the maximum number of file descriptors the ArangoDB process can open. Thus, these options should only be enabled on deployments with a limited number of collections/shards/indexes. +### Active AQL query cursors + +The `arangodb_aql_cursors_active` metric has been added and shows the number +of active AQL query cursors. + +AQL query cursors are created for queries that produce more results than +specified in the `batchSize` query option (default value: `1000`). Such results +can be fetched incrementally by client operations in chunks. +As it is unclear if and when a client will fetch any remaining data from a +cursor, every cursor has a server-side timeout value (TTL) after which it is +garbage-collected. + ## Internal changes From a281ff28adf47dce5a971b7cb0a2a601c3e51b4f Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Thu, 9 Nov 2023 10:11:11 +0100 Subject: [PATCH 2/2] Review --- .../release-notes/version-3.12/api-changes-in-3-12.md | 8 ++++++++ .../3.12/release-notes/version-3.12/whats-new-in-3-12.md | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md b/site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md index 71b5b0071a..7f3b4eb5e0 100644 --- a/site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md +++ b/site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md @@ -116,6 +116,14 @@ the query. In that case, `warnings` contains an empty array. In previous versions, no `warnings` attribute was returned when parsing a query produced no warnings. +#### Metrics API + +The metrics endpoint includes the following new metric: + +| Label | Description | +|:------|:------------| +| `arangodb_aql_cursors_active` | Current number of active AQL query cursors. | + ### Endpoints moved diff --git a/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md b/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md index b8e18d5b44..686211bf70 100644 --- a/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md +++ b/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md @@ -241,7 +241,7 @@ of outgrowing the maximum number of file descriptors the ArangoDB process can open. Thus, these options should only be enabled on deployments with a limited number of collections/shards/indexes. -### Active AQL query cursors +### Active AQL query cursors metric The `arangodb_aql_cursors_active` metric has been added and shows the number of active AQL query cursors. @@ -251,7 +251,7 @@ specified in the `batchSize` query option (default value: `1000`). Such results can be fetched incrementally by client operations in chunks. As it is unclear if and when a client will fetch any remaining data from a cursor, every cursor has a server-side timeout value (TTL) after which it is -garbage-collected. +considered inactive and garbage-collected. ## Internal changes