common

Documentation

Index

• func CreateLogger(skipSettingGRPCLogger bool) (*zap.Logger, error)
• func GetTLSCredentialsForGRPCExporter(caFile string, cAuth ClientAuth, insecureSkipVerify bool) (credentials.TransportCredentials, error)
• func GetTLSCredentialsForHTTPExporter(caFile string, cAuth ClientAuth, insecureSkipVerify bool) (*tls.Config, error)
• func ValidateSpanID(spanID string) error
• func ValidateTraceID(traceID string) error
• type ClientAuth
• type Config
  • func (c *Config) CommonFlags(fs *pflag.FlagSet)
  • func (c *Config) Endpoint() string
  • func (c *Config) GetAttributes() []attribute.KeyValue
  • func (c *Config) GetHeaders() map[string]string
  • func (c *Config) GetTelemetryAttributes() []attribute.KeyValue
• type KeyValue
  • func (v *KeyValue) Set(s string) error
  • func (v *KeyValue) String() string
  • func (v *KeyValue) Type() string

Functions

func CreateLogger

func CreateLogger(skipSettingGRPCLogger bool) (*zap.Logger, error)

CreateLogger creates a logger for use by telemetrygen

func GetTLSCredentialsForGRPCExporter

func GetTLSCredentialsForGRPCExporter(
	caFile string,
	cAuth ClientAuth,
	insecureSkipVerify bool,
) (credentials.TransportCredentials, error)

func GetTLSCredentialsForHTTPExporter

func GetTLSCredentialsForHTTPExporter(
	caFile string,
	cAuth ClientAuth,
	insecureSkipVerify bool,
) (*tls.Config, error)

func ValidateSpanID

func ValidateSpanID(spanID string) error

func ValidateTraceID

func ValidateTraceID(traceID string) error

Types

type ClientAuth

type ClientAuth struct {
	Enabled        bool
	ClientCertFile string
	ClientKeyFile  string
}

type Config

type Config struct {
	WorkerCount           int
	Rate                  float64
	TotalDuration         time.Duration
	ReportingInterval     time.Duration
	SkipSettingGRPCLogger bool

	// OTLP config
	CustomEndpoint      string
	Insecure            bool
	InsecureSkipVerify  bool
	UseHTTP             bool
	HTTPPath            string
	Headers             KeyValue
	ResourceAttributes  KeyValue
	TelemetryAttributes KeyValue

	// OTLP TLS configuration
	CaFile string

	// OTLP mTLS configuration
	ClientAuth ClientAuth
}

func (*Config) CommonFlags

func (c *Config) CommonFlags(fs *pflag.FlagSet)

CommonFlags registers common config flags.

func (*Config) Endpoint

func (c *Config) Endpoint() string

Endpoint returns the appropriate endpoint URL based on the selected communication mode (gRPC or HTTP) or custom endpoint provided in the configuration.

func (*Config) GetAttributes

func (c *Config) GetAttributes() []attribute.KeyValue

func (*Config) GetHeaders

func (c *Config) GetHeaders() map[string]string

func (*Config) GetTelemetryAttributes

func (c *Config) GetTelemetryAttributes() []attribute.KeyValue

type KeyValue

type KeyValue map[string]any

func (*KeyValue) Set

func (v *KeyValue) Set(s string) error

func (*KeyValue) String

func (v *KeyValue) String() string

func (*KeyValue) Type

func (v *KeyValue) Type() string