Configuring enrichments

By default, Micro does not have any enrichments enabled. This page shows how you can enable them.

YAUAA (Yet Another User Agent Analyzer)#

One of the most useful enrichments, YAUAA, requires no configuration, and can be turned on simply with the --yauaa flag (since version 3.0.1):

docker run -p 9090:9090 snowplow/snowplow-micro:3.0.1 --yauaa

Memory usage

We recommend not enabling this enrichment in a CI setting unless necessary, because it consumes a few extra hundred MB of RAM.

Other enrichments#

You can enable any enrichments you like by passing corresponding configuration files to Micro.

Limitations for enrichments that rely on data files

Some enrichments require data files (e.g. a database of IPs).

The Enrich application in a full Snowplow pipeline will automatically download and periodically update these files. However, Micro will only download them once. You can always restart Micro to get a fresher copy of the files.

Also, the Enrich application supports files located in S3 and GCS with the s3:// and gs:// schemes respectively. Micro currently only supports http:// and https://. You can often rewrite the URL to make it work:

• s3://my-bucket/x/y → https://my-bucket.s3.amazonaws.com/x/y
• gs://my-bucket/x/y → https://storage.googleapis.com/my-bucket/x/y

For example, let’s say that you want to configure the IP Lookup enrichment. The default configuration file looks like this:

config/enrichments/ip_lookups.json

loading...

View on GitHub

Put this file somewhere on the machine where you are running Micro, let’s say my-enrichments/ip_lookups.json. (Feel free to add any other configurations to my-enrichments).

Now you will need to pass this directory to the Docker container (using a bind mount):

docker run -p 9090:9090 \
--mount type=bind,source=$(pwd)/my-enrichments,destination=/config/enrichments \
snowplow/snowplow-micro:3.0.1

note

The directory inside the container (what goes after destination=) must be exactly /config/enrichments.

Alternatively, if you are running Micro as a Java application, put your enrichment configurations in some-directory/enrichments on your machine (enrichments must be called exactly that) and use the following command:

java -cp micro-3.0.1.jar:some-directory com.snowplowanalytics.snowplow.micro.Main

Once Micro starts, you should see messages like these:

[INFO] com.snowplowanalytics.snowplow.micro.Run - Downloading http://snowplow-hosted-assets.s3.amazonaws.com/third-party/maxmind/GeoLite2-City.mmdb...
[INFO] com.snowplowanalytics.snowplow.micro.Run - Enabled enrichments: IpLookupsEnrichment

tip

Micro is especially great for testing the JavaScript enrichment.