Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

XDCR Metrics

    March 23, 2025
    + 12
    A list of the metrics provided by XDCR.

    The following XDCR metrics can be queried by means of the REST APIs described in Statistics.

    Tip

    • The x.y.z badge shows the Couchbase Server version the metric was added in.

    • The type / unit badge shows shows the Prometheus type and unit (if present).

    xdcr_binary_filtered_total     7.2.1 counter

    Number of documents filtered that were binary documents

    xdcr_changes_left_total     7.0.0 gauge

    Given the vBuckets of this node, the number of sequence numbers that need to be processed (either replicated or handled) before catching up to the high sequence numbers for the vBuckets

    xdcr_data_replicated_bytes     7.0.0 counter / bytes

    Amount of data replicated for a Replication

    xdcr_datapool_failed_gets_total     7.0.0 counter

    The total number of failed GET() operation on a reusable datapool within XDCR for the purpose of avoiding garbage generation

    xdcr_dcp_datach_length_total     7.0.0 gauge

    The number of items sent by the Data Service waiting for the XDCR Source Nozzle to ingest and process

    xdcr_dcp_dispatch_time_seconds     7.0.0 gauge / seconds

    The rolling average amount of time it takes for a document to be received by XDCR from the Data Service, to the time it is queued up in the Target Nozzle ready to be sent

    xdcr_deletion_cloned_total     7.2.1 counter

    The number of times a Source Deletion or Expiration is cloned to be written to multiple Target Namespaces

    xdcr_deletion_docs_written_total     7.0.0 counter

    Number of Deletions written to Target

    xdcr_deletion_failed_cr_source_total     7.0.0 counter

    Number of Deletions that failed Source-side Conflict Resolution

    xdcr_deletion_failed_cr_target_total     7.1.0 counter

    Number of Deletions that failed Conflict Resolution at the Target

    xdcr_deletion_filtered_total     7.0.0 counter

    Number of Deletions that were filtered Source-side

    xdcr_deletion_received_from_dcp_total     7.0.0 counter

    Number of Deletions received from the Data Service

    xdcr_docs_checked_total     7.0.0 gauge

    Across vBuckets for this node, the sum of all sequence numbers that have been considered to be checkpointed

    xdcr_docs_cloned_total     7.0.0 counter

    Number of Source Document Mutation cloned to be written to different Target Namespaces

    xdcr_docs_failed_cr_source_total     7.0.0 counter

    Number of documents (or tombstones) that were not replicated to the Target due to Conflict Resolution evaluated on the Source

    xdcr_docs_failed_cr_target_total     7.1.0 counter

    Number of documents failed Conflict Resolution at the Target

    xdcr_docs_filtered_total     7.0.0 gauge

    Total number of documents filtered and not replicated due to any type of filtering

    xdcr_docs_opt_repd_total     7.0.0 counter

    Number of Documents Optimistically Replicated to the Target Cluster

    xdcr_docs_processed_total     7.0.0 gauge

    Number of Documents processed for a Replication

    xdcr_docs_received_from_dcp_total     7.0.0 counter

    Number of Document Mutations received from the Data Service

    xdcr_docs_unable_to_filter_total     7.0.0 gauge

    Number of Document Mutations that couldn't be filtered due to inability to parse the document through Advanced Filtering engine and were not replicated

    xdcr_docs_written_total     7.0.0 counter

    Number of docs Document Mutations written/sent to the Target

    xdcr_expiry_docs_written_total     7.0.0 counter

    Number of Expirations written to the Target

    xdcr_expiry_failed_cr_source_total     7.0.0 counter

    Number of Expirations that failed Source-side Conflict Resolution

    xdcr_expiry_failed_cr_target_total     7.1.0 counter

    Number of Expirations that failed Conflict Resolution at the Target

    xdcr_expiry_filtered_total     7.0.0 counter

    Number of Expirations filtered Source-side

    xdcr_expiry_received_from_dcp_total     7.0.0 counter

    Number of Expirations or documents with TTL received from the Data Service

    xdcr_expiry_stripped_total     7.0.0 counter

    Number of Document Mutations replicated that had the TTL changed to 0 before writing to Target (Source is unmodified)

    xdcr_num_checkpoints_total     7.0.0 counter

    The number of times checkpoint operation has completed successfully since this XDCR process instance is made aware of this replication

    xdcr_num_failedckpts_total     7.0.0 counter

    The number of times checkpoint operation has encountered an error since this XDCR process instance is made aware of this replication

    xdcr_pipeline_errors     7.2.1 gauge

    The number of currently present errors for a specific Replication Pipeline

    xdcr_pipeline_status     7.2.1 gauge

    The pipeline status for a specific pipeline, where it could be paused, running or, error

    xdcr_resp_wait_time_seconds     7.0.0 gauge / seconds

    The rolling average amount of time it takes from when a MemcachedRequest is created to be ready to route to an outnozzle to the time that the response has been heard back from the target node after a successful write

    xdcr_set_docs_written_total     7.0.0 counter

    Number of Set operations successfully written to the Target

    xdcr_set_failed_cr_target_total     7.1.0 counter

    Number of Set operations that failed Conflict Resolution at the Target

    xdcr_set_filtered_total     7.0.0 counter

    Number of documents filtered that was of a DCP mutation

    xdcr_set_received_from_dcp_total     7.0.0 counter

    Number of Sets received from the Data Service

    xdcr_size_rep_queue_bytes     7.0.0 gauge / bytes

    Amount of data being queued to be sent in a Target Nozzle

    xdcr_target_eaccess_total     7.2.1 counter

    The total number of EACCESS errors returned from the target node.

    xdcr_target_tmpfail_total     7.2.1 counter

    The total number of TMPFAIL errors returned from the target node.

    xdcr_throttle_latency_seconds     7.0.0 gauge / seconds

    The rolling average of the latency time introduced due to bandwith throttler

    xdcr_throughput_throttle_latency_seconds     7.0.0 gauge / seconds

    The rolling average of the latency time introduced due to throughput throttler

    xdcr_time_committing_seconds     7.0.0 gauge / seconds

    The rolling average amount of time it takes for a checkpoint operation to complete

    xdcr_wtavg_docs_latency_seconds     7.0.0 gauge / seconds

    The rolling average amount of time it takes for the source cluster to receive the acknowledgement of a SET_WITH_META response after the Memcached request has been composed to be processed by the XDCR Target Nozzle

    xdcr_wtavg_meta_latency_seconds     7.0.0 gauge / seconds

    The rolling average amount of time it takes once a getMeta command is composed to be sent to the time the request is handled once the target node has responded