Docs » Available host and application monitors in Splunk Observability Cloud » Configure application receivers for hosts and servers » Couchbase server

Couchbase server 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the Couchbase server monitor type to collect metrics from Couchbase servers.

This integration is only available on Kubernetes and Linux.

Benefits 🔗

After you configure the integration, you can access these features:

Installation 🔗

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Configuration options 🔗

The following configuration options are available for this integration:

Config option

Required

Type

Description

pythonBinary

no

string

Path to a Python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. This can include arguments to the binary as well.

host

yes

string

port

yes

integer

collectTarget

yes

string

Define what the module block will monitor: NODE for a Couchbase node, or BUCKET for a Couchbase bucket.

collectBucket

no

string

If collectTarget is BUCKET, collectBucket specifies the name of the bucket that this will monitor.

clusterName

no

string

Name of this Couchbase cluster. Defaults to default.

collectMode

no

string

Change to detailed to collect all available metrics from Couchbase stats API. Defaults to default, collecting a curated set that works well with SignalFx.

username

no

string

Username to authenticate with

password

no

string

Password to authenticate with

Example 🔗

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/couchbase:
    type: collectd/couchbase
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
 pipelines:
   metrics:
     receivers: [smartagent/couchbase]

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

  • To learn more about the available in Observability Cloud see Metric types.

  • In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.

  • In MTS-based subscription plans, all metrics are custom.

  • To add additional metrics, see how to configure extraMetrics in Add additional metrics.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

  • Submit a case in the Splunk Support Portal.

    • Available to Splunk Observability Cloud customers

  • Call Splunk Customer Support

    • Available to Splunk Observability Cloud customers

  • Ask a question and get answers through community support at Splunk Answers.

    • Available to Splunk Observability Cloud customers and free trial users

  • Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide

To learn about even more support options, see Splunk Customer Success.