}){kind=logo}
Couchbase, a modern database for enterprise applications, is a distributed document database with a powerful search engine and in-built operational and analytical capabilities. It brings the power of NoSQL to the edge and provides fast, efficient bidirectional synchronization of data between the edge and the cloud.
The Sumo Logic app for Couchbase helps you monitor activity in Couchbase. The pre-configured dashboards provide insight into the Health of the Cluster, the Status of the Buckets, I/O of Reading/Writing, Errors, the Events of Couchbase Servers that help you understand your clusters.
This app has been tested with the following Couchbase with Telegraf versions:
* Kubernetes: Couchbase version: 7.0.2 - enterprise with Telegraf version 1.21.1
* Non-Kubernetes: Couchbase version: 7.0.2 - enterprise with Telegraf version 1.21.1
:::note
Telegraf 1.14 default of Kubernetes Collection will not work.
:::
## Collecting logs and metrics for the Couchbase app
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Couchbase.
### Configure Collection for Couchbase
Sumo Logic supports the collection of logs and metrics data from Couchbase in both Kubernetes and non-Kubernetes environments. Click on the appropriate tab below based on the environment where your Couchbase clusters are hosted.
})
The first service in the metrics pipeline is Telegraf. Telegraf collects metrics from Couchbase. Note that we’re running Telegraf in each pod we want to collect metrics from as a sidecar deployment that is Telegraf runs in the same pod as the containers it monitors. Telegraf uses the [Couchbase input plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/couchbase) to obtain metrics. For simplicity, the diagram doesn’t show the input plugins.
The injection of the Telegraf sidecar container is done by the Telegraf Operator.
Prometheus pulls metrics from Telegraf and sends them to [Sumo Logic Distribution for OpenTelemetry Collector](https://github.com/SumoLogic/sumologic-otel-collector) which enriches metadata and sends metrics to Sumo Logic.
In the logs pipeline, Sumo Logic Distribution for OpenTelemetry Collector collects logs written to standard out and forwards them to another instance of Sumo Logic Distribution for OpenTelemetry Collector, which enriches metadata and sends logs to Sumo Logic.
:::note Prerequisites
It’s assumed that you are using the latest helm chart version if not, upgrade using the instructions [here](/docs/send-data/kubernetes). When you upgrade the helm chart, you must upgrade telegraf version to 1.21.1 by adding the statement below in the upgrade command helm chart:
```bash
--set telegraf-operator.image.sidecarImage=telegraf:1.21.1
```
:::
#### Configure Metrics Collection
To collect Couchbase metrics from a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more about this [here](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/telegraf-collection-architecture).
1. [Set up Kubernetes Collection with the Telegraf Operator](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/install-telegraf).
2. On your Couchbase Pods, add the following annotations:
```sql
annotations:
telegraf.influxdata.com/class: sumologic-prometheus
prometheus.io/scrape: "true"
prometheus.io/port: "9273"
telegraf.influxdata.com/inputs: |+
[[inputs.couchbase]]
servers = ["http://#### Configure Logs Collection This section explains the steps to collect Couchbase logs from a Kubernetes environment. 1. **Add labels on your Couchbase pods to capture logs from standard output on Kubernetes (recommended)**. 1. Apply following labels to the Couchbase pod: ```sql environment = "prod_CHANGEME" component = "database" db_system = "couchbase" db_cluster = "
**FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, a Field Extraction Rule named **AppObservabilityCouchbaseDatabaseFER** is automatically created for Database Application Components.
})
The process to set up collection for Couchbase data is done through the following steps.
#### Configure Logs Collection
The Sumo Logic Couchbase app supports the audit log, query log, error log, access log. For details, [refer to Couchbase logging documentation](https://docs.couchbase.com/server/current/manage/manage-logging/manage-logging.html#changing-log-file-locations).
1. **Configure logging in Couchbase**. By default, the Couchbase will write the log to the log directory that was configured during installation. For example, on Linux, the log directory would be `/opt/couchbase/var/lib/couchbase/logs`. By default, the Audit log is disabled, you must enable the audit log following [these instructions](https://docs.couchbase.com/server/current/manage/manage-security/manage-auditing.html). Query log, error log, the access log will be enabled by default.
2. **Configure a Collector**. Use one of the following Sumo Logic Collector options:
1. To collect logs directly from the Couchbase machine, configure an [Installed Collector](/docs/send-data/installed-collectors).
2. If you're using a service like Fluentd, or you would like to upload your logs manually, configure a [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
3. **Configure a local file source**. Choose one of the options:
3A. For an Installed Collector (click to expand)
To collect logs directly from your Couchbase machine, use an Installed Collector and Multi Local File Source. Repeat the below steps for each log source: audit log, query log, error log, access log. 1. Add a [Local File Source](/docs/send-data/installed-collectors/sources/local-file-source). 2. Configure the Local File Source fields as follows: * **Name**. (Required) * **Description**. (Optional) * **File Path (Required)**. Enter the path to your log files: The files are typically located in folder /opt/couchbase/var/lib/couchbase/logs. * For Audit Log: /opt/couchbase/var/lib/couchbase/logs/audit.log * For Error Log: /opt/couchbase/var/lib/couchbase/logs/error.log * For Access Log: /opt/couchbase/var/lib/couchbase/logs/http_access.log * For Query Log: /opt/couchbase/var/lib/couchbase/logs/query.log * **Source Host**. Sumo Logic uses the hostname assigned by the OS unless you enter a different hostname. * **Source Category**. Enter any string to tag the output collected from this Source, such as Couchbase/AccessLog for access log. (The Source Category metadata field is a fundamental building block to organize and label Sources. For details, see [Best Practices](/docs/send-data/best-practices).) * **Fields.** Set the following fields ```sql component = database db_system = couchbase db_cluster =3B. For a Hosted Collector (click to expand)
If you're using a service like Fluentd, or you would like to upload your logs manually, use a Hosted Collector and an HTTP Source. 1. Add an [HTTP Source](/docs/send-data/hosted-collectors/http-source/logs-metrics). 2. Configure the HTTP Source fields as follows: * **Name**. (Required) * **Description**. (Optional) * **Source Host**. Sumo Logic uses the hostname assigned by the OS unless you enter a different hostname. * **Source Category**. Enter any string to tag the output collected from this Source, such as Couchbase/AccessLog for access log. (The Source Category metadata field is a fundamental building block to organize and label Sources. For details, see [Best Practices](/docs/send-data/best-practices).) * Fields. Set the following fields: * `component = database` * `db_system = couchbase` * `db_cluster =#### Configure Metrics Collection 1. To set up a Sumo Logic HTTP Source, you'll need to configure a Hosted Collector for Metrics. To create a new Sumo Logic hosted collector, perform the steps in [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector). 2. **Configure an HTTP Logs and Metrics source**: 1. On the created Hosted Collector on the Collection Management screen, select **Add Source**. 2. Select **HTTP Logs & Metrics.** 1. **Name.** (Required). Enter a name for the source. 2. **Description.** (Optional). 3. **Source Category** (Recommended). Be sure to follow the [Best Practices for Source Categories](/docs/send-data/best-practices). A recommended Source Category may be Prod/DBServer/Couchbase/Metrics. 3. Select **Save**. 4. Take note of the URL provided once you click _Save_. You can retrieve it again by selecting the **Show URL** next to the source on the Collection Management screen. 3. **Install Telegraf, if you haven’t already**, using the [following steps](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/install-telegraf.md). 2. **Configure and start Telegraf.** As part of collecting metrics data from Telegraf, we will use the[ Couchbase input plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/couchbase) to get data from Telegraf and the [Sumo Logic output plugin](https://github.com/SumoLogic/fluentd-output-sumologic) to send data to Sumo Logic. Create or modify `telegraf.conf` and copy and paste the text below: ```sql [[inputs.couchbase]] servers = ["http://
})
### 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.
})
### 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.
})
### 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
})
### 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.
})
### 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.
})
### 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
})
### 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.
})
### 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.
})
### 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.
})
## Create monitors for Couchbase app
import CreateMonitors from '../../reuse/apps/create-monitors.md';