Skip to content

Flipkart/foxtrot

Repository files navigation

Foxtrot Build Status

Join the chat at https://gitter.im/Flipkart/foxtrot

Foxtrot is a data store abstraction service for storing event data for real-time systems. It combines the power of fast row get/put by HBase and powerful indexing and aggregation features provided by Elasticsearch. Foxtrot provides:

  • REST api's for event ingestion with batched input, simple analytics and other functionality
  • SQL subset (FQL) for querying and running analytics on ingested events
  • Reconfigurable console builder to build useful consoles that can be shared among people
  • Intelligent caching of queries to load-balance on console heavy query loads
  • A very extensible design that needs three annotated classes to be added to the source for adding a new kind of analytics operation

##Web console and console builder Foxtrot has built in support for building, saving and managing your own custom consoles. Foxtrot container itself will host and render your console for you. The backend is optimized for serving aggregated views to large number of open monitoring consoles, without bringing the ES cluster to it's knees.

There are several customizable widgets including donuts, bars and trend views with support for filtering and visualizing the data that you need to see.

Console build using out of the box console builder and served by foxtrot

##Foxtrot query language Besides the console, foxtrot supports a SQL compatible query language for querying as well as running aggregations on the ingested events. FQL commands can be run on the foxtrot web console or (for the unix nerd in us) from the command line.

Command-line FQL output

Web console output

Documentation

Check the Wiki for detailed documentation.

Version

6.8.8-1

Docker

Docker can be found on DockerHub

Docker can be customised using environment variables. Refer here for the variables that need to be passed.

Volume mount the config file in a docker. And pass in the full path to file CONFIG_PATH environment variable.

Tech

Foxtrot uses a number of open source projects to work properly:

Contribution, Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

Please follow the contribution guidelines when submitting pull requests.

LICENSE

Copyright 2014 Flipkart Internet Pvt. Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

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.