couchdbreceiver

README

CouchDB Receiver

Status
Stability	beta: metrics
Distributions	contrib
Issues
Code Owners	@djaglowski | Seeking more code owners!

This receiver fetches stats from a couchdb server using the /_node/{node-name}/_stats/couchdb endpoint.

Prerequisites

This receiver supports Couchdb versions 2.3+ and 3.1+.

Configuration

The following settings are required:

• username
• password

The following settings are optional:

• endpoint (default: http://localhost:5984): The URL of the couchdb endpoint

• collection_interval (default = 60s): This receiver collects metrics on an interval. This value must be a string readable by Golang's time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.

Example Configuration

receivers:
  couchdb:
    endpoint: http://localhost:5984
    username: otelu
    password: ${env:COUCHDB_PASSWORD}
    collection_interval: 60s

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() receiver.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates the couchdbreceiver factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	confighttp.ClientConfig        `mapstructure:",squash"`
	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
	Username                       string              `mapstructure:"username"`
	Password                       configopaque.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 missing and invalid configuration fields.