Monitoring Statistics

    From the Data Bucket menu, information and statistics about buckets and nodes is displayed for the entire Couchbase Server cluster. The information is aggregated from all the nodes within the configured cluster for the selected bucket.

    From the Couchbase Web Console  Buckets menu, click the Statistics link for each bucket.

    Example 1. Here is some N1QL
    SELECT * FROM `travel-sample` WHERE type = "airline" LIMIT 1;
    Bucket Selection

    The Buckets selection list lets you select which of the buckets configured on your cluster is to be used as the basis for the graph display. The statistics shown are aggregated over the whole cluster for the selected bucket.

    Interval Selection
    Periodic Selection

    The Interval selection at the top of the main graph changes interval display for all graphs displayed on the page.

    As the selected interval increases, the amount of statistical data displayed will depend on how long your cluster has been running.

    Click the git branch icon at the bottom of the editor to select a branch. Then click the arrow small downarrow small up icons to open the pull/push dialog.

    Try It Now

    This section demonstrates the interactive, try it now feature of the docs.

    require 'couchbase'
    options =
    options.authenticate('username', 'password')
    cluster = Couchbase::Cluster.connect('couchbase://', options)
    bucket = cluster.bucket('travel-sample')
    collection = bucket.default_collection
      get_result = collection.get('airline_10')
      puts get_result.content
    rescue Couchbase::Error::DocumentNotFound
      puts 'Document not found!'
    import com.couchbase.client.core.error.DocumentNotFoundException;
    public class StartUsing {
      public static void main(String[] args) {
        var cluster = Cluster.connect(
          "couchbase://", "username", "password"
        var bucket = cluster.bucket("travel-sample");
        var collection = bucket.defaultCollection();
        try {
          var result = collection.get("airline_10");
        } catch (DocumentNotFoundException ex) {
          System.out.println("Document not found!");

    Individual Bucket Monitoring

    Bucket monitoring within the Couchbase Web Console has been updated to show additional detailed information.


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

    Server Resources

    This section provides information on the server resources across the cluster.

    Installation will vary based on your operation system.

    • Ubuntu

    • Red Hat

    • Debian

    • Test1

    • Test2

    • Test3

    • Test4

    • Test5

    Content for Ubuntu tab.

    Content for Red Hat tab.

    Content for Debian tab.

    Content for test 1 tab.

    Content for test 2 tab.

    Content for test 3 tab.

    Content for test 4 tab.

    Content for test 5 tab.

    Admonition Blocks

    Let’s take a brief pause to look at some admonition blocks.

    What the admonition?

    An admonition is a way to nudge the user to pay attention to information that is not to be missed. It might be a gentle suggestion in the form of a note or tip or something more serious like a warning.

    This oughta do it!

    Oh, you’ve been down this road before.

    Watch out!

    I wouldn’t try that if I were you.

    Don’t forget this step!

    Enterprise Edition Only
    This feature is only available in the Enterprise Edition.
    Key Points to Remember
    • Write

    • This

    • Down

    If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.

    $ npm i -g @antora/cli @antora/site-generator-default

    Edition and Status Labels

    You can use spans to add the edition and status labels to a section, subsection, or paragraph within a document.

    Status labels should only be used to mark that a section is beta or developer preview. You could also use it to mark new features, but only within the version in which the feature was introduced — no-one using version 6.5 needs to know that a feature was introduced in version 4.1.

    Labels for a Section

    ENTERPRISE EDITIONDeveloper Preview

    To create an edition label, use a span with the role edition. To create a status label, use a span with the role status.

    To add edition and status labels at the start of a section or block, place the required spans in a single paragraph on its own. To add the "speech bubble tail" above the labels, the spans should be placed in a paragraph with the role labels.

    Global document attributes are available to insert the content for an edition or status label. The global document attribute {enterprise} inserts the content for an enterprise edition label. The global document attribute {community} inserts the content for a community edition label.

    If you need to place edition and status labels together, do not insert a space between them. In this case, you must use the "inline" span markup, i.e. delimit the spans with double hash marks ##…​##.

    Labels for a Group of Paragraphs within a Section

    Here is another section. Note that this section does not have any edition or status labels at the start.

    You can use a sidebar without a title. This sidebar shows how you can use the inline label markup in a paragraph on its own to add an edition label or a status label to a collection of blocks which does not form a complete section.

    (You should avoid mixing up a section-level labels and block-level labels within one section; it would get too confusing.)

    Sidebars can contain admonitions.
    1. Here is a list within the sidebar.

    2. The edition label at the start of this sidebar clearly applies to the whole content of this sidebar.

    Outside the sidebar again. The user can clearly see that the edition label within the sidebar does not apply to this paragraph.

    Labels for an Individual Item

    Here is another section. This section does not have any edition or status labels at the start.

    • This is the first item in a list.

    • COMMUNITY EDITION This is the second item in a list. This item is only applicable to community edition.

    • This is the third item in the list.

    • This is the last item in the list.

    Bucket Monitoring — Summary Statistics

    The summary section is designed to provide a quick overview of the cluster activity.

    stats summary

    The following statistics are available:

    Table 1. Summary statistics
    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.

    The stale=false view query argument has been enhanced. When an application sends a query that has the stale parameter set to false, the application receives all recent changes to the documents, including changes that haven’t yet been persisted to disk.

    Best practice
    For better scalability and throughput, we recommend that you set the value of the stale parameter to ok. With the stream-based views, data returned when stale is set to ok is closer to the key-value data, even though it might not include all of it.

    Monitoring Server Resources

    The Server Resources statistics section displays the resource information on this server including swap usage, free RAM, CPU utilization percentage,and FTS RAM used.

    A query using the fluent API (lines are forced to wrap)
    Statement statement = select("fname", "lname", "age").from(i("default")).where(x("age").gt(x("$age"))); (1)
    JsonObject placeholderValues = JsonObject.create().put("age", 22);
    q = N1qlQuery.parameterized(statement, placeholderValues); (2)
    for (N1qlQueryRow row : bkt.query(q)) { (3)
    1 Defines the query.
    2 Inserts placeholder values into the query.
    3 Runs the query.

    Monitoring vBucket Resources

    Statistic Description

    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.

    • Non-zero

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

    Monitoring Disk Queues

    The Disk Queues statistics section displays the information for data being placed into the disk queue.

    Monitoring DCP Queues

    Statistic Description

    DCP connections

    Number of internal replication DCP connections in this bucket.

    DCP senders

    Number of replication senders for this bucket.

    DCP receivers

    Number of replication receivers for this bucket.

    Monitoring View Statistics

    The View Stats show information about individual design documents within the selected bucket.

    Monitoring Index Statistics

    The INDEX STATS section provides statistics about the GSI Indexes. Statistics are provided per each individual index.

    Select United States of America from the menu.

    Memcached Buckets

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

    • Situation 1

      1. Client 1 queries view with stale=false

      2. Client 1 waits until server updates the index

      3. Client 2 queries view with stale=false while re-indexing from Client 1 still in progress

      4. Client 2 will wait until existing index process triggered by Client 1 completes. Client 2 gets updated index.

    • Situation 2

      1. Client 1 queries view with stale=false

      2. Client 1 waits until server updates the index

      3. Client 2 queries view with stale=ok while re-indexing from Client 1 in progress

      4. Client 2 will get the existing index

    • Situation 3

      1. Client 1 queries view with stale=false

      2. Client 1 waits until server updates the index

      3. Client 2 queries view with stale=update_after

      4. If re-indexing from Client 1 not done, Client 2 gets the existing index. If re-indexing from Client 1 is done, Client 2 gets this updated index and triggers re-indexing.

    Index updates may be stacked if multiple clients request the view be updated before the information is returned (stale=false). For stale=update_after queries, there is no stacking, since all updates occur after the query has been accessed.

    Sequential accesses

    1. Client 1 queries view with stale=ok

    2. Client 2 queries view with stale=false

    3. View gets updated

    4. Client 1 queries a second time view with stale=ok

    5. Client 1 gets the updated view version

    View operations

    All views within Couchbase operate as follows:

    • Views are updated as the document data is updated in memory.

      • Documents that are stored with an expiry are not automatically removed until the background expiry process removes them from the database. This means that expired documents may still exist within the index.

        • Views are scoped within a design document, with each design document part of a single bucket.

          • View names must be specified using one or more UTF-8 characters. You cannot have a blank view name.

            • Document IDs that are not UTF-8 encodable are automatically filtered and not included in any view. The filtered documents are logged so that they can be identified.

            • If you have a long view request, use POST instead of GET.

      • Views can only access documents defined within their corresponding bucket. You cannot access or aggregate data from multiple buckets within a given view.

        • Views are created as part of a design document, and each design document exists within the corresponding named bucket.

    Automated index updates

    If replicaUpdateMinChanges is set to 0 (zero), then automatic updates are disabled for replica indexes. The trigger level can be configured both globally and for individual design documents for all indexes using the REST API.

    The ddocs allow you to set updateMinChanges or replicaUpdateMinChanges only via options. The updateInterval can only be set for the whole cluster.

    To obtain the current view update daemon settings, access a node within the cluster on the administration port using the URL http://nodename:8091/settings/viewUpdateDaemon:

    GET http://Administrator:Password@nodename:8091/settings/viewUpdateDaemon
    POST http://nodename:8091/settings/viewUpdateDaemon
       "_id": "_design/myddoc",
       "views": {
          "view1": {
              "map": "function(doc, meta) { if (doc.value) { emit(doc.value,;} }"
       "options": {
           "updateMinChanges": 1000,
           "replicaUpdateMinChanges": 20000

    You can set this information when creating and updating design documents through the design document REST API. To perform this operation using the curl tool:

    $ curl -X POST -v -d 'updateInterval=7000&updateMinChanges=7000' \

    Partial-set development views are not automatically rebuilt.

    Couchbase Kafka Connector 3.2.3 GA (2018-02-20)

    Options are "DISABLED", "ENABLED", and "FORCED".

    Issues resolved in this release:

    • KAFKAC-89: [ENHANCEMENT] Enable NOOP for dead connection detection (Patrik Nordebo)

    • KAFKAC-82: [FEATURE] Implement log redaction for Kafka Connector

    • KAFKAC-90: [FEATURE] Source: Add config settings to enable compression



    This section demonstrates what happens when the section title does not have any natural wrap opportunities.