Snowplow Micro API reference
See this guide for learning about Snowplow Micro and getting started with it.
tip
You can always run Micro with the --help argument to find out what is supported:
bash
docker run -p 9090:9090 snowplow/snowplow-micro:4.0.0 --help
Arguments
| Argument | Description |
|---|---|
--collector-config | Configuration file for collector (usage) |
--iglu | Configuration file for Iglu Client (usage) |
-t, --output-tsv(since 1.4.0) | Print events in TSV format to standard output (usage) |
-j, --output-json(since 2.4.0) | Print events in JSON format to standard output (usage) |
-d, --destination(since 2.4.0) | Send data to an HTTP endpoint instead of outputting it via standard output. Requires either --output-tsv or --output-json (usage) |
--yauaa | Enable YAUAA user agent enrichment (usage) |
--no-storage(since 4.0.0) | Do not store the events anywhere and disable the API |
--storage(since 4.0.0) | Enable PostgreSQL storage backend (usage) |
Environment variables
| Variable | Version | Description |
|---|---|---|
MICRO_IGLU_REGISTRY_URL | 1.5.0+ | The URL for an additional custom Iglu registry (usage) |
MICRO_IGLU_API_KEY | 1.5.0+ | An optional API key for an Iglu registry defined with MICRO_IGLU_REGISTRY_URL |
MICRO_SSL_CERT_PASSWORD | 1.7.0+ | The password for the optional SSL/TLS certificate in /config/ssl-certificate.p12. Enables HTTPS (usage) |
MICRO_POSTGRESQL_PASSWORD | 4.0.0+ | The password for the optional PostgreSQL database (usage) |
MICRO_AZURE_BLOB_ACCOUNT | 4.0.0+ | The Azure blob storage account name to use for downloading enrichment assets |
MICRO_AZURE_BLOB_SAS_TOKEN | 4.0.0+ | The Azure blob storage account token to use for downloading enrichment assets |