Skip to main content
Sumo Logic

Collect Couchbase Logs and Metrics for Kubernetes environments

In a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection.

In a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more about it here. The following diagram illustrates how data is collected from Couchbase in Kubernetes environments. There are four services that make up the metric collection pipeline: Telegraf, Prometheus, Fluentd, and FluentBit.

The first service in the 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 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. We also have Fluentbit that collects logs written to standard out and forwards them to FluentD, which in turn sends all the logs and metrics data to a Sumo Logic HTTP Source.

 

Follow the below instructions to set up the metric collection:

  1. Configure Metrics Collection
    1. Setup Kubernetes Collection with the Telegraf operator
    2. Add annotations on your Couchbase pods
  2. Configure Logs Collection
    1. Configure logging in Couchbase.
    2. Add labels on your Couchbase pods to capture logs from standard output.
    3. Collecting Couchbase Logs from a Log file.

Prerequisites

It’s assumed that you are using the latest helm chart version if not, upgrade using the instructions here

When you upgrade the helm chart, you must upgrade telegraf version to 1.21.1 by adding the statement below:

"--set telegraf-operator.image.sidecarImage=telegraf:1.21.1" in the upgrade command helm chart.

Configure Metrics Collection

This section explains the steps to collect Couchbase metrics from a Kubernetes environment.

In a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more on this here. Follow the steps listed below to collect metrics from a Kubernetes environment:

  1. Setup Kubernetes Collection with the Telegraf Operator.

  2. Add annotations on your Couchbase pods

On your Couchbase Pods, add the following annotations:

 annotations:
    telegraf.influxdata.com/class: sumologic-prometheus
    prometheus.io/scrape: "true"
    prometheus.io/port: "9273"
    telegraf.influxdata.com/inputs: |+
[[inputs.couchbase]]
servers = ["http://<USER_TO_BE_CHANGED>:<PASS_TO_BE_CHANGED>@A@localhost:8091"]
bucket_stats_included = ["*"]
[inputs.couchbase.tags]
db_cluster="CLUSTER_NAME_TO_BE_CHANGED"
component="database"
environment="ENV_TO_BE_CHANGED"
db_system="couchbase"

Enter in values for the following parameters (marked in bold above):

  • telegraf.influxdata.com/inputs - This contains the required configuration for the Telegraf Couchbase Input plugin. Refer to this doc for more information on configuring the Couchbase input plugin for Telegraf. Note: As telegraf will be run as a sidecar the host should always be localhost.

    • Input plugins section, which is [[inputs.couchbase]]:

      • servers: This is the endpoint of the management portal of couchbase server. For detail, see this doc .

    • In the tags section,  which is [inputs.couchbase.tags]

      • environment - This is the deployment environment where the Couchbase cluster identified by the value of servers resides. For example: dev, prod or qa. While this value is optional we highly recommend setting it. 

      • db_cluster - Enter a name to identify this Couchbase cluster. This cluster name will be shown in the Sumo Logic dashboards.  

Here’s an explanation for additional values set by this configuration that we request you do not modify as they will cause the Sumo Logic apps to not function correctly.

  • telegraf.influxdata.com/class: sumologic-prometheus - This instructs the Telegraf operator what output to use. This should not be changed.

  • prometheus.io/scrape: "true" - This ensures our Prometheus will scrape the metrics.

  • prometheus.io/port: "9273" - This tells prometheus what ports to scrape on. This should not be changed.

  • telegraf.influxdata.com/inputs

    • In the tags section, which is [inputs.couchbase.tags]

      • component: “database” - This value is used by Sumo Logic apps to identify application components. 

      • db_system: “couchbase” - This value identifies the database system.

For all other parameters see this doc for more properties that can be configured in the Telegraf agent globally.

  1. Sumo Logic Kubernetes collection will automatically start collecting metrics from the pods having the labels and annotations defined in the previous step. 

  2. Verify metrics in Sumo Logic.

Configure Logs Collection

This section explains the steps to collect Couchbase logs from a Kubernetes environment.

  1. (Recommended Method) Add labels on your Couchbase pods to capture logs from standard output.

Make sure that the logs from Couchbase are sent to stdout. Follow the instructions below to capture Couchbase logs from stdout on Kubernetes.

  1. Apply following labels to the Couchbase pod

                        labels:

  environment="prod_CHANGEME"
  component="database"
  db_system=”couchbase”
  db_cluster="<cluster_CHANGEME>"

Enter in values for the following parameters (marked in bold and CHANGE_ME above):

  • environment - This is the deployment environment where the Couchbase cluster identified by the value of servers resides. For example:- dev, prod, or QA. While this value is optional we highly recommend setting it.

  • db_cluster - Enter a name to identify this Couchbase cluster. This cluster name will be shown in the Sumo Logic dashboards. If you haven’t defined a cluster in Couchbase, then enter ‘default’ for db_cluster.

Here’s an explanation for additional values set by this configuration that we request you do not modify as they will cause the Sumo Logic apps to not function correctly.

  • component: “database” - This value is used by Sumo Logic apps to identify application components. 

  • db_system: “couchbase” - This value identifies the database system.

For all other parameters see this doc for more properties that can be configured in the Telegraf agent globally.

  1. The Sumologic-Kubernetes-Collection will automatically capture the logs from stdout and will send the logs to Sumologic. For more information on deploying Sumologic-Kubernetes-Collection, visit here.

  2. Verify logs in Sumo Logic.

 

  1. (Optional) Collecting Couchbase Logs from a Log File
    Follow the steps below to capture Couchbase logs from a log file on Kubernetes.

  1. Determine the location of the Couchbase log file on Kubernetes. This can be determined from the config file /opt/couchbase/etc/couchbase/static_config squid.conf for your Couchbase cluster along with the mounts on the Couchbase pods.

  2. Install the Sumo Logic tailing sidecar operator.

  3. Add the following annotation in addition to the existing annotations.

annotations:
  tailing-sidecar: sidecarconfig;<mount>:<path_of_Couchbase_log_file>/<Couchbase_log_file_name>
Example:
annotations:
  tailing-sidecar: sidecarconfig;data:/opt/couchbase/var/lib/couchbase/logs/audit.log

 

  1. Make sure that the Couchbase pods are running and annotations are applied by using the command: kubectl describe pod <Couchbase_pod_name>

  2. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 

  3. Verify logs in Sumo Logic.

 

  1. Add a 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, we need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so:

  1. Go to Manage Data > Logs > Field Extraction Rules.

  2. Click the + Add button on the top right of the table.

  3. The following form appears:

  4. Enter the following options:

    1. Rule Name. Enter the name as App Observability - Proxy.

    2. Applied At. Choose Ingest Time

    3. Scope. Select Specific Data

    4. Scope: Enter the following keyword search expression: 
      pod_labels_environment=* pod_labels_component=database pod_labels_db_cluster=* pod_labels_db_system=*

  • Parse Expression.Enter the following parse expression:
    if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment
    | pod_labels_component as component
    | pod_labels_db_system as db_system
    | pod_labels_db_cluster as db_cluster

  1. Click Save to create the rule.