Snowplow Mini is, in essence, the Snowplow real time stack inside of a single image. It is an easily-deployable, single instance version of Snowplow that serves three use cases:
- Giving a Snowplow consumer (e.g. an analyst / data team / marketing team) a way to quickly understand what Snowplow “does” i.e. what you put it at one end and take out of the other
- Giving developers new to Snowplow an easy way to start with Snowplow and understand how the different pieces fit together
- Giving people running Snowplow a quick way to debug tracker updates (because they can)
The software stack installed:
- Snowplow Stream Collector NSQ 0.13.0
- Snowplow Stream Enrich NSQ 0.21.0
- Snowplow Elasticsearch Loader 0.10.2
- Snowplow Iglu Server 0.3.0
- Elasticsearch-OSS 6.3.1
- Kibana-OSS 6.3.1
- Postgresql 9.5
- NSQ v1.0.0-compat
Note: All services are configured to start automatically so everything should happily survive restarts/shutdowns.
To understand the flow of data please refer to the following diagram:
Importing public tarballs to a GCP project
Our offering for GCP is 3 compressed tarballs for 3 different sized Snowplow Mini, produced through
export command. Simply put, they are Virtual Disk images exported in GCP format, a
disk.raw file that has been tarred and gzipped.
To use them within GCP console, you need to import a tarball of your choice into your GCP project. You can use
gcloud CLI utility to do that.
Browse GCP docs to get started with
Assuming you have
gcloud setup and configured for your GCP project, use
create command to import a tarball of your choice into your GCP project.
A sample usage would be as following.
gcloud compute images create \ imported-sp-mini \ --source-uri \ https://storage.googleapis.com/snowplow-mini/snowplow-mini-0-6-1-large-1561974558.tar.gz
imported-sp-mini is a name of your choice for destination image and above URI is for large image, change it with your preferred version of Snowplow Mini.
You can find more about
gcloud compute images create command here for additional parameters.
After importing our tarball of your choice into your project, you should see it under
To decide on which size of Snowplow Mini to choose, read on.
Until today, Snowplow Mini was being used inside AWS
n1-standard-1 in GCP, instances and it served well for demonstration purposes. However, we observed that Snowplow Mini started exceeding its initial motivation and machine resources started to become an obstacle, causing issues with Elasticsearch etc. This is why, Mini is available at 3 different sizes.
large: Same image published so far. Elasticsearch has
4gheap size and Snowplow apps has
0.5gheap size. Recommended machine RAM is
xlarge: Double the large image. Elasticsearch has
8gheap size and Snowplow apps has
1.5gheap size. Recommended machine RAM is
xxlarge: Double the xlarge image. Elasticsearch has
16gheap size and Snowplow apps has
3gheap size. Recommended machine RAM is
Compute Engine on GCP console, select
Images from menu on the left. You should see your imported image on the list. Select it then you should see
CREATE INSTANCE button at the top of the page. Click on it.
These images show setup for
large image. To setup
xxlarge, you should increase memory per above explanation of different sizes.