1. Dependencies
You will need version 11 of the Java Runtime Environment installed.
2. Obtaining
You can choose to either:
- Use a docker image, or:
- Compile it from source and use a jar file
2.1 Getting a docker image
The recommended way of using Stream Enrich is via Docker. You can obtain the image from dockerhub:
Code language: PHP (php)$ docker pull snowplow/stream-enrich-$PLATFORM:latest
Where targeted $PLATFORM
can be one of:
- kinesis
- kafka
- nsq
- stdin
2.2 Compile from source
Alternatively, you can build it from the source files. To do so, you will need Java Runtime Environment 11 and sbt installed.
To do so, clone the Snowplow Enrich repo:
$ git clone https://github.com/snowplow/enrich.git
Code language: PHP (php)
Use sbt
to resolve dependencies, compile the source, and build an assembled fat JAR
file with all dependencies.
$ sbt "project $PLATFORM" assembly
Code language: JavaScript (javascript)
Where targeted $PLATFORM
can be one of:
- kinesis
- kafka
- nsq
- stdin
The JAR file will be saved as snowplow-stream-enrich-$PLATFORM-[version].jar
in the $PLATFORM/target/scala-2.1
2 subdirectory – it is now ready to be deployed.