Statistic uses ConstantsTrait
Represents the possible statistics attributes.
In ArangoDB, all queries that have successfully run to completion return statistics about the execution.
Tags
Table of Contents
Constants
- CACHE_HITS : string = 'cacheHits'
- The total number of index entries read from in-memory caches for indexes of type edge or persistent.
- CACHE_MISSES : string = 'cacheMisses'
- The total number of cache read attempts for index entries that could not be served from in-memory caches for indexes of type edge or persistent.
- CURSORS_CREATED : string = 'cursorsCreated'
- The total number of cursor objects created during query execution.
- CURSORS_REARMED : string = 'cursorsRearmed'
- The total number of times an existing cursor object was repurposed.
- DOCUMENT_LOOKUPS : string = 'documentLookups'
- The number of real document lookups caused by late materialization as well as IndexNodes that had to load document attributes not covered by the index.
- EXECUTION_TIME : string = 'executionTime'
- The query execution time (wall-clock time) in seconds.
- FILTERED : string = 'filtered'
- The total number of documents removed after executing a filter condition in a FilterNode or another node that post-filters data.
- FULL_COUNT : string = 'fullCount'
- The optional total number of documents that matched the search condition if the query’s final top-level LIMIT operation were not present.
- HTTP_REQUESTS : string = 'httpRequests'
- The total number of cluster-internal HTTP requests performed.
- INTERMEDIATE_COMMITS : string = 'intermediateCommits'
- The total number of intermediate commits the query has performed.
- NODES : string = 'nodes'
- When the query is executed with the option profile set to at least 2, then this value contains runtime statistics per query execution node.
- PEAK_MEMORY_USAGE : string = 'peakMemoryUsage'
- The maximum memory usage of the query while it was running.
- SCANNED_FULL : string = 'scannedFull'
- The total number of documents iterated over when scanning a collection without an index.
- SCANNED_INDEX : string = 'scannedIndex'
- The total number of documents iterated over when scanning a collection using an index.
- SEEKS : string = 'seeks'
- The number of seek calls done by RocksDB iterators for merge joins (JoinNode in the execution plan).
- WRITE_EXECUTED : string = 'writesExecuted'
- The total number of data-modification operations successfully executed.
- WRITE_IGNORED : string = 'writesIgnored'
- The total number of data-modification operations that were unsuccessful, but have been ignored because of the ignoreErrors query option.
Constants
CACHE_HITS
The total number of index entries read from in-memory caches for indexes of type edge or persistent.
public
string
CACHE_HITS
= 'cacheHits'
This value is only non-zero when reading from indexes that have an in-memory cache enabled, and when the query allows using the in-memory cache (i.e. using equality lookups on all index attributes).
CACHE_MISSES
The total number of cache read attempts for index entries that could not be served from in-memory caches for indexes of type edge or persistent.
public
string
CACHE_MISSES
= 'cacheMisses'
This value is only non-zero when reading from indexes that have an in-memory cache enabled, the query allows using the in-memory cache ` (i.e. using equality lookups on all index attributes) and the looked up values are not present in the cache.
CURSORS_CREATED
The total number of cursor objects created during query execution.
public
string
CURSORS_CREATED
= 'cursorsCreated'
Cursor objects are created for index lookups.
CURSORS_REARMED
The total number of times an existing cursor object was repurposed.
public
string
CURSORS_REARMED
= 'cursorsRearmed'
Repurposing an existing cursor object is normally more efficient compared to destroying an existing cursor object and creating a new one from scratch.
DOCUMENT_LOOKUPS
The number of real document lookups caused by late materialization as well as IndexNodes that had to load document attributes not covered by the index.
public
string
DOCUMENT_LOOKUPS
= 'documentLookups'
This is how many documents had to be fetched from storage after an index scan that initially covered the attribute access for these documents.
EXECUTION_TIME
The query execution time (wall-clock time) in seconds.
public
string
EXECUTION_TIME
= 'executionTime'
FILTERED
The total number of documents removed after executing a filter condition in a FilterNode or another node that post-filters data.
public
string
FILTERED
= 'filtered'
Note that nodes of the IndexNode type can also filter documents by selecting only the required index range from a collection, and the filtered value only indicates how much filtering was done by a post-filter in the IndexNode itself or following FilterNode nodes.
Nodes of the EnumerateCollectionNode and TraversalNode types can also apply filter conditions and can report the number of filtered documents.
FULL_COUNT
The optional total number of documents that matched the search condition if the query’s final top-level LIMIT operation were not present.
public
string
FULL_COUNT
= 'fullCount'
This attribute may only be returned if the fullCount option was set when starting the query and only contains a sensible value if the query contains a LIMIT operation on the top level.
HTTP_REQUESTS
The total number of cluster-internal HTTP requests performed.
public
string
HTTP_REQUESTS
= 'httpRequests'
INTERMEDIATE_COMMITS
The total number of intermediate commits the query has performed.
public
string
INTERMEDIATE_COMMITS
= 'intermediateCommits'
This number can only be greater than zero for data-modification queries that perform modifications beyond the --rocksdb.intermediate-commit-count or --rocksdb.intermediate-commit-size thresholds.
In a cluster, the intermediate commits are tracked per DB-Server that participates in the query and are summed up in the end.
NODES
When the query is executed with the option profile set to at least 2, then this value contains runtime statistics per query execution node.
public
string
NODES
= 'nodes'
For a human readable output you can execute db._profileQuery(
PEAK_MEMORY_USAGE
The maximum memory usage of the query while it was running.
public
string
PEAK_MEMORY_USAGE
= 'peakMemoryUsage'
In a cluster, the memory accounting is done per shard, and the memory usage reported is the peak memory usage value from the individual shards.
Note that to keep things light-weight, the per-query memory usage is tracked on a relatively high level, not including any memory allocator overhead nor any memory used for temporary results calculations (e.g. memory allocated/deallocated inside AQL expressions and function calls).
SCANNED_FULL
The total number of documents iterated over when scanning a collection without an index.
public
string
SCANNED_FULL
= 'scannedFull'
Documents scanned by subqueries are included in the result, but operations triggered by built-in or user-defined AQL functions are not.
SCANNED_INDEX
The total number of documents iterated over when scanning a collection using an index.
public
string
SCANNED_INDEX
= 'scannedIndex'
Documents scanned by subqueries are included in the result, but operations triggered by built-in or user-defined AQL functions are not.
SEEKS
The number of seek calls done by RocksDB iterators for merge joins (JoinNode in the execution plan).
public
string
SEEKS
= 'seeks'
WRITE_EXECUTED
The total number of data-modification operations successfully executed.
public
string
WRITE_EXECUTED
= 'writesExecuted'
This is equivalent to the number of documents created, updated, or removed by INSERT, UPDATE, REPLACE, REMOVE, or UPSERT operations.
WRITE_IGNORED
The total number of data-modification operations that were unsuccessful, but have been ignored because of the ignoreErrors query option.
public
string
WRITE_IGNORED
= 'writesIgnored'