f5cloudexporter

README

F5 Cloud Exporter

Status
Stability	deprecated: traces, metrics, logs
Distributions	contrib, observiq
Issues
Code Owners
Emeritus	@gramidt

Exports data via HTTP to F5 Cloud.

Getting Started

The following settings are required:

• endpoint (no default): The URL to send data to. See your F5 Cloud account for details.
• source (no default): A unique identifier that is used to distinguish where this data is coming from (e.g. dev_cluster). This is in addition to the pipeline attributes and resources.
• f5cloud_auth.credential_file (no default): Path to the credential file used to authenticate this client. See your F5 Cloud account for details.

The following settings can be optionally configured:

• f5cloud_auth.audience (no default): Identifies the recipient that the authentication JWT is intended for. See your F5 Cloud account for details.

• timeout (default = 30s): HTTP request time limit. For details see https://golang.org/pkg/net/http/#Client

• read_buffer_size (default = 0): ReadBufferSize for HTTP client.

• write_buffer_size (default = 512 * 1024): WriteBufferSize for HTTP client.

Example:

f5cloud:
  endpoint: https://<ENDPOINT_FOUND_IN_F5_CLOUD_PORTAL>
  source: prod
  f5cloud_auth:
    credential_file: "/etc/creds/key.json"

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

This exporter also offers proxy support as documented here.

Documentation

Overview

Deprecated: [v0.95.0] This package is deprecated and will be removed in a future release. Package f5cloudexporter implements an OpenTelemetry Collector exporter that sends trace, metric, and log data to F5 Cloud.

Index

• func NewFactory() exporter.Factory
• type AuthConfig
• type Config
• type TokenSourceGetter

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory returns a factory of the F5 Cloud exporter that can be registered to the Collector.

Types

type AuthConfig

type AuthConfig struct {
	// CredentialFile is the F5 Cloud credentials for your designated account.
	CredentialFile string `mapstructure:"credential_file"`

	// Audience is the F5 Cloud audience for your designated account.
	Audience string `mapstructure:"audience"`
}

AuthConfig defines F5 Cloud authentication configurations for F5CloudAuthRoundTripper

type Config

type Config struct {
	// Config represents the OTLP HTTP Exporter configuration.
	otlphttp.Config `mapstructure:",squash"`

	// Source represents a unique identifier that is used to distinguish where this data is coming from.
	Source string `mapstructure:"source"`

	// AuthConfig represents the F5 Cloud authentication configuration options.
	AuthConfig AuthConfig `mapstructure:"f5cloud_auth"`
}

Config defines configuration for F5 Cloud exporter.

type TokenSourceGetter

type TokenSourceGetter func(config *Config) (oauth2.TokenSource, error)