provider

Documentation

Index

• Variables
• type Config
• type GeoIPProvider
• type GeoIPProviderFactory

Variables

var ErrNoMetadataFound = errors.New("no geo IP metadata found")

ErrNoMetadataFound error should be returned when a provider could not find the corresponding IP metadata

Types

type Config

type Config interface {
	component.ConfigValidator
}

Config is the configuration of a GeoIPProvider.

type GeoIPProvider

type GeoIPProvider interface {
	// Location returns a set of attributes representing the geographical location for the given IP address. It requires a context for managing request lifetime.
	Location(context.Context, net.IP) (attribute.Set, error)
}

GeoIPProvider defines methods for obtaining the geographical location based on the provided IP address.

type GeoIPProviderFactory

type GeoIPProviderFactory interface {
	// CreateDefaultConfig creates the default configuration for the GeoIPProvider.
	CreateDefaultConfig() Config

	// CreateGeoIPProvider creates a provider based on this config. Processor's settings are provided as an argument to initialize the logger if needed.
	CreateGeoIPProvider(ctx context.Context, settings processor.Settings, cfg Config) (GeoIPProvider, error)
}

GeoIPProviderFactory can create GeoIPProvider instances.