bigipreceiver

README

F5 Big-IP Receiver

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

This receiver fetches stats from a F5 Big-IP node using F5's iControl REST API.

Prerequisites

This receiver supports Big-IP versions 11.6.5+

Configuration

The following settings are required:

• username
• password

The following settings are optional:

• endpoint (default: https://localhost:443): The URL of the Big-IP environment.
• collection_interval (default = 10s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
• tls: TLS control. By default, insecure settings are rejected and certificate verification is on.

Example Configuration

receivers:
  bigip:
    collection_interval: 10s
    endpoint: https://localhost:443
    username: otelu
    password: ${env:BIGIP_PASSWORD}
    tls:
      insecure_skip_verify: true

The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml. 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 documentation.md

Documentation

Index

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

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new receiver factory for Big-IP

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	confighttp.ClientConfig        `mapstructure:",squash"`
	Username                       string              `mapstructure:"username"`
	Password                       configopaque.String `mapstructure:"password"`
	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
}

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