Skip to content

Release notes for active aql query cursor metric #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 9, 2023
Merged

Release notes for active aql query cursor metric #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81aae63
release notes for active aql query cursor metric
nerpaula Oct 31, 2023
a281ff2
Review
Simran-B Nov 9, 2023
f69390e
Merge branch 'main' of https://github.com/arangodb/docs-hugo into aql…
Simran-B Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
12 changes: 12 additions & 0 deletions site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,18 @@ 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 metric

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
considered inactive and garbage-collected.

## Client tools

### arangodump
Expand Down