ipread

Documentation

Index

• Variables
• func NewProviderRefreshModule(name string, settings RefreshSettings) kernel.ModuleFactory
• func NewReader(ctx context.Context, config cfg.Config, logger log.Logger, name string) (*reader, error)
• func ProvideMemoryProvider(name string) *memoryProvider
• func ProvideReader(ctx context.Context, config cfg.Config, logger log.Logger, name string) (*reader, error)
• func RefreshModuleFactory(ctx context.Context, config cfg.Config, logger log.Logger) (map[string]kernel.ModuleFactory, error)
• type GeoCity
• type MaxmindSettings
• type MemoryRecord
• type Provider
  • func NewMaxmindProvider(ctx context.Context, config cfg.Config, logger log.Logger, name string) (Provider, error)
  • func NewMemoryProvider(_ context.Context, _ cfg.Config, _ log.Logger, name string) (Provider, error)
• type ProviderFactory
• type Reader
• type ReaderSettings
• type RefreshModule
  • func (m *RefreshModule) IsHealthy(ctx context.Context) (bool, error)
  • func (m *RefreshModule) Run(ctx context.Context) (err error)
• type RefreshSettings

Variables

var (
	ErrIpParseFailed = errors.New("failed to parse geo ip")
	ErrIpNotFound    = errors.New("ip not found")
)

Functions

func NewProviderRefreshModule

func NewProviderRefreshModule(name string, settings RefreshSettings) kernel.ModuleFactory

func NewReader

func NewReader(ctx context.Context, config cfg.Config, logger log.Logger, name string) (*reader, error)

func ProvideMemoryProvider

func ProvideMemoryProvider(name string) *memoryProvider

func ProvideReader

func ProvideReader(ctx context.Context, config cfg.Config, logger log.Logger, name string) (*reader, error)

func RefreshModuleFactory

func RefreshModuleFactory(ctx context.Context, config cfg.Config, logger log.Logger) (map[string]kernel.ModuleFactory, error)

Types

type GeoCity

type GeoCity struct {
	City        string `json:"city"`
	CountryCode string `json:"countryCode"`
	Ip          string `json:"ip"`
	TimeZone    string `json:"timeZone"`
}

type MaxmindSettings

type MaxmindSettings struct {
	Database     string `cfg:"database"`
	S3ClientName string `cfg:"s3_client_name"`
}

type MemoryRecord

type MemoryRecord struct {
	CountryIso string `cfg:"country_iso"`
	CityName   string `cfg:"city_name"`
	TimeZone   string `cfg:"time_zone"`
}

type Provider

type Provider interface {
	City(ipAddress net.IP) (*geoip2.City, error)
	Refresh(ctx context.Context) error
	Close() error
}

func NewMaxmindProvider

func NewMaxmindProvider(ctx context.Context, config cfg.Config, logger log.Logger, name string) (Provider, error)

func NewMemoryProvider

func NewMemoryProvider(_ context.Context, _ cfg.Config, _ log.Logger, name string) (Provider, error)

type ProviderFactory

type ProviderFactory func(ctx context.Context, config cfg.Config, logger log.Logger, name string) (Provider, error)

type Reader

type Reader interface {
	City(ipString string) (*GeoCity, error)
}

type ReaderSettings

type ReaderSettings struct {
	Provider string          `cfg:"provider" default:"maxmind"`
	Refresh  RefreshSettings `cfg:"refresh"`
}

type RefreshModule

type RefreshModule struct {
	kernel.BackgroundModule
	kernel.ServiceStage
	kernel.HealthCheckedModule
	// contains filtered or unexported fields
}

func (*RefreshModule) IsHealthy

func (m *RefreshModule) IsHealthy(ctx context.Context) (bool, error)

func (*RefreshModule) Run

func (m *RefreshModule) Run(ctx context.Context) (err error)

type RefreshSettings

type RefreshSettings struct {
	Enabled  bool          `cfg:"enabled" default:"false"`
	Interval time.Duration `cfg:"interval" default:"24h"`
}