telemetry

Documentation

Overview

Package telemetry is responsible for collecting and sending product telemetry data.

Index

• func CreateTelemetryJobWorker(logger logr.Logger, exporter Exporter, dataCollector DataCollector) func(ctx context.Context)
• type ClusterInformation
  • func CollectClusterInformation(ctx context.Context, k8sClient client.Reader) (ClusterInformation, error)
• type ConfigurationGetter
• type Data
  • func (d *Data) Attributes() []attribute.KeyValue
• type DataCollector
• type DataCollectorConfig
• type DataCollectorImpl
  • func NewDataCollectorImpl(cfg DataCollectorConfig) *DataCollectorImpl
  • func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error)
• type Exporter
• type GraphGetter
• type LabelCollector
  • func NewLabelCollector(cfg LabelCollectorConfig) *LabelCollector
  • func (l *LabelCollector) Collect(ctx context.Context) (map[string]string, error)
• type LabelCollectorConfig
• type LoggingExporter
  • func NewLoggingExporter(logger logr.Logger) *LoggingExporter
  • func (e *LoggingExporter) Export(_ context.Context, data tel.Exportable) error
• type NGFResourceCounts
  • func (d *NGFResourceCounts) Attributes() []attribute.KeyValue
• type RouteCounts

Functions

func CreateTelemetryJobWorker

func CreateTelemetryJobWorker(
	logger logr.Logger,
	exporter Exporter,
	dataCollector DataCollector,
) func(ctx context.Context)

Types

type ClusterInformation

type ClusterInformation struct {
	Platform  string
	Version   string
	ClusterID string
	NodeCount int
}

func CollectClusterInformation

func CollectClusterInformation(ctx context.Context, k8sClient client.Reader) (ClusterInformation, error)

CollectClusterInformation collects information about the cluster.

type ConfigurationGetter

type ConfigurationGetter interface {
	GetLatestConfiguration() []*dataplane.Configuration
}

ConfigurationGetter gets the latest Configuration.

type Data

type Data struct {
	// ImageSource tells whether the image was built by GitHub or locally (values are 'gha', 'local', or 'unknown')
	ImageSource string
	tel.Data    // embedding is required by the generator.
	// FlagNames contains the command-line flag names.
	FlagNames []string
	// FlagValues contains the values of the command-line flags, where each value corresponds to the flag from FlagNames
	// at the same index.
	// Each value is either 'true' or 'false' for boolean flags and 'default' or 'user-defined' for non-boolean flags.
	FlagValues []string
	// SnippetsFiltersDirectives contains the directive-context strings of all applied SnippetsFilters.
	// Both lists are ordered first by count, then by lexicographical order of the context string,
	// then lastly by directive string.
	SnippetsFiltersDirectives []string
	// SnippetsFiltersDirectivesCount contains the count of the directive-context strings, where each count
	// corresponds to the string from SnippetsFiltersDirectives at the same index.
	// Both lists are ordered first by count, then by lexicographical order of the context string,
	// then lastly by directive string.
	SnippetsFiltersDirectivesCount []int64
	NGFResourceCounts              // embedding is required by the generator.
	// NginxPodCount is the total number of Nginx data plane Pods.
	NginxPodCount int64
	// ControlPlanePodCount is the total number of NGF control plane Pods.
	ControlPlanePodCount int64
	// NginxOneConnectionEnabled is a boolean that indicates whether the connection to the Nginx One Console is enabled.
	NginxOneConnectionEnabled bool
}

Data is telemetry data.

func (*Data) Attributes

func (d *Data) Attributes() []attribute.KeyValue

type DataCollector

type DataCollector interface {
	// Collect collects and returns telemetry Data.
	Collect(ctx context.Context) (Data, error)
}

DataCollector collects telemetry data.

type DataCollectorConfig

type DataCollectorConfig struct {
	// K8sClientReader is a Kubernetes API client Reader.
	K8sClientReader client.Reader
	// GraphGetter allows us to get the Graph.
	GraphGetter GraphGetter
	// ConfigurationGetter allows us to get the Configuration.
	ConfigurationGetter ConfigurationGetter
	// PodNSName is the NamespacedName of the NGF Pod.
	PodNSName types.NamespacedName
	// Version is the NGF version.
	Version string
	// ImageSource is the source of the NGF image.
	ImageSource string
	// Flags contains the command-line NGF flag keys and values.
	Flags config.Flags
	// NginxOneConsoleConnection is a boolean that indicates whether the connection to the Nginx One Console is enabled.
	NginxOneConsoleConnection bool
}

DataCollectorConfig holds configuration parameters for DataCollectorImpl.

type DataCollectorImpl

type DataCollectorImpl struct {
	// contains filtered or unexported fields
}

DataCollectorImpl is am implementation of DataCollector.

func NewDataCollectorImpl

func NewDataCollectorImpl(
	cfg DataCollectorConfig,
) *DataCollectorImpl

NewDataCollectorImpl creates a new DataCollectorImpl for a telemetry Job.

func (DataCollectorImpl) Collect

func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error)

Collect collects and returns telemetry Data.

type Exporter

type Exporter interface {
	Export(ctx context.Context, data tel.Exportable) error
}

Exporter exports telemetry data to some destination.

type GraphGetter

type GraphGetter interface {
	GetLatestGraph() *graph.Graph
}

GraphGetter gets the latest Graph.

type LabelCollector

type LabelCollector struct {
	// contains filtered or unexported fields
}

LabelCollector is an implementation of AgentLabelCollector.

func NewLabelCollector

func NewLabelCollector(
	cfg LabelCollectorConfig,
) *LabelCollector

NewLabelCollector creates a new LabelCollector.

func (*LabelCollector) Collect

func (l *LabelCollector) Collect(ctx context.Context) (map[string]string, error)

Collect gathers metadata labels needed for reporting to Agent v3.

type LabelCollectorConfig

type LabelCollectorConfig struct {
	// K8sClientReader is a Kubernetes API client Reader.
	K8sClientReader client.Reader
	// Version is the NGF version.
	Version string
	// PodNSName is the NamespacedName of the NGF Pod.
	PodNSName types.NamespacedName
}

LabelCollectorConfig holds configuration parameters for LabelCollector.

type LoggingExporter

type LoggingExporter struct {
	// contains filtered or unexported fields
}

LoggingExporter logs telemetry data.

func NewLoggingExporter

func NewLoggingExporter(logger logr.Logger) *LoggingExporter

NewLoggingExporter creates a new LoggingExporter.

func (*LoggingExporter) Export

func (e *LoggingExporter) Export(_ context.Context, data tel.Exportable) error

Export logs the provided telemetry data.

type NGFResourceCounts

type NGFResourceCounts struct {
	// GatewayCount is the number of relevant Gateways.
	GatewayCount int64
	// GatewayClassCount is the number of relevant GatewayClasses.
	GatewayClassCount int64
	// HTTPRouteCount is the number of relevant HTTPRoutes.
	HTTPRouteCount int64
	// TLSRouteCount is the number of relevant TLSRoutes.
	TLSRouteCount int64
	// SecretCount is the number of relevant Secrets.
	SecretCount int64
	// ServiceCount is the number of relevant Services.
	ServiceCount int64
	// EndpointCount include the total count of Endpoints(IP:port) across all referenced services.
	EndpointCount int64
	// GRPCRouteCount is the number of relevant GRPCRoutes.
	GRPCRouteCount int64
	// BackendTLSPolicyCount is the number of relevant BackendTLSPolicies.
	BackendTLSPolicyCount int64
	// GatewayAttachedClientSettingsPolicyCount is the number of relevant ClientSettingsPolicies
	// attached at the Gateway level.
	GatewayAttachedClientSettingsPolicyCount int64
	// RouteAttachedClientSettingsPolicyCount is the number of relevant ClientSettingsPolicies attached at the Route level.
	RouteAttachedClientSettingsPolicyCount int64
	// ObservabilityPolicyCount is the number of relevant ObservabilityPolicies.
	ObservabilityPolicyCount int64
	// NginxProxyCount is the number of NginxProxies.
	NginxProxyCount int64
	// SnippetsFilterCount is the number of SnippetsFilters.
	SnippetsFilterCount int64
	// UpstreamSettingsPolicyCount is the number of UpstreamSettingsPolicies.
	UpstreamSettingsPolicyCount int64
	// GatewayAttachedNpCount is the total number of NginxProxy resources that are attached to a Gateway.
	GatewayAttachedNpCount int64
}

NGFResourceCounts stores the counts of all relevant resources that NGF processes and generates configuration from.

func (*NGFResourceCounts) Attributes

func (d *NGFResourceCounts) Attributes() []attribute.KeyValue

type RouteCounts

type RouteCounts struct {
	HTTPRouteCount int64
	GRPCRouteCount int64
	TLSRouteCount  int64
}