telemetry

Documentation

Index

• Constants
• func CreateManager(logger logr.Logger, restConfig *rest.Config, ...) (telemetry.Manager, error)
• func SetupAnonymousReports(ctx context.Context, logger logr.Logger, kubeCfg *rest.Config, ...) (func(), error)
• type GatewayClientsProvider
• type InstanceIDProvider
• type Payload
• type ReportConfig
• type ReportValues

Constants

const (
	SignalStart = prefix + "-start"
	SignalPing  = prefix + "-ping"
)

Functions

func CreateManager

func CreateManager(
	logger logr.Logger,
	restConfig *rest.Config,
	gatewaysCounter workflows.DiscoveredGatewaysCounter,
	fixedPayload Payload,
	reportCfg ReportConfig,
) (telemetry.Manager, error)

CreateManager creates telemetry manager using the provided rest.Config.

func SetupAnonymousReports

func SetupAnonymousReports(
	ctx context.Context,
	logger logr.Logger,
	kubeCfg *rest.Config,
	clientsProvider GatewayClientsProvider,
	reportCfg ReportConfig,
	instanceIDProvider InstanceIDProvider,
) (func(), error)

SetupAnonymousReports sets up and starts the anonymous reporting and returns a cleanup function and an error. The caller is responsible to call the returned function - when the returned error is not nil - to stop the reports sending.

Types

type GatewayClientsProvider

type GatewayClientsProvider interface {
	GatewayClients() []*adminapi.Client
	GatewayClientsCount() int
}

GatewayClientsProvider is an interface that provides clients for the currently discovered Gateway instances.

type InstanceIDProvider

type InstanceIDProvider interface {
	GetID() uuid.UUID
}

type Payload

type Payload = types.ProviderReport

type ReportConfig

type ReportConfig struct {
	SplunkEndpoint                   string
	SplunkEndpointInsecureSkipVerify bool
	TelemetryPeriod                  time.Duration
	ReportValues                     ReportValues
}

type ReportValues

type ReportValues struct {
	FeatureGates                   map[string]bool
	MeshDetection                  bool
	PublishServiceNN               k8stypes.NamespacedName
	KonnectSyncEnabled             bool
	GatewayServiceDiscoveryEnabled bool
}