This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

    Couchbase

    Couchbase Server is a distributed, open-source, NoSQL database engine. The core architecture is designed to simplify building modern applications with a flexible data model and simpler high availability, high scalability, high performance, and advanced security. If Couchbase is installed on your environment, the Sysdig agent will automatically connect. If authentication is configured, you may need to edit the default entries to connect. See the Default Configuration, below.

    The Sysdig agent automatically collects all bucket and node metrics. You can also edit the configuration to collect query metrics.

    This page describes the default configuration settings, how to edit the configuration to collect additional information, the metrics available for integration, and a sample result in the Sysdig Monitor UI.

    Couchbase Setup

    Couchbase will automatically expose all metrics. You do not need to configure anything on the Couchbase instance.

    Sysdig Agent Configuration

    Review how to Edit dragent.yaml to Integrate or Modify Application Checks.

    Default Configuration

    By default, Sysdig’s dragent.default.yaml uses the following code to connect with Couchbase and collect all bucket and node metrics.

    app_checks:
      - name: couchbase
        pattern:
          comm: beam.smp
          arg: couchbase
          port: 8091
        conf:
          server: http://localhost:8091
    

    If authentication is enabled, you need to edit dragent.yaml file to connect with Couchbase. See Example 1.

    Remember! Never edit dragent.default.yaml directly; always edit only dragent.yaml.

    Example 1: Authentication

    Replace <username> and <password> with appropriate values and update the dragent.yaml file.

    app_checks:
      - name: couchbase
        pattern:
          comm: beam.smp
          arg: couchbase
          port: 8091
        conf:
          server: http://localhost:8091
          user: <username>
          password: <password>
          # The following block is optional and required only if the 'path' and
          # 'port' need to be set to non-default values specified here
          cbstats:
            port: 11210
            path: /opt/couchbase/bin/cbstats
    

    Example 2: Query Stats

    Additionally, you can configure query_monitoring_url to get query monitoring stats. This is available from Couchbase version 4.5. See Query Monitoring for more detail.

    app_checks:
      - name: couchbase
        pattern:
          comm: beam.smp
          arg: couchbase
          port: 8091
        conf:
          server: http://localhost:8091
          query_monitoring_url: http://localhost:8093
    

    Metrics Available

    See Couchbase Metrics.

    Result in the Monitor UI