• [+] expand all

Default Metric Set

This document provides reference documentation for the Default metric set, including suffixes present per metric. If the suffix column contains "N/A" then the base name of the corresponding metric is used with no suffix.

ClusterController Metrics

NameDescriptionUnitSuffixes

cluster-controller.down.count

Number of content nodes down node last, max

cluster-controller.maintenance.count

Number of content nodes in maintenance node last, max

cluster-controller.up.count

Number of content nodes up node last, max

cluster-controller.is-master

1 if this cluster controller is currently the master, or 0 if not binary last, max

cluster-controller.resource_usage.nodes_above_limit

The number of content nodes above resource limit, blocking feed node last, max

cluster-controller.resource_usage.max_memory_utilization

Current memory utilisation, for content node with highest value fraction last, max

cluster-controller.resource_usage.max_disk_utilization

Current disk space utilisation, for content node with highest value fraction last, max

Container Metrics

NameDescriptionUnitSuffixes

http.status.1xx

Number of responses with a 1xx status response rate

http.status.2xx

Number of responses with a 2xx status response rate

http.status.3xx

Number of responses with a 3xx status response rate

http.status.4xx

Number of responses with a 4xx status response rate

http.status.5xx

Number of responses with a 5xx status response rate

jdisc.gc.ms

Time spent in JVM garbage collection millisecond average, max

jdisc.thread_pool.work_queue.capacity

Capacity of the task queue thread max

jdisc.thread_pool.work_queue.size

Size of the task queue thread count, max, min, sum

jdisc.thread_pool.size

Size of the thread pool thread max

jdisc.thread_pool.active_threads

Number of threads that are active thread count, max, min, sum

jdisc.application.failed_component_graphs

JDISC Application failed component graphs item rate

jdisc.singleton.is_active

JDISC Singleton is active item last, max

jdisc.http.ssl.handshake.failure.missing_client_cert

JDISC HTTP SSL Handshake failures due to missing client certificate operation rate

jdisc.http.ssl.handshake.failure.incompatible_protocols

JDISC HTTP SSL Handshake failures due to incompatible protocols operation rate

jdisc.http.ssl.handshake.failure.incompatible_chifers

JDISC HTTP SSL Handshake failures due to incompatible chifers operation rate

jdisc.http.ssl.handshake.failure.unknown

JDISC HTTP SSL Handshake failures for unknown reason operation rate

mem.heap.free

Free heap memory byte average

athenz-tenant-cert.expiry.seconds

Time remaining until Athenz tenant certificate expires second last, max, min

feed.operations

Number of document feed operations operation rate

feed.latency

Feed latency millisecond count, sum

queries

Query volume operation rate

query_latency

The overall query latency as seen by the container millisecond average, count, max, sum

failed_queries

The number of failed queries operation rate

degraded_queries

The number of degraded queries, e.g. due to some content nodes not responding in time operation rate

hits_per_query

The number of hits returned hit_per_query average, count, max, sum

docproc.documents

Number of processed documents document sum

totalhits_per_query

The total number of documents found to match queries hit_per_query average, count, max, sum

serverActiveThreads

Deprecated. Use jdisc.thread_pool.active_threads instead. thread average

Distributor Metrics

NameDescriptionUnitSuffixes

vds.distributor.docsstored

Number of documents stored in all buckets controlled by this distributor document average

vds.bouncer.clock_skew_aborts

Number of client operations that were aborted due to clock skew between sender and receiver exceeding acceptable range operation count

NodeAdmin Metrics

NameDescriptionUnitSuffixes

endpoint.certificate.expiry.seconds

Time until node endpoint certificate expires second N/A

node-certificate.expiry.seconds

Time until node certificate expires second N/A

SearchNode Metrics

NameDescriptionUnitSuffixes

content.proton.documentdb.documents.total

The total number of documents in this documents db (ready + not-ready) document last, max

content.proton.documentdb.documents.ready

The number of ready documents in this document db document last, max

content.proton.documentdb.documents.active

The number of active / searchable documents in this document db document last, max

content.proton.documentdb.disk_usage

The total disk usage (in bytes) for this document db byte last

content.proton.documentdb.memory_usage.allocated_bytes

The number of allocated bytes byte last

content.proton.search_protocol.query.latency

Query request latency (seconds) second average, count, max, sum

content.proton.search_protocol.docsum.latency

Docsum request latency (seconds) second average, count, max, sum

content.proton.search_protocol.docsum.requested_documents

Total requested document summaries document rate

content.proton.resource_usage.disk

The relative amount of disk used by this content node (transient usage not included, value in the range [0, 1]). Same value as reported to the cluster controller fraction average

content.proton.resource_usage.memory

The relative amount of memory used by this content node (transient usage not included, value in the range [0, 1]). Same value as reported to the cluster controller fraction average

content.proton.resource_usage.feeding_blocked

Whether feeding is blocked due to resource limits being reached (value is either 0 or 1) binary last, max

content.proton.transactionlog.disk_usage

The disk usage (in bytes) of the transaction log byte last

content.proton.documentdb.matching.docs_matched

Number of documents matched document rate

content.proton.documentdb.matching.docs_reranked

Number of documents re-ranked (second phase) document rate

content.proton.documentdb.matching.rank_profile.query_latency

Total average latency (sec) when matching and ranking a query second average, count, max, sum

content.proton.documentdb.matching.rank_profile.query_setup_time

Average time (sec) spent setting up and tearing down queries second average, count, max, sum

content.proton.documentdb.matching.rank_profile.rerank_time

Average time (sec) spent on 2nd phase ranking second average, count, max, sum

Sentinel Metrics

NameDescriptionUnitSuffixes

sentinel.totalRestarts

Total number of service restarts done by the sentinel since the sentinel was started restart last, max, sum

Storage Metrics

NameDescriptionUnitSuffixes

vds.filestor.allthreads.put.count

Number of requests processed. operation rate

vds.filestor.allthreads.remove.count

Number of requests processed. operation rate

vds.filestor.allthreads.update.count

Number of requests processed. request rate