Skip to content

snowplow/snowplow-elasticsearch-loader

Repository files navigation

Snowplow Elasticsearch Loader

Build Status GithubRelease License

Introduction

The Snowplow Elasticsearch Loader consumes Snowplow enriched events or failed events from an Amazon Kinesis stream or NSQ topic, transforms them to JSON, and writes them to Elasticsearch. Events which cannot be transformed or which are rejected by Elasticsearch are written to a separate Kinesis stream.

Building

Assuming you already have SBT installed:

$ git clone git://github.com/snowplow/snowplow-elasticsearch-loader.git
$ sbt compile

Usage

The Snowplow Elasticsearch Loader has the following command-line interface:

snowplow-elasticsearch-loader 2.1.2

Usage: snowplow-elasticsearch-loader [options]

  --config <filename>

Running

Create your own config file:

$ cp config/config.kinesis.reference.hocon my.conf

Update the configuration to fit your needs.

Next, start the loader, making sure to specify your new config file:

$ java -jar snowplow-elasticsearch-loader-2.1.2.jar --config my.conf

Find out more

Technical Docs Setup Guide Roadmap Contributing
i1 i2 i3 i4
Technical Docs Setup Guide Roadmap Contributing

Copyright and license

Copyright 2014-2023 Snowplow Analytics Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.