Getting Started

We assume that you have working HBase and elasticsearch clusters.

• Clone the code from github

    git clone [email protected]:Flipkart/foxtrot.git

• Build and using maven3

    mvn clean install

Note: This takes a long time to build due to large number of test-cases. To skip tests (not-recommended) add the "-DskipTests" flag to the above command.

• Configuration file is present in config directory. Edit it to fit your needs. Refer link for sample configuration.

• Initialize the meta tables and the mapping templates in elasticsearch and create common table in hbase

    java -Dfile.encoding=utf-8 -jar foxtrot-server/target/foxtrot-server-0.1.jar initialize config/local.yml

• Start the service

    java -Dfile.encoding=utf-8 -jar foxtrot-server/target/foxtrot-server-0.1.jar server config/local.yml

• Create a table

    curl -H 'Content-type: application/json' -XPOST http://localhost:18000/foxtrot/v1/tables -d '{ "name" : "testapp",  "ttl" : 7 }'

• To push events, use the event ingestion APIs. See the Event Ingestion page for API details. You can also use the java based client to push data.

• See Using the data in Foxtrot to understand how to access your data.