# README

MaxMind GeoIP Provider

Use of MaxMind and other geolocation databases are subject to applicable licenses and terms governing the databases. Consult the database provider for the latest applicable terms.

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.

# Constants

TypeStr the value of "type" key in configuration.

# Structs

Config defines configuration for MaxMind provider.
Factory is the Factory for the MaxMind GeoIP provider.