diff --git a/content/admin/picts/dcp-queue-stats.png b/content/admin/picts/dcp-queue-stats.png new file mode 100644 index 0000000000..25bf6e2e52 Binary files /dev/null and b/content/admin/picts/dcp-queue-stats.png differ diff --git a/content/admin/picts/index-queue-stats.png b/content/admin/picts/index-queue-stats.png new file mode 100644 index 0000000000..9b0f7e8bd5 Binary files /dev/null and b/content/admin/picts/index-queue-stats.png differ diff --git a/content/admin/picts/query-queue-stats.png b/content/admin/picts/query-queue-stats.png new file mode 100644 index 0000000000..c7947e2e74 Binary files /dev/null and b/content/admin/picts/query-queue-stats.png differ diff --git a/content/admin/picts/web-console-server-stats-summary.png b/content/admin/picts/web-console-server-stats-summary.png index cbcb3bd579..6dc83b45e4 100644 Binary files a/content/admin/picts/web-console-server-stats-summary.png and b/content/admin/picts/web-console-server-stats-summary.png differ diff --git a/content/administrator-guide.ditamap b/content/administrator-guide.ditamap index 1faa9c02a1..14decb1d43 100644 --- a/content/administrator-guide.ditamap +++ b/content/administrator-guide.ditamap @@ -53,6 +53,7 @@ + diff --git a/content/monitoring/ui-monitoring-statistics.dita b/content/monitoring/ui-monitoring-statistics.dita index cc889bf452..c30a6088fa 100644 --- a/content/monitoring/ui-monitoring-statistics.dita +++ b/content/monitoring/ui-monitoring-statistics.dita @@ -39,294 +39,771 @@
  • Individual Server Selection
-

Clicking the blue triangle next to any of the smaller statistics graphs enables you to show the - selected statistic individual for each server within the cluster, instead of aggregating the - information for the entire cluster.

- -
Individual bucket monitoring - -

Bucket monitoring within the Couchbase Web - Console has been updated to show additional detailed information. The following statistic groups - are available for Couchbase bucket types.

    -
  • Summary
    • -

The summary section provides a quick overview of the cluster activity.

    -
  • vBucket Resources
    • -

This section provides detailed information on the vBucket resources across the cluster, - including the active, replica and pending operations.

    -
  • Disk Queues
    • -

Disk queues show the activity on the backend disk storage used for persistence within a - data bucket. The information displayed shows the active, replica and pending activity.

    -
  • TAP Queues
    • -

The TAP queues section provides information on the activity within the TAP queues across - replication, rebalancing and client activity.

    -
  • XDCR Destination
    • -

The XDCR Destination section show you statistical information about the Cross Datacenter - Replication (XDCR), if XDCR has been configured.

    -
  • View Stats
    • -

The View Stats section lets you monitor the statistics for each production view - configured within the bucket or system.

    -
  • Top Keys
    • -

This shows a list of the top 10 most actively used keys within the selected data - bucket.

For Memcached bucket types, the Memcached statistic summary is provided.

-
Bucket monitoring — summary statistics

The summary section is designed - to provide a quick overview of the cluster activity. Each graph (or selected graph) shows - information based on the currently selected bucket.

+ +
+ Individual Bucket Monitoring +

Bucket monitoring within the Couchbase Web Console has been updated to show additional + detailed information. The following statistic groups are available for Couchbase bucket + types.

+
    +
  • Summary - The summary section + provides a quick overview of the cluster activity.
    • +
+
    +
  • vBucket Resources - This section + provides detailed information on the vBucket resources across the cluster, including the + active, replica and pending operations.
    • +
+
    +
  • Disk Queues - Disk queues show the + activity on the backend disk storage used for persistence within a data bucket. The information + displayed shows the active, replica and pending activity.
    • +
+
    +
  • TAP Queues - This section provides + information on the activity within the TAP queues across replication, rebalancing and client + activity.
    • +
  • DCP Queues - This section provides + show information about the DCP connections activity for the bucket.
    • +
  • View Stats - This section lets you + monitor the statistics for each production view configured within the bucket or system.
    • +
+
    +
  • Index Statistics
    • +
  • Query Statistics
    • +
+
    +
  • XDCR Destination - The + XDCR Destination section show you statistical information about the Cross Datacenter + Replication (XDCR), if XDCR has been configured.
    • +
+
    +
  • Top Keys - This section shows a list of the top 10 most actively used keys within the + selected data bucket.
    • +
+

For Memcached bucket types, the Memcached statistic summary is provided.

+
+
+ Bucket Monitoring — Summary Statistics +

The summary section is designed to provide a quick overview of the cluster activity. Each + graph (or selected graph) shows information based on the currently selected bucket.

- -

The following graph types are available:

- -
- -
ops per second
-
The total number of operations per second on this bucket.
- - -
cache miss ratio
-
Ratio of reads per second to this bucket which required a read from disk rather than - RAM.
- - -
creates per second
-
Number of new items created in this bucket per second.
- - -
updates per second
-
Number of existing items updated in this bucket per second.
- - -
XDCR ops per sec
-
Number of XDCR related operations per second for this bucket.
- - -
disk reads per sec
-
Number of reads per second from disk for this bucket.
- - -
temp OOM per sec
-
Number of temporary out of memory conditions per second.
- - -
gets per second
-
Number of get operations per second.
- - -
sets per second
-
Number of set operations per second.
- - -
deletes per second
-
Number of delete operations per second.
- - -
items
-
Number of items (documents) stored in the bucket.
- - -
disk write queue
-
Size of the disk write queue.
- - -
docs data size
-
Size of the stored document data.
- - -
docs total disk size
-
Size of the persisted stored document data on disk.
- - -
doc fragmentation %
-
Document fragmentation of persisted data as stored on disk.
- - -
XDC replication queue
-
Size of the XDCR replication queue.
- - -
total disk size
-
Total size of the information for this bucket as stored on disk, including persisted and view index data.
- - -
views data size
-
Size of the view data information.
- - -
views total disk size
-
Size of the view index information as stored on disk.
- - -
views fragmentation %
-
Percentage of fragmentation for a given view index.
- - -
view reads per second
-
Number of view reads per second.
- - -
memory used
-
Amount of memory used for storing the information in this bucket.
- - -
high water mark
-
High water mark for this bucket (based on the configured bucket RAM quota).
- - -
low water mark
-
Low water mark for this bucket (based on the configured bucket RAM quota).
- - -
disk update time
-
Time required to update data on disk.
- -
- +

The following statistics are available:

+

+ + + + + + + Statistic + Description + + + + + ops per second + The total number of operations per second on this bucket. + + + cache miss ratio + Ratio of reads per second to this bucket which required a read from disk rather than + RAM. + + + gets per sec. + Number of get operations per second from this bucket. + + + sets per sec. + Number of set operations per second to this bucket. + + + deletes per sec. + Number of delete operations per second for this bucket. + + + CAS ops per sec. + Number of operations with a CAS identification per second for this bucket. + + + active docs resident % + The percentage of active items cached in RAM in this bucket. + + + items + Number of unique items (documents) stored in the bucket. + + + temp OOM per sec. + Number of temporary out of memory conditions per second. + + + low water mark + Low water mark for this bucket (based on the configured bucket RAM quota). + + + high water mark + High water mark for this bucket (based on the configured bucket RAM quota). + + + memory used + The memory used as measured from mem_used. + + + disk creates per sec. + Number of new items created on disk per second for this bucket. + + + disk updates per sec. + Number of items updated on disk per second for this bucket. + + + disk reads per sec. + Number of reads per second from disk for this bucket. + + + disk write queue + Number of items waiting to be written on disk in this bucket. + + + docs data size + Size of the stored document data. + + + docs total disk size + Size of the persisted stored document data on disk. + + + doc fragmentation % + Document fragmentation of persisted data as stored on disk. + + + total disk size + Total size of the information for this bucket as stored on disk, including persisted + and view index data. + + + view data size + Size of the view data information. + + + views total disk size + Size of the view index information as stored on disk. + + + views fragmentation % + Percentage of fragmentation for a given view index. + + + view reads per sec. + Number of view reads per second. + + + disk update time + The time required to update data on disk. + + + disk commit time + The time required to commit data on disk. + + + bg wait time + The average background fetch time in microseconds. + + + Incoming XDCR ops/sec. + The incoming XDCR operations per second for this bucket. + + + Intra-replication queue + Number of items remaining to be sent to consumer in this bucket. + + + N1QL queries/sec + Number of N1QL requests processed per second. + + + index data size + The data size consumed by the index. + + + index disk size + The total disk sized consumed by the index. + + + index fragmentation % + The percentage fragmentation of the index. + + + index scanned/sec + Number of index items scanned by the indexer per second. + + + fts bytes indexed/sec + Number of full text search bytes indexed per second. + + + fts queries/sec + Number of full text search queries per second. + + + fts disk size + The total full text search disk size for this bucket. + + + avg active drift/mutation + Average drift (in seconds) per mutation on active vBuckets. + + + avg replica drift/mutation + Average drift (in seconds) per mutation on replica vBuckets. + + + active ahead exceptions/sec + Total number of ahead exceptions all active vBuckets. + + + replica ahead exceptions/sec + Total number of ahead exceptions all replica vBuckets. + + + creates per second + Number of new items created in this bucket per second. + + + updates per second + Number of existing items updated in this bucket per second. + + + XDCR ops per sec + Number of XDCR related operations per second for this bucket. + + + disk reads per sec + Number of reads per second from disk for this bucket. + + + disk write queue + Size of the disk write queue. + + + XDC replication queue + Size of the XDCR replication queue. + + + memory used + Amount of memory used for storing the information in this bucket. + + + +
+

- - -
Monitoring vBucket resources

The vBucket statistics provide information - for all vBucket types within the cluster across three different states. Within the statistic - display the table of statistics is organized in four columns, showing the Active, Replica and - Pending states for each individual statistic. The final column provides the total value for each - statistic.

- - -

The Active column displays the information for vBuckets within the - Active state. The Replica column displays the statistics for vBuckets within the Replica state - (that is currently being replicated). The Pending columns shows statistics for vBuckets in the +

Monitoring vBucket Resources

The vBucket statistics + provide information for all vBucket types within the cluster across three different states. + Within the statistic display the table of statistics is organized in four columns, showing the + Active, Replica and Pending states for each individual statistic. The last column provides the + total value for each statistic.

+ +

The Active column displays the information for vBuckets within the Active state. The + Replica column displays the statistics for vBuckets within the Replica state (that is + currently being replicated). The Pending columns shows statistics for vBuckets in the Pending state, that is while data is being exchanged during rebalancing.

These states are - shared across all the following statistics. For example, the graph new items per - sec within the Active state column displays the number of new items - per second created within the vBuckets that are in the active state.

The individual - statistics, one for each state, shown are:

    -
  • vBuckets
    • -

The number of vBuckets within the specified state.

    -
  • items
    • -

Number of items within the vBucket of the specified state.

    -
  • resident %
    • -

Percentage of items within the vBuckets of the specified state that are resident (in - RAM).

    -
  • new items per sec.
    • -

Number of new items created in vBuckets within the specified state. Note that new items - per second is not valid for the Pending state.

    -
  • ejections per second
    • -

Number of items ejected per second within the vBuckets of the specified state.

    -
  • user data in RAM
    • -

Size of user data within vBuckets of the specified state that are resident in RAM.

    -
  • metadata in RAM
    • -

Size of item metadata within the vBuckets of the specified state that are resident in - RAM.

- -
Monitoring disk queues

The Disk Queues statistics section displays the - information for data being placed into the disk queue. Disk queues are used within Couchbase - Server to store the information written to RAM on disk for persistence. Information is displayed - for each of the disk queue states, Active, Replica and Pending.

- -

The Active column displays the information for the Disk Queues within - the Active state. The Replica column displays the statistics for the Disk Queues within the - Replica state (that is currently being replicated). The Pending columns shows statistics for the - disk Queues in the Pending state, that is while data is being exchanged during + shared across all the following statistics. For example, the graph new items per sec + within the Active state column displays the number of new items per second created within + the vBuckets that are in the active state.

The individual statistics, one for each state, + shown are:

+ + + + + + + Statistic + Description + + + + + vBuckets + The number of vBuckets within the specified state. + + + items + Number of items within the vBucket of the specified state. + + + resident % + +

Percentage of items within the vBuckets of the specified state that are resident (in + RAM).

+ + + + new items per sec. + Number of new items created in vBuckets within the specified state.

+ The new items per second is not valid for the Pending state. +

+ + + ejections per sec. + Number of items ejected per second within the vBuckets of the specified + state. + + + user data in RAM + Size of user data within vBuckets of the specified state that are resident in + RAM. + + + metadata in RAM + Size of item metadata within the vBuckets of the specified state that are resident in + RAM. + + + +
+

+
Monitoring Disk Queues

The Disk Queues statistics + section displays the information for data being placed into the disk queue. Disk queues are used + within Couchbase Server to store the information written to RAM on disk for persistence. + Information is displayed for each of the disk queue states, Active, Replica, and Pending.

+ +

The Active column displays the information for the Disk Queues within the Active state. + The Replica column displays the statistics for the Disk Queues within the Replica state + (that is currently being replicated). The Pending columns shows statistics for the disk + Queues in the Pending state, that is while data is being exchanged during rebalancing.

These states are shared across all the following statistics. For example, the - graph fill rate within the Replica state column displays the - number of items being put into the replica disk queue for the selected bucket.

The - displayed statistics are:

    -
  • items
    • -

The number of items waiting to be written to disk for this bucket for this state.

    -
  • fill rate
    • -

The number of items per second being added to the disk queue for the corresponding - state.

    -
  • drain rate
    • -

Number of items actually written to disk from the disk queue for the corresponding - state.

    -
  • average age
    • -

The average age of items (in seconds) within the disk queue for the specified - state.

- -
Monitoring TAP queues

The TAP queues statistics are designed to show - information about the TAP queue activity, both internally, between cluster nodes and clients. - The statistics information is therefore organized as a table with columns showing the statistics - for TAP queues used for replication, rebalancing and clients.

- - -

The statistics in this section are detailed below:

    -
  • TAP senders
    • -

Number of TAP queues in this bucket for internal (replica), rebalancing or client - connections.

    -
  • items
    • -

Number of items in the corresponding TAP queue for this bucket.

    -
  • drain rate
    • -

Number of items per second being sent over the corresponding TAP queue connections to - this bucket.

    -
  • back-off rate
    • -

Number of back-offs per second sent when sending data through the corresponding TAP - connection to this bucket.

    -
  • backfill remaining
    • -

Number of items in the backfill queue for the corresponding TAP connection for this - bucket.

    -
  • remaining on disk
    • -

Number of items still on disk that need to be loaded in order to service the TAP - connection to this - bucket.

- -
Memcached buckets

For Memcached buckets, Web Console displays a - separate group of statistics:

- -

The Memcached statistics are:

    -
  • Operations per sec.
    • -

Total operations per second serviced by this bucket

    -
  • Hit Ratio %
    • -

Percentage of get requests served with data from this bucket

    -
  • Memory bytes used
    • -

Total amount of RAM used by this bucket

    -
  • Items count
    • -

Number of items stored in this bucket

    -
  • RAM evictions per sec.
    • -

Number of items per second evicted from this bucket

    -
  • Sets per sec.
    • -

Number of set operations serviced by this bucket

    -
  • Gets per sec.
    • -

Number of get operations serviced by this bucket

    -
  • Net. bytes TX per sec
    • -

Number of bytes per second sent from this bucket

    -
  • Net. bytes RX per sec.
    • -

Number of bytes per second sent into this bucket

    -
  • Get hits per sec.
    • -

Number of get operations per second for data that this bucket contains

    -
  • Delete hits per sec.
    • -

Number of delete operations per second for data that this bucket contains

    -
  • Incr hits per sec.
    • -

Number of increment operations per second for data that this bucket contains

    -
  • Decr hits per sec.
    • -

Number of decrement operations per second for data that this bucket contains

    -
  • Delete misses per sec.
    • -

Number of delete operations per second for data that this bucket does not contain

    -
  • Decr misses per sec.
    • -

Number of decr operations per second for data that this bucket does not contain

    -
  • Get Misses per sec.
    • -

Number of get operations per second for data that this bucket does not contain

    -
  • Incr misses per sec.
    • -

Number of increment operations per second for data that this bucket does not contain

    -
  • CAS hits per sec.
    • -

Number of CAS operations per second for data that this bucket contains

    -
  • CAS badval per sec.
    • -

Number of CAS operations per second using an incorrect CAS ID for data that this bucket - contains

    -
  • CAS misses per sec.
    • -

Number of CAS operations per second for data that this bucket does not - contain

+ graph fill rate within the Replica state column displays the number of items being + put into the replica disk queue for the selected bucket.

The displayed statistics are:

+

+ + + + + + + Statistic + Description + + + + + items + The number of items waiting to be written to disk for this bucket for this + state. + + + fill rate + The number of items per second being added to the disk queue for the corresponding + state. + + + drain rate + The number of items actually written to disk from the disk queue for the + corresponding state. + + + average age + The average age of items (in seconds) within the disk queue for the specified + state. + + + +
+

+
Monitoring TAP Queues

The TAP queues statistics are + designed to show information about the TAP queue activity, both internally, between cluster + nodes and clients. The statistics information is therefore organized as a table with columns + showing the statistics for TAP queues used for replication, rebalancing, and clients.

+ +

The statistics in this section are detailed below:

+

+ + + + + + + Statistic + Description + + + + + TAP senders + Number of TAP queues in this bucket for internal (replica), rebalancing or client + connections. + + + items + Number of items in the corresponding TAP queue for this bucket. + + + fill rate + Number of items per second being added to the TAP queue for the corresponding to this + bucket. + + + drain rate + Number of items per second being sent over the corresponding TAP queue connections to + this bucket. + + + back-off rate + Number of back-offs per second sent when sending data through the corresponding TAP + connection to this bucket. + + + backfill remaining + Number of items in the backfill queue for the corresponding TAP connection for this + bucket. + + + remaining on disk + Number of items still on disk that need to be loaded in order to service the TAP + connection to this bucket. + + + +
+

+
Monitoring DCP QueuesThe DCP + queues statistics are designed to show information about the DCP connections activity for the + bucket. The statistics information is therefore organized as a table with columns showing the + statistics for DCP queues used for replication, XDCR, views/indexes, and other.

The statistics are + detailed below:

+ + + + + + + Statistic + Description + + + + + DCP connections + Number of internal replication DCP connections in this bucket. + + + DCP senders + Number of replication senders for this bucket. + + + items remaining + Number of items remaining to be sent to consumer in this bucket. + + + drain rate items/sec + Number of items per second being sent for a producer for this bucket. + + + drain rate bytes/sec + Number of bytes per second being sent for replication DCP connections for this + bucket. + + + backoffs/sec + Number of backoffs for replication DCP connections. + + + +
+

+
Monitoring View Statistics

The View Stats show + information about individual design documents within the selected bucket. One block of stats + will be shown for each production-level design document.

+ +

The statistics shown are:

+ + + + + + + Statistics + Description + + + + + data size + Size of the data required for this design document. + + + disk size + Size of the stored index as stored on disk. + + + view reads per sec. + Number of read operations per second for this view. + + + +
+

+
Monitoring Index Statistics

The statistics in this + section are detailed below:

+ + + + + + + Statistic + Description + + + + + items scanned/sec + Number of index items scanned by the indexer per second. + + + disk size + Total disk file size consumed by the index. + + + data size + Actual data size consumed by the index. + + + total items remaining + Number of documents pending to be indexed. + + + drain rate items/sec + Number of documents indexed by the indexer per second. + + + total indexed items + The current total document count. + + + average item size + The average size of each index item. + + + % fragmentation + Percentage fragmentation of the index. + + + requests/sec + Number of requests served by the indexer per second. + + + bytes returned/sec + Number of bytes per second read by a scan. + + + avg scan latency(ns) + The average time to serve a scan request in nanoseconds. + + + +
+

+
Memcached Buckets

For Memcached buckets, Web + Console displays a separate group of statistics:

+ +

The Memcached statistics are:

+

+ + + + + + + Statistic + Description + + + + + Operations per sec. + Total operations per second serviced by this bucket. + + + Hit Ratio % + Percentage of get requests served with data from this bucket. + + + Memory bytes used + Total amount of RAM used by this bucket. + + + Items count + Number of items stored in this bucket. + + + RAM evictions per sec. + Number of items per second evicted from this bucket. + + + Sets per sec. + Number of set operations serviced by this bucket. + + + Gets per sec. + Number of get operations serviced by this bucket. + + + Net. bytes TX per sec + Number of bytes per second sent from this bucket. + + + Net. bytes RX per sec. + Number of bytes per second sent into this bucket. + + + Get hits per sec. + Number of get operations per second for data that this bucket contains. + + + Delete hits per sec. + Number of delete operations per second for data that this bucket contains + + + Incr hits per sec. + Number of increment operations per second for data that this bucket contains. + + + Decr hits per sec. + Number of decrement operations per second for data that this bucket contains. + + + Delete misses per sec. + +

Number of delete operations per second for data that this bucket does not contain.

+ + + + Decr misses per sec. + Number of decrement operations per second for data that this bucket does not + contain. + + + Get misses per sec. + Number of get operations per second for data that this bucket does not + contain. + + + Incr misses per sec. + +

Number of increment operations per second for data that this bucket does not contain.

+ + + + CAS hits per sec. + Number of CAS operations per second for data that this bucket contains. + + + CAS badval per sec. + Number of CAS operations per second using an incorrect CAS ID for data that this + bucket contains. + + + CAS misses per sec. + Number of CAS operations per second for data that this bucket does not + contain. + + + +

+
Monitoring Query Statistics

The statistics in this + section are detailed below:

+ + + + + + + Statistic + Description + + + + + requests/sec + Number of N1QL requests processed per second. + + + selects/sec + Number of N1QL selects processed per second. + + + request time(sec) + The average end-to-end time to process a query in seconds. + + + service time(sec) + The average time to execute a query in seconds. + + + result size + The average size in bytes of the data returned by the query. + + + errors + The number of N1QL errors returned per second. + + + warnings + The number of N1QL warnings returned per second. + + + result count + The average number of results (documents) returned by a query. + + + queries > 250ms + Number of queries that take longer than 250ms. + + + queries > 5000ms + Number of queries that take longer than 500ms. + + + queries > 1000ms + Number of queries that take longer than 1000ms. + + + queries > 5000ms + Number of queries that take longer than 5000ms. + + + invalid requests/sec + Number of requests for unsupported endpoints per second. + + + +
+

-
Monitoring outgoing XDCR

The Outgoing XDCR shows the XDCR operations - that are supporting cross datacenter replication from the current cluster to a destination - cluster.

You can monitor the current status for all - active replications in the Ongoing Replications section under the XDCR - tab:

- -

The Ongoing Replications section shows the following - information:

+
Monitoring Outgoing XDCR

The Outgoing XDCR + shows the XDCR operations that are supporting cross datacenter replication from the current + cluster to a destination cluster.

You can monitor the current status for all active + replications in the Ongoing Replications section under the XDCR tab:

+ +

The Ongoing Replications section shows the following information:

+ - Column + + Column + Description @@ -372,83 +849,144 @@ you have multiple replication streams you will see statistics for each stream.

- outbound xdcr stats 2.2 - -

The statistics shown are:

    -
  • outbound XDCR mutation
    • -

Number of changes in the queue waiting to be sent to the destination cluster.

    -
  • mutations checked
    • -

Number of document mutations checked on source cluster.

    -
  • mutations replicated
    • -

Number of document mutations replicated to the destination cluster.

    -
  • data replicated
    • -

Size of data replicated in bytes.

    -
  • active vb reps
    • -

Number of parallel, active vBucket replicators. Each vBucket has one replicator which can - be active or waiting. By default you can only have 32 parallel active replicators at once per - node. Once an active replicator finishes, it will pass a token to a waiting replicator.

    -
  • waiting vb reps
    • -

Number of vBucket replicators that are waiting for a token to replicate.

    -
  • secs in replicating
    • -

Total seconds elapsed for data replication for all vBuckets in a cluster.

    -
  • secs in checkpointing
    • -

Time working in seconds including wait time for replication.

    -
  • checkpoints issued
    • -

Total number of checkpoints issued in replication queue. By default active vBucket - replicators issue a checkpoint every 30 minutes to keep track of replication progress.

    -
  • checkpoints failed
    • -

Number of checkpoints failed during replication. This can happen due to timeouts, due to - network issues or if a destination cluster cannot persist quickly enough.

    -
  • mutations in queue
    • -

Number of document mutations waiting in replication queue.

    -
  • XDCR queue size
    • -

Amount of memory used by mutations waiting in replication queue. In bytes.

    -
  • mutation replication rate
    • -

Number of mutations replicated to destination cluster per second.

    -
  • data replication rate
    • -

Bytes replicated to destination per second.

    -
  • ms meta ops latency
    • -

Weighted average time for requesting document metadata. In milliseconds.

    -
  • mutations replicated optimistically
    • -

Total number of mutations replicated with optimistic XDCR.

    -
  • ms docs ops latency
    • -

Weighted average time for sending mutations to destination cluster. In milliseconds.

    -
  • percent completed
    • -

Percent of total mutations checked for metadata.

Be aware that if you use an - earlier version of Couchbase Server, such as Couchbase Server 2.0, only the first three - statistics appear and have the labels changes queue, documents checked, and documents - replicated respectively. You can also get XDCR statistics using the Couchbase REST API. All - of the statistics in Web Console are based on statistics via the REST API or values derived from - them.

- - -
Monitoring incoming XDCR

The Incoming XDCR section shows the XDCR - operations that are coming into to the current cluster from a remote cluster.

- -

The statistics shown are:

    -
  • metadata reads per sec.
    • -

Number of documents XDCR scans for metadata per second. XDCR uses this information for - conflict resolution.

    -
  • sets per sec.
    • -

Set operations per second for incoming XDCR data.

    -
  • deletes per sec.
    • -

Delete operations per second as a result of the incoming XDCR data stream.

    -
  • total ops per sec.
    • -

Total of all the operations per - second.

- -
Monitoring view statistics

The View statistics show information about - individual design documents within the selected bucket. One block of stats will be shown for - each production-level design document.

- - -

The statistics shown are:

    -
  • data size
    • -

Size of the data required for this design document.

    -
  • disk size
    • -

Size of the stored index as stored on disk.

    -
  • view reads per sec.
    • -

Number of read operations per second for this view.

+ + outbound xdcr stats 2.2 + +

The statistics shown are:

+ + + + + + Statistic + Description + + + + + outbound XDCR mutation + Number of changes in the queue waiting to be sent to the destination cluster. + + + mutations checked + Number of document mutations checked on source cluster. + + + mutations replicated + Number of document mutations replicated to the destination cluster. + + + data replicated + Size of data replicated in bytes. + + + active vb reps + Number of parallel, active vBucket replicators. Each vBucket has one replicator which + can be active or waiting. By default you can only have 32 parallel active replicators at + once per node. Once an active replicator finishes, it will pass a token to a waiting + replicator. + + + waiting vb reps + Number of vBucket replicators that are waiting for a token to replicate. + + + secs in replicating + +

Total seconds elapsed for data replication for all vBuckets in a cluster.

+ + + + secs in checkpointing + Time working in seconds including wait time for replication. + + + checkpoints issued + Total number of checkpoints issued in replication queue. By default active vBucket + replicators issue a checkpoint every 30 minutes to keep track of replication + progress. + + + checkpoints failed + Number of checkpoints failed during replication. This can happen due to timeouts, due + to network issues or if a destination cluster cannot persist quickly enough. + + + mutations in queue + Number of document mutations waiting in replication queue. + + + XDCR queue size + Amount of memory used by mutations waiting in replication queue. In bytes. + + + mutation replication rate + Number of mutations replicated to destination cluster per second. + + + data replication rate + Bytes replicated to destination per second. + + + ms meta ops latency + Weighted average time for requesting document metadata in milliseconds. + + + mutations replicated optimistically + Total number of mutations replicated with optimistic XDCR. + + + ms docs ops latency + Weighted average time for sending mutations to destination cluster in + milliseconds. + + + percent completed + Percent of total mutations checked for metadata. + + + +

Be aware that if you use an earlier version of Couchbase Server, such as + Couchbase Server 2.0, only the first three statistics appear and have the labels changes + queue, documents checked, and documents replicated respectively. You can also get XDCR + statistics using the Couchbase REST API. All of the statistics in Web Console are based on + statistics via the REST API or values derived from them.

+
Monitoring Incoming XDCR

The Incoming XDCR + Operations section shows the XDCR operations that are coming into to the current cluster + from a remote cluster.

+ +

The statistics shown are:

+ + + + + + Statistic + Description + + + + + metadata reads per sec. + Number of documents XDCR scans for metadata per second. XDCR uses this information + for conflict resolution. + + + sets per sec. + Set operations per second for incoming XDCR data. + + + deletes per sec. + Delete operations per second as a result of the incoming XDCR data stream. + + + total ops per sec. + Total of all the operations per second. + + + +

+ diff --git a/content/release-notes/relnotes.dita b/content/release-notes/relnotes.dita index 0d1199e497..04c6983869 100644 --- a/content/release-notes/relnotes.dita +++ b/content/release-notes/relnotes.dita @@ -17,6 +17,13 @@ 4000" is returned: "No index available on keyspace default that matches your query. Use CREATE INDEX or CREATE PRIMARY INDEX to create an index, or check that your expected index is online."

+
  • Upgrading Full Text Search (FTS) indexes from 4.5.x to higher version.

    When upgrading + FTS indexes, first save the existing index definition JSON, then remove all full text + indexes. Then upgrade all nodes to the desired version. Once all nodes are upgraded, + recreate the index definitions using the REST API. Note that you need to manually + remove the “byte_array_converter” attribute from the index definition + JSON (see MB-18042).

    • Known Issues diff --git a/content/rest-api/rest-api.ditamap b/content/rest-api/rest-api.ditamap index c2858612e2..3d2528be8c 100644 --- a/content/rest-api/rest-api.ditamap +++ b/content/rest-api/rest-api.ditamap @@ -106,12 +106,7 @@ - - - - - - + diff --git a/content/rest-api/rest-encryption.dita b/content/rest-api/rest-encryption.dita index 7dc9c3d2f6..ab03d03e4d 100644 --- a/content/rest-api/rest-encryption.dita +++ b/content/rest-api/rest-encryption.dita @@ -1,9 +1,104 @@ - Encryption On-the-Wire APICouchbase Server APIs for self-signed and X.509 certificates manage encryption + Encryption On-the-Wire API + Couchbase Server APIs for self-signed and X.509 certificates manage encryption on-the-wire. -

    +
    + Retrieve Node Certificate Info +

    Retrieves information about a node certificate.

    +

    GET /pools/default/certificate/node/<host:port>

    +

    Description

    +

    This command retrieves information about the uploaded node certificate.

    +

    Example +

    + $ curl -X GET http://user:password@127.0.0.1:8091/pools/default/certificate/node/127.0.0.1:8091 + {"subject":"CN=127.0.0.1","expires":"2049-12-31T15:59:59.000Z","pem":" + -----BEGIN CERTIFICATE-----\nMIIC+DCCAeKgAwIBAgIIFB4b2mfRLHcwCwYJKoZIhvcNAQELMCAxHjAcBgNVBAMT\ + nFUludGVtZWRpYXRlIEF1dGhvcml0eTAeFw0xMzAxMDEwMDAwMDBaFw00OTEyMzEy\ + nMzU5NTlaMBQxEjAQBgNVBAMTCTEyNy4wLjAuMTCCASIwDQYJKoZIhvcNAQEBBQAD\ + nggEPADCCAQoCggEBAOO9byay0UjHI4Q1dd4zMgGPc7FkGDaH/5PEj7PdjlnZC6zm\ + ncsjqAyAq9WzI+LAzzfZXm2Da8MwJZX/MsvEcG15CV8bK075D1G4R7B+E+OIG//Xl\ + ntKZe7J0YqsW5KwZlDHWkyJ06ylWl/6hvw3YkG7mUOKi5WWuj8NGHP24cImkaon4+\ + nf8D6t3vEWFQEwb8IMUDgzwdihXdSqdzQ3a9ECKbl2BKeEFbPrzWoIYjWF5dyrZg3\ + n4/3+SHZ+uZzlG2x6cL2lrs7WUJXseasjkSFuQQzLZPIcJlJxlwXhKvfvucbgT9rG\ + nwopcjS3SaXnmreKF3jLmQGAPHYb8X1yCTTBQVLcCAwEAAaNGMEQwDgYDVR0PAQH\ + nBAQDAgCgMBMGA1UdJQQMMAoGCCsGAQUFBwMBMAwGA1UdEwEB/wQCMAAwDwYDVR0R\ + nBAgwBocEfwAAATALBgkqhkiG9w0BAQsDggEBAEEWcC8uJ/Zk/4UFYTrQyvds/Kj8\ + n8/SNWVIcMNLHNsxPGtbrsRa9VFjPlCEB+dPpgIFq08626zRQ2Lb1qRZGWj+YM5gC\ + nhxaERSURrvr6i8x9jwALkQUxitRkNP6cb+wi4BCn8qjgxxyZ4g+CHEO9pHceljIn\ + n/bwY+hHTG0a+8hVj/14TGExFrEzNhyeSMmGpdFq3PNT97gRuVvFAz6ZD8qAt+S0j\ + nT61oShOpwNwhWnkK3OynN2JdVT+G496/xRayDPXG40V/AkJs3udZ6QmoeifkJ8sj\ + nYgOxdPWLMnAJ7fw6l/XE7XVD/Jld+pJrFa4YqHBkWL+s20OQmuWs8dVgVQ0=\n + -----END CERTIFICATE-----\n\n"} +
    +
    + Upload and Regenerate Certificate

    Uploads a pem-encoded root certificate + (cluster CA) to the cluster.

    POST + /controller/uploadClusterCA

    Description

    The uploaded certificate will + be displayed in the UI and used for XDCR replications and for client certificate stores. +

    Examples +

    curl -X POST --data-binary "@/path/root.pem" http://user:password@127.0.0.1:8091/controller/uploadClusterCA curl -X POST --data-binary "@./ca.pem" http://Administrator:password@127.0.0.1:8091/controller/uploadClusterCA

    Returns

    Same + output as in the GET /pools/default/certificate?extended=true method.

    +

    Setting up per node CA certificate

    + curl -X POST http://Administrator:password@127.0.0.1:8091/node/controller/reloadCertificate +

    +

    Regenerating a self-signed certificate

    If you configured Couchbase to use + X.509 certificates, and you want to go back to the self-signed certificates, you can do this + by regenerating the self-signed cluster certificate test.pem.

    + curl -X POST http://Administrator:password@remoteHost:8091/controller/regenerateCertificate +

    +
    + Return Cluster Certificate

    Returns the current cluster certificate. +

    GET /pools/default/certificate

    Description

    If you include + the parameter extended=true, it returns the extended certificate information: + {"cert": {"type" : ..., "pem" : ..., "subject" : ..., "expires" : ...}, warnings: []}

    Parameters

      +
    • type - generated or uploaded.
      • +
    • pem - pem encoded certificate.
      • +
    • subject - abbreviated certificate subject (*).
      • +
    • expires - expiration data (*).
      • +
    • warnings - warnings to be displayed in the UI.
      • +

    (*) not available for generated certificates.

    Example

    $ curl -X GET http://user:password@127.0.0.1:8091/pools/default/ + certificate?extended=true{"cert":{"type":"uploaded","pem":"-----BEGIN CERTIFICATE----- + \nMIIC6DCCAdKgAwIBAgIIFB4YAjF90MgwCwYJKoZIhvcNAQELMBkxFzAVBgNVBAMT\ + nDlJvb3QgQXV0aG9yaXR5MB4XDTEzMDEwMTAwMDAwMFoXDTQ5MTIzMTIzNTk1OVow\ + nGTEXMBUGA1UEAxMOUm9vdCBBdXRob3JpdHkwggEiMA0GCSqGSIb3DQEBAQUAA4IB\ + nDwAwggEKAoIBAQDBum06stdiYQI2HQyjZeg3s0Pz8CziXqSg4GicaeKNloOfASwl\ + n+8LQDX5Dgb+Mc4ZxXYo9/7eVlsvSiZPZcv9D2pubjR4ZtEDY5t9AlXDiYTHK0zxG\ + nB34Llnz3gJmkAEAsjy4g+RfwpJS4kGVzFhrzgxOQJIJogZnLduk+mHFjyXI3X+8y\ + nf4KF8ijrXP8bbfa0kM1tjvcttaK7vTEP+G/mbOEFZErhScXT9eKRlgwsitaH7kI0\ + nimpqg3YX1znLQ5n+eLzeVR1HhszJrFaaaRHL0esml6jLEcZBBitJSuEuaMLp9ZWB\ + nA479ZHmN/vZc1SwfMrCE2+TE0ytW3O7eFXjXAgMBAAGjODA2MA4GA1UdDwEB/wQE\ + nAwIApDATBgNVHSUEDDAKBggrBgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MAsGCSqG\ + nSIb3DQEBCwOCAQEACReNkvIXhjPO0rWpgdVSqnLrjUb6DJf0n4Uyq6PfukeEfBtF\ + n59L+xUcoY6NFM5N6qRlGgg0eqTCVmQ6N6lKnnZRH23g3BPLjU2EqAtBHIc5f2JoM\ + nd1E4UD2v20MlFoeHL0YljGTywlqStoZYc2uYUJnJAVq2D1dWcwP2S7G6caLHMlAl\ + nQVYIZvjCGuqGckV1EqOTT7uKPH9ulljtYKVIq/aTbINjX0hJsaoN2hOfHVTp2Shq\ + neLMwgfNdg6zWRyeL/Mi/3jmSjSH61zyHva2xlY8Pl6Zurx/+pF1qN27+P8tCjsDO\ + nD2hAADXr8WRqC1Sd+xAGcFkvqOOFv/HRxDej3A==\ + n-----END CERTIFICATE-----\n", + "subject":"CN=Root Authority","expires":"2049-12-31T15:59:59.000Z"}, + "warnings":[{"node":"n_0@127.0.0.1","message": + "Certificate is not signed with cluster CA."}]} +

    Possible + warnings:

    {"node":"n_0@127.0.0.1","message":"Certificate is not signed with cluster CA."}{"node":"n_0@127.0.0.1","message":"Certificate is expired."}{"node":"n_0@127.0.0.1","message":"Certificate will expire soon.","expires":"2049-12-31T15:59:59.000Z"}
    +
    Apply Certificate to a Node

    Takes chain.pem and + pkey.pem and applies to a node.

    POST + /node/controller/reloadCertificate

    Description

    This command grabs + chain.pem and pkey.pem from the data + folder/inbox/ directory and applies them to the node.

    Parameters

      +
    • chain.pem - Contains a chain of pem-encoded certificates starting from + the node certificate and ending with the last intermediate certificate that precedes the + cluster certificate.
      • +
    • pkey.pem - Contains the pem-encoded private key for the node + certificate.
      • +

    Example

    curl -X POST http://user:password@127.0.0.1:8091/node/controller/reloadCertificate

    Returns

      +
    • 200 - If it is a success
      • +
    • 400 - An error message if it failed.
      • +
    diff --git a/content/troubleshooting/core-files.dita b/content/troubleshooting/core-files.dita new file mode 100644 index 0000000000..b6f1e67a3c --- /dev/null +++ b/content/troubleshooting/core-files.dita @@ -0,0 +1,57 @@ + + + + Core Files + When a process panics, a core dump occurs and the system creates a core file. These files are intended for troubleshooting and to help diagnose faults. +
    Couchbase Core Files Policies +

    In most Linux distributions, the core file creation is disabled by default for a normal user. However, this setting can be changed easily. The operating system administrator can configure the hard or soft limits, and Couchbase Server will honor the core file settings.

    +

    Setting up your system to retain core files varies a bit based on the operating system. + However, you can consider the following general guidelines to preserve cores generated by + Couchbase Server processes.

      +
    • Ensure that the Couchbase user has a reasonable core file size limit.
      • +
    • Ensure that you have enough free space to accommodate for core files on disk, and that + you have write access to the core file directory.
      • +
    • Consider modifying the core file pattern so you don't get lots of core files.
      • +

    + +
    Core File Setup for Selected Platforms +

    Linux

    +

    Enabling core files on Linux varies slightly based on kernel version and distributor. To enable core files, perform the following steps:

      +
    1. Enable core dumps via sysctl settings using the parameter + kernel.core_uses_pid=1.

      This appends the PID to the generated core + file, allowing multiple core dumps: + kernel.suid_dumpable=2 +fs.suid_dumpable=2Depending on the + kernel release, one of these two parameters must be set to two (2).

      Another + optional but useful parameter is: + kernel.core_pattern = /tmp/core-%e-%s-%u-%g-%p-%t

      In + general, these parameters should be set in the /etc/sysctl.conf + file.

      2. +
    2. After modifying the parameters, execute the following command so that a reboot is not necessary: /sbin/sysctl -p /etc/sysctl.conf
      3. +

    +

    Ubuntu

    +

    Generating usable core files on Ubintu requires disabling the apport process. This is + probably not a big deal unless you want various crashes reported upstream to Ubuntu. To + disable the apport process, edit the /etc/default/apport file to set + enabled=0 and then reboot the system.

    +

    To enable core files, perform the following steps:

      +
    1. Create /etc/sysctl.d/46-couchbase-core.conf with the following + contents: + kernel.core_uses_pid=1 +fs.suid_dumpable=2 +kernel.core_pattern=/opt/couchbase/data/tmp/core-%e-%s-%u-%g-%p-%t
      2. +
    2. Run the following command: service procps start
      3. +

    +

    RedHat

    +

    On RHEL 6, run the following command and then reboot the system. echo "DAEMON_COREFILE_LIMIT='unlimited'" >> /etc/sysconfig/init

    +

    Earlier RedHat derivative operating systems such as RHEL4, RHEL5, F7, and CentOS, need a + modification to their startup scripts. By default, these operating systems hard set the core + size to zero in the /etc/profile file. To fix this, edit the following + line in the file /etc/profile from ulimit -S -c 0 > /dev/null + 2>&1 to ulimit -S -c unlimited > /dev/null 2>&1. Then + reboot the system.

    +

    Mac OS X

    +

    Core dumps are disabled by default in Mac OS X. To enable core dumps, a privileged user must edit the /etc/hostconfig file to add the following line: COREDUNMPS=-YES-

    +
    + +