maxmind

README

MaxMind GeoIP Provider

This package provides a MaxMind GeoIP provider for use with the OpenTelemetry GeoIP processor. It leverages the geoip2-golang package to query geographical information associated with IP addresses from MaxMind databases. See recommended clients: https://dev.maxmind.com/geoip/docs/databases#api-clients

Features

• Supports GeoIP2-City and GeoLite2-City database types.
• Retrieves and returns geographical metadata for a given IP address. The generated attributes follow the internal Geo conventions.

Configuration

The following configuration must be provided:

• database_path: local file path to a GeoIP2-City or GeoLite2-City database.

Documentation

Index

• Constants
• type Config
  • func (c *Config) Validate() error
• type Factory
  • func (f *Factory) CreateDefaultConfig() provider.Config
  • func (f *Factory) CreateGeoIPProvider(_ context.Context, _ processor.Settings, cfg provider.Config) (provider.GeoIPProvider, error)

Constants

const (
	// TypeStr the value of "type" key in configuration.
	TypeStr = "maxmind"
)

Types

type Config

type Config struct {
	// DatabasePath section allows specifying a local GeoIP database
	// file to retrieve the geographical metadata from.
	DatabasePath string `mapstructure:"database_path"`
}

Config defines configuration for MaxMind provider.

func (*Config) Validate

func (c *Config) Validate() error

Validate implements provider.Config.

type Factory

type Factory struct{}

Factory is the Factory for the MaxMind GeoIP provider.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() provider.Config

CreateDefaultConfig creates the default configuration for the Provider.

func (*Factory) CreateGeoIPProvider

func (f *Factory) CreateGeoIPProvider(_ context.Context, _ processor.Settings, cfg provider.Config) (provider.GeoIPProvider, error)

CreateGeoIPProvider creates a provider based on this config.