Skip to main content
Sumo Logic

Install the Couchbase Monitors, App, and view the Dashboards

This page provides instructions for installing the Couchbase App, as well as examples of each of the App dashboards.

This page provides instructions for installing the Couchbase App, as well as examples of each of the App dashboards. These instructions assume you have already set up the collection as described in the Collect Logs and Metrics for the Couchbase App page.

Pre-Packaged Alerts

Sumo Logic has provided out-of-the-box alerts available through Sumo Logic monitors to help you monitor your Couchbase clusters. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations.

For details on the individual alerts, see this page.

Installing Monitors

  • To install these alerts, you need to have the Manage Monitors role capability.
  • Alerts can be installed by either importing a JSON file or a Terraform script.
Install the monitors by importing a JSON file method
  1. Download the JSON file that describes the monitors. 

  2. The JSON contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Couchbase clusters, the data for which has been collected via the instructions in the previous sections.  However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text db_system=couchbase with <Your Custom Filter>.  

Custom filter examples: 

  1. For alerts applicable only to a specific cluster, your custom filter would be, ‘db_cluster=couchbase-standalone.01‘.

  2. For alerts applicable to all cluster that start with couchbase-standalone, your custom filter would be,db_cluster=couchbase-standalone*.

  3. For alerts applicable to a specific cluster within a production environment, your custom filter would be,db_cluster=couchbase-1 and environment=standalone (This assumes you have set the optional environment tag while configuring collection).

  4. Go to Manage Data > Alerts > Monitors.

  5. Click Add:
    Add monitors page.png

  6. Click Import and then copy-paste the above JSON to import monitors.

Install the alerts using a Terraform script method.
  1. Generate a Sumo Logic access key and ID
    Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these instructions. Identify which deployment your Sumo Logic account is in, using this link.
  2. Download and install Terraform 0.13 or later 
  3. Download the Sumo Logic Terraform package for Couchbase alerts
    The alerts package is available in the Sumo Logic GitHub repository. You can either download it through the “git clone” command or as a zip file. 
  4. Alert Configuration 
    After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/Couchbase/

    Edit the couchbase.auto.tfvars file and add the Sumo Logic Access Key, Access Id, and Deployment from Step 1.

    access_id   = "<SUMOLOGIC ACCESS ID>"
    access_key  = "<SUMOLOGIC ACCESS KEY>"
    environment = "<SUMOLOGIC DEPLOYMENT>"


    The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific farms or environments, update the variable ’couchbase_data_source’. Custom filter examples: 
    1. A specific cluster db_cluster=couchbase.standalone.01.

    2. All clusters in an environment environment=standalone.

    3. For alerts applicable to all clusters that start with couchbase-standalone, your custom filter would be: ‘db_cluster=couchbase-standalone*’.

    4. For alerts applicable to a specific cluster within a production environment, your custom filter would be: 

db_system=couchbase and environment=standalone (This assumes you have set the optional environment tag while configuring collection)

All monitors are disabled by default on installation, if you would like to enable all the monitors, set the parameter monitors_disabled to false in this file.

By default, the monitors are configured in a monitor folder called “Couchbase”, if you would like to change the name of the folder, update the monitor folder name in “folder” key at couchbase.auto.tfvars file.

If you would like the alerts to send email or connection notifications, configure these in the file couchbase_notifications.auto.tfvars. For configuration examples, refer to the next section.

  1. Email and Connection Notification Configuration Examples

Modify the file couchbase_notifications.auto.tfvars and populate connection_notifications and email_notifications as per below examples.

Pagerduty Connection Example:
connection_notifications = [
    {
      connection_type       = "PagerDuty",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    },
    {
      connection_type       = "Webhook",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Replace <CONNECTION_ID> with the connection id of the webhook connection. The webhook connection id can be retrieved by calling the Monitors API.

For overriding payload for different connection types, refer to this document.

Email Notifications Example:
email_notifications = [
    {
      connection_type       = "Email",
      recipients            = ["abc@example.com"],
      subject               = "Monitor Alert: {{TriggerType}} on {{Name}}",
      time_zone             = "PST",
      message_body          = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]
  1. Install the Alerts
  1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/Couchbase/ and run terraform init. This will initialize Terraform and will download the required components.
  2. Run terraform plan to view the monitors which will be created/modified by Terraform.
  3. Run terraform apply.
  1. Post Installation

If you haven’t enabled alerts and/or configured notifications through the Terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other users or services. This is detailed in Step 4 of this document.

Install the Sumo Logic App

This section demonstrates how to install the Couchbase App.

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 

  2. Select the version of the service you're using and click Add to Library.

  1. To install the app, complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source. 

      • Choose Enter a Custom Data Filter, and enter a custom Couchbase cluster filter. Examples: 

        1. For all Couchbase clusters
          db_cluster=*

        2. For a specific cluster:
          db_cluster=couchbase.dev.01

        3. Clusters within a specific environment:
          db_cluster=couchbase.dev.01 and environment=prod
          (This assumes you have set the optional environment tag while configuring collection)

    3. Advanced. Select the Location in the Library (the default is the Personal folder in the library), or click New Folder to add a new folder.

    4. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or another folder that you specified. From here, you can share it with your organization. 

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps.

Dashboard Filter with Template Variables 

Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.

Dashboards

Couchbase - Overview

The Couchbase - Overview dashboard provides an at-a-glance view of the health of the Couchbase clusters and servers, performance, and problems causing errors.

Use this dashboard to:

  • Gain insights into information about the number of nodes, number of buckets, connections, number items, total bytes transferred.
  • Determine errors in clusters: enjections, out of memory errors and error queries.
  • Gain insights into information about the workload of the cluster: percent of used memory, percent of used CPU.

Couchbase - Bucket I/O

The Couchbase -  Bucket I/O dashboard provides an insight into the operators of buckets in clusters: the number of getting operations, the number of set operations, the number of delete operations, the bytes read/write.

Use this dashboard to:

  • Get insights into information about the total amount of operations in buckets per second;  the number of delete misses operations, get operations, set operations, update operations in buckets per second.
  • Get insights into information about the number of bytes read, bytes written over time.

Couchbase - Cluster Resources

The Couchbase -  Cluster Resources dashboard provides an insight into the resources of clusters: the memory resource usage, the CPU resource usage, the disk resource usage.

Use this dashboard to:

  • Gain insights into the workload of Couchbase clusters such as the percent of CPU used, the percent of Memory used, the High Low watermark.
  • Gain insights into the used resources of Couchbase clusters such as the Disk usage, the Swap space usage, the Memory available.
  • Gain insights into the rate requests, rate of streaming requests on the management port.

Couchbase - DCP Queues

The Couchbase -  DCP Queues dashboard provides an insight into the DCP queues of buckets in couchbase clusters: the number of DCP connections, DCP senders, the number of items in DCP Queues.

Use this dashboard to:

  • Gain insights into the operations of DCP queues. This helps you identify the performance of your clusters when your cluster rebalance

Couchbase - Disk Queues

The Couchbase - Disk Queues dashboard provides an insight into the DCP queues of buckets in couchbase clusters: the number of active items waiting to be written to disk, the number of items being put to disk queue, the average age of items in queues.

Use this dashboard to:

  • Gain insights into the operations of disk queues. This helps you identify performance about read/write of your clusters.

Couchbase - vBucket

The Couchbase -  vBucket dashboard provides insights into the state of vBucket of buckets in couchbase clusters: the number of vBucket of buckets, the number items in vBuckets, the state of vBuckets.

Use this dashboard to:

  • To determine the number and status of vBucket in your clusters.

Couchbase - XDCR

The Couchbase -  XDCR dashboard provides insights into replicate operations of buckets cross-cluster: the number of XDCR connections, the number of XDCR items remaining, the number of read-set-delete operations for XDCR.

Use this dashboard to:

  • Gain insights into replicate operations of buckets cross-cluster

Couchbase - Errors

The Couchbase -  Errors dashboard provides insights into errors from error logs in couchbase servers and couchbase clusters: buckets not ready, nodes not responding, node down, error queries, last error logs.

Use this dashboard to:

  • Quickly identify critical errors affecting your couchbase servers.
  • Identify SQL error queries from clients.

Couchbase - Events

The Couchbase -  Events dashboard provides insights into events from couchbase servers and couchbase clusters: the number of login failure, login success from clients, add/remove node events, add/remove bucket events, rebalance events.

Use this dashboard to:

  • To audit the activities happening in the cluster. This helps to determine what activities have occurred in the system, helping to control system security.

Couchbase - HTTP Access

The Couchbase -  HTTP Access dashboard provides insights into HTTP Rest API requests from clients to couchbase servers and couchbase clusters: the latency, HTTP codes, client agents, IP clients, errors with 4XX 5XX response code. 

Use this dashboard to:

  • To understand user behavior accessing clusters and servers through Rest API.