Skip to content

Latest commit

 

History

History
177 lines (127 loc) · 6.06 KB

README.md

File metadata and controls

177 lines (127 loc) · 6.06 KB
Raw

annotation-service

GoDoc Build Status Coverage Status Go Report Card

Annotation integration service provides geolocation for IPv4 and IPv6 MaxMind databases from Google Cloud Storage.

API

v1 - Deprecated

This is the original, deprecated API, which includes an unwrapped array of RequestData objects. Its use is discouraged. Please use the v2 API, which has better support for batch requests, including returning the date of the Annotator used to provide the annotations.

v2

The v2 api introduces a standard wrapper struct, beginning with a string specifying the version identifier, and an Info string that may include arbitrary request info, e.g. for use in tracing or debugging. It is described in the api/v2 package in the api/v2 directory. The recommended GetAnnotations function is only available in the v2 package.

Response contents

Annotatation service will respond with the following data:

  • IP Address range
  • Postal Code
  • Latitude
  • Longitude
  • Continent Code
  • Country Code
  • Country Name
  • Metro Code
  • City Name

Code structure

The code is divided into the following packages (organized in rough order of dependencies, except for api package):

  • api - defines external API, including GetAnnotations() call which handles composing and sending requests, with retries.
  • manager - handles caching of Annotators
  • directory - used by manager to create and keep track of CompositeAnnotators.
  • handler - receives incoming requests, handles marshalling, unmarshalling, interpretation of requests.
  • geoloader - maintains directory of available MaxMind (GEO) and Routeview (ASN) files, and selects which file(s) to use for a given date. (Needs a lot of renaming)
  • asn - handles details of interpreting RouteViews ASN files, and creating ASN annotators.
  • geolite2v2 and legacy - handle details of interpreting MaxMind files and creating annotators. Currently this is divided into two packages, but should be merged.
  • loader - handles files downloads and decompression
  • iputil - general IP utility functions that are used across asn, legacy geo, and geolite2 datasets.
  • metrics - all metric definitions.

Dependencies (as of April 2019)

(higher depends on lower, left -> depends on right)

  • main.go
  • manager -> handler, directory
  • geoloader -> asn, geolite2v2, legacy
  • iputils -> loader
  • api, metrics

Maxmind Dataset details

If an annotation request is dated prior to August 2017, location data will be derived from MaxMind GeoLiteLatest databases. Otherwise, data will be provided by MaxMind GeoLite2 databases. The discrepencies between provided databases are provided below.

MaxMind GeoLiteLatest databases include:

  1. GeoLiteCity-Blocks.csv

    • StartIPNum IPv4
    • EndIPNum IPv4
    • GeonameID

  2. GeoLiteCity-Location.csv

    • GeonameID
    • Country Code
    • City
    • Postal Code
    • Logitude
    • Latitude
    • MetroCode

MaxMind GeoLite2 databases include:

  1. GeoLite2-City-Blocks-IPv4.csv & GeoLite2-City-Blocks-IPv6.csv

    • IP network (CIDR Format)
    • GeonameID (identifies end user location)
    • Registered Country Geoname ID (identifies country where IP address is registered to an ISP)
    • Latitude
    • Longitude

  2. GeoLite2-City-Locations-en.csv

    • GeonameID
    • Continent Code
    • Country ISO
    • Country Name
    • City Name
    • Metro Code

GeonameID is the same with Registered Country Geoname ID most of time, but with some exceptions. Either GeonameID or Registered Country Geoname ID could be not available for some IP addresses.

Important discrepencies to note include:

  1. GeoLite2 databases provides a network IP range in CIDR format while GeoLiteLatest databases provide an IP range in decimal format.
  2. GeoLite2 provides both end user location as well as country registration information while GeoLiteLatest includes only end user location. www.maxmind.com/en/geoip2-precision-city-service

CompositeAnnotator

CompositeAnnotator encapsulates multiple component api.Annotator objects, and satisfies the api.Annotator interface.

MergeAnnotators takes two or more []api.Annotator, and merges them, creating CompositeAnnotators for each distinct date, using the most recent Annotator from each list prior to that date.

Directory

Directory wraps a []api.Annotator, and provides the GetAnnotator(date time.Time) function.

CachingLoader

CachingLoader specifies the interface provided by loaders that load and cache a list of annotators.

  1. Maintains list of loaded Annotator objects.
  2. Refreshes the list of loaded objects on demand.
type CachingLoader interface {
  UpdateCache() error
  Fetch() []Annotator
}

Local Testing

Install dependencies for geoip-dev and pkg-config using your local package manager. See .travis.yml and Dockerfile for examples.

Because the default operation of the annotation service is to load all historical data, the RAM requirements are significant. Instead, for local testing, specify alterante date patterns for maxmind and routeview files.

go get .
~/bin/annotation-service -maxmind_dates '2013/10/07' -routeview_dates '2013/10'

The annotation service supports two endpoints: /batch_annotate and /annotate. The /annotate resource accepts HTTP GET with parameters.

  • since_epoch= specifies the timestamp of the annotation.
  • ip_addr= specifies the IP address that should be annotated.

NOTE: for local testing, only the loaded RouteView and Maxmind databases are used for all dates.

Perform an adhoc query using curl:

curl 'http://localhost:8080/annotate?since_epoch=1380600000&ip_addr=67.86.65.1' | jq