aerospikereceiver

README

Aerospike Receiver

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

The Aerospike receiver is designed to collect performance metrics from one or more Aerospike nodes. It uses the official Go client to connect and collect.

Aerospike versions 4.9, 5.x, and 6.x are supported.

Configuration

Configuration parameters:

• endpoint (default localhost:3000): Aerospike host ex: 127.0.0.1:3000.
• tlsname Endpoint tls name. Used by the client during TLS connections. See Aerospike authentication for mor details.
• collect_cluster_metrics (default false): Whether discovered peer nodes should be collected.
• collection_interval (default = 60s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
• initial_delay (default = 1s): defines how long this receiver waits before starting.
• username (Enterprise Edition only.)
• password (Enterprise Edition only.)
• tls (default empty/no tls) tls configuration for connection to Aerospike nodes. More information at OpenTelemetry's tls config page.

Example Configuration

receivers:
    aerospike:
        endpoint: "localhost:3000"
        tlsname: ""
        collect_cluster_metrics: false
        collection_interval: 30s

Metrics

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

Documentation

Index

• func NewFactory() receiver.Factory
• type Aerospike
• type Config
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new ReceiverFactory with default configuration

Types

type Aerospike

type Aerospike interface {
	// NamespaceInfo gets information about a specific namespace
	NamespaceInfo() namespaceInfo
	// Info gets high-level information about the node/system.
	Info() clusterInfo
	// Close closes the connection to the Aerospike node
	Close()
}

Aerospike is the interface that provides information about a given node

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	Endpoint                       string                        `mapstructure:"endpoint"`
	TLSName                        string                        `mapstructure:"tlsname"`
	Username                       string                        `mapstructure:"username"`
	Password                       configopaque.String           `mapstructure:"password"`
	CollectClusterMetrics          bool                          `mapstructure:"collect_cluster_metrics"`
	Timeout                        time.Duration                 `mapstructure:"timeout"`
	MetricsBuilderConfig           metadata.MetricsBuilderConfig `mapstructure:",squash"`
	TLS                            *configtls.ClientConfig       `mapstructure:"tls,omitempty"`
}

Config is the receiver configuration

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the values of the given Config, and returns an error if validation fails