Manage and Monitor Queries

bucket.IO.stats
optional

The number of reads and retries for each bucket.

object

cores
optional

The maximum number of logical cores available to the query engine.

integer

cpu.sys.percent
optional

CPU usage. The percentage of time spent executing system code since the last time the statistics were checked.

integer (int64)

cpu.user.percent
optional

CPU usage. The percentage of time spent executing user code since the last time the statistics were checked.

integer (int64)

ffdc.total
optional

The total number of times FFDC has been invoked since the last restart.

integer

gc.num
optional

The target heap size of the next garbage collection cycle.

integer (int64)

gc.pause.percent
optional

The percentage of time spent pausing for garbage collection since the last time the statistics were checked.

integer (int64)

gc.pause.time
optional

The total time spent pausing for garbage collection since the query engine started (ns).

string (duration)

healthy
optional

False when either the unbounded or plus request queues are full; true otherwise.

boolean

host.memory.free
optional

Amount of free memory on the host.

integer (int64)

host.memory.quota
optional

The host memory quota. This reflects the node-quota setting.

integer (int64)

host.memory.total
optional

Total memory on the host.

integer (int64)

host.memory.value_quota
optional

This the total document memory quota on the node.

integer (int64)

load
optional

A calculation for how busy the server is.

integer

loadfactor
optional

The moving 15 minute average of the load calculation.

integer

local.time
optional

The local time of the query engine.

string (date-time)

memory.system
optional

The total amount of memory obtained from the operating system (bytes). This measures the virtual address space reserved by the query engine for heaps, stacks, and other internal data structures.

integer (int64)

memory.total
optional

The cumulative amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, but does not decrease when objects are freed.

integer (int64)

memory.usage
optional

The amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, and decreases as objects are freed.

integer (int64)

node
optional

The name or IP address and port of the node.

string

node.allocated.values
optional

The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.)

integer

node.memory.usage
optional

The currently allocated document memory on the node.

integer

process.memory.usage
optional

Current process memory use.

integer

process.percore.cpupercent
optional

Average CPU usage per core.

number

process.rss
optional

Process RSS (bytes)

integer

process.service.usage
optional

The number of active servicers for the dominant workload — unbound queue servicers or plus queue servicers.

integer

request.active.count
optional

Total number of active requests.

integer

request.completed.count
optional

Total number of completed requests.

integer

request.per.sec.15min
optional

Number of query requests processed per second. 15-minute exponentially weighted moving average.

number

request.per.sec.1min
optional

Number of query requests processed per second. 1-minute exponentially weighted moving average.

number

request.per.sec.5min
optional

Number of query requests processed per second. 5-minute exponentially weighted moving average.

number

request.prepared.percent
optional

Percentage of requests that are prepared statements.

integer

request.queued.count
optional

Number of queued requests.

integer

request.quota.used.hwm
optional

High water mark for request quota use.

integer

request_time.80percentile
optional

End-to-end time to process a query. The 80th percentile.

string (duration)

request_time.95percentile
optional

End-to-end time to process a query. The 95th percentile.

string (duration)

request_time.99percentile
optional

End-to-end time to process a query. The 99th percentile.

string (duration)

request_time.mean
optional

End-to-end time to process a query. The mean value.

string (duration)

request_time.median
optional

End-to-end time to process a query. The median value.

string (duration)

servicers.paused.count
optional

Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.)

integer

servicers.paused.total
optional

Number of times servicers have been temporarily paused. (Applies to serverless environments only.)

integer

temp.hwm
optional

High water mark for temp space use directly by query. (Doesn’t include use by the GSI and FTS clients.)

integer

temp.usage
optional

Current Query temp space use. (Doesn’t include use by the GSI and FTS clients.)

integer

total.threads
optional

The number of active threads used by the query engine.

integer

uptime
optional

The uptime of the query engine.

string (duration)

version
optional

The version of the query engine.

string

clientContextID
optional

The opaque ID or context provided by the client. Refer to the request-level client_context_id parameter for more information.

string

elapsedTime
optional

The time taken from when the request was acknowledged by the service to when the request was completed. It includes the time taken by the service to schedule the request.

string (duration)

errorCount
optional

Total number of errors encountered while executing the query.

integer

memoryQuota
optional

The memory quota for the request, in MB. This property is only returned if a memory quota is set for the query.

integer

node
optional

IP address and port number of the node where the query is executed.

string

phaseCounts
optional

Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.

For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. Polling the active requests again may return different values.
Example : { "fetch" : 16, "indexScan" : 187 }

object

phaseOperators
optional

Indicates the numbers of each kind of query operator involved in different phases of the query processing.

For instance, a non-covering index path might involve one index scan and one fetch operator. A join would probably involve two or more fetches, one per keyspace. A union select would have twice as many operator counts, one per each branch of the union.
Example : { "authorize" : 1, "fetch" : 1, "indexScan" : 2 }

object

phaseTimes
optional

Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.

For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. Polling the active requests again may return different values.
Example : { "authorize" : "823.631µs", "fetch" : "656.873µs", "indexScan" : "29.146543ms", "instantiate" : "236.221µs", "parse" : "826.382µs", "plan" : "11.831101ms", "run" : "16.892181ms" }

object

remoteAddr
optional

IP address and port number of the client application, from where the query is received.

string

requestId
optional

Unique request ID internally generated for the query.

string (uuid)

requestTime
optional

Timestamp when the query is received.

string (date-time)

resultCount
optional

Total number of documents returned in the query result.

integer

resultSize
optional

Total number of bytes returned in the query result.

integer

scanConsistency
optional

The value of the query setting Scan Consistency used for the query.

string

serviceTime
optional

Total amount of calendar time taken to complete the query.

string (duration)

state
optional

The state of the query execution, such as completed, running, cancelled.

Note that the completed state means that the request was started and completed by the Query service, but it does not mean that it was necessarily successful. The request could have been successful, or completed with errors.

To find requests that were successful, use this field in conjunction with the errorCount field: search for requests whose state is completed and whose error count is 0.

string

statement
optional

The query statement being executed.

string

useCBO
optional

Whether the cost-based optimizer is enabled for the query.

boolean

usedMemory
optional

The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query.

integer

userAgent
optional

Name of the client application or program that issued the query.

string

users
optional

Username with whose privileges the query is run.

string

avgElapsedTime
optional

The mean time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

avgServiceTime
optional

The mean amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

encoded_plan
required

The full prepared statement in encoded format.

string

featureControls
optional

This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

integer

indexApiVersion
optional

This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

integer

lastUse
optional

Date and time of last use.

This property is only returned when the prepared statement has been executed.

string (date-time)

maxElapsedTime
optional

The maximum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

maxServiceTime
optional

The maximum amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

minElapsedTime
optional

The minimum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

minServiceTime
optional

The minimum amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

string (duration)

name
required

The name of the prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created.

string

namespace
optional

The namespace in which the prepared statement is stored. Currently, only the default namespace is available.

string

node
optional

The node on which the prepared statement is stored.

string

statement
required

The text of the query.

string

uses
required

The count of times the prepared statement has been executed.

integer

requestTime
required

Timestamp when the query was received.

string (date-time)

servicingHost
required

IP address and port number of the node where the query was executed.

string

phaseCounts
required

Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.
Example : { "fetch" : 16, "indexScan" : 187 }

object

phaseOperators
required

Indicates the numbers of each kind of query operator involved in different phases of the query processing.

For instance, a non-covering index path might involve one index scan and one fetch operator. A join would probably involve two or more fetches, one per keyspace. A union select would have twice as many operator counts, one per each branch of the union.

This is in essence the count of all the operators in the executionTimings object.
Example : { "authorize" : 1, "fetch" : 1, "indexScan" : 2 }

object

phaseTimes
required

Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.
Example : { "authorize" : "823.631µs", "fetch" : "656.873µs", "indexScan" : "29.146543ms", "instantiate" : "236.221µs", "parse" : "826.382µs", "plan" : "11.831101ms", "run" : "16.892181ms" }

object

executionTimings
optional

Present only if profile was set to "timings" in the Request Parameters.

The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches.

Execution Timings

#operator
required

Name of the operator.
Example : "Fetch"

string

#stats
required

Statistics collected for the operator.

Statistics

~child
optional

Further nested operators, each with their own execution timings.

object

#itemsIn
optional

Number of input documents to the operator.
Example : 187

integer (int32)

#itemsOut
optional

Number of output documents after the operator processing.
Example : 16

integer (int32)

#phaseSwitches
optional

Number of switches between executing, waiting for services, or waiting for the goroutine scheduler.
Example : 413

integer (int32)

execTime
optional

Time spent executing the operator code inside SQL++ query engine.
Example : "128.434µs"

string (duration)

kernTime
optional

Time spent waiting to be scheduled for CPU time.
Example : "15.027879ms"

string (duration)

servTime
optional

Time spent waiting for another service, such as index or data.

For index scan, it is time spent waiting for GSI/indexer.

For fetch, it is time spent waiting on the KV store.
Example : "1.590934ms"

string (duration)