couchbasereceiver

README

Couchbase Receiver

This receiver fetches stats from a couchbase cluster using the following endpoints:

• /pools/default endpoint
• /pools/default/buckets/{bucket_name}/stats endpoint.

Supported pipeline types: metrics

🚧 This receiver is in BETA. Configuration fields and metric data model are subject to change.

Prerequisites

This receiver supports Couchbase versions 6.5, 6.6, and 7.0.

Configuration

The following settings are required:

• endpoint (default: http://localhost:8091): The URL of any node within the cluster to be monitored.
• username
• password

The following settings are optional:

• collection_interval (default = 10s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
• tls (defaults defined here): TLS control. By default insecure settings are rejected and certificate verification is on.

Example Configuration

receivers:
  couchbase:
    endpoint: http://localhost:8901
    username: otelu
    password: $COUCHBASE_PASSWORD
    collection_interval: 10s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here. TLS config is documented further under the opentelemetry collector's configtls package.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a new receiver factory

Types

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	confighttp.HTTPClientSettings           `mapstructure:",squash"`
	Username                                string `mapstructure:"username"`
	Password                                string `mapstructure:"password"`
}

Config defines the configuration for the various elements of the receiver agent.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates the configuration by checking for missing or invalid fields