Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flipkart/foxtrot

A store abstraction and analytics system for real-time event data.
https://github.com/flipkart/foxtrot

alerting analytics data-engineering data-science data-visualization elasticsearch hbase java monitoring

Last synced: 1 day ago
JSON representation

A store abstraction and analytics system for real-time event data.

Host: GitHub
URL: https://github.com/flipkart/foxtrot
Owner: Flipkart
License: apache-2.0
Created: 2014-05-20T12:52:55.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2023-12-16T20:27:09.000Z (11 months ago)
Last Synced: 2024-07-10T12:46:02.515Z (4 months ago)
Topics: alerting, analytics, data-engineering, data-science, data-visualization, elasticsearch, hbase, java, monitoring
Language: Java
Homepage:
Size: 11.9 MB
Stars: 11
Watchers: 4
Forks: 6
Open Issues: 23
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Support: support/images/FQL-UI.png

Awesome Lists containing this project

README

Foxtrot [![Build Status](https://travis-ci.org/Flipkart/foxtrot.svg?branch=master)](https://travis-ci.org/Flipkart/foxtrot.svg?branch=master)
=========

[![Join the chat at https://gitter.im/Flipkart/foxtrot](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Flipkart/foxtrot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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](https://github.com/Flipkart/foxtrot/blob/master/support/images/FoxtrotScreen.png)

##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](https://github.com/Flipkart/foxtrot/blob/master/support/images/FQL.png)

![Web console output](https://github.com/Flipkart/foxtrot/blob/master/support/images/FQL-UI.png)

Documentation
-------------
Check the [Wiki](https://github.com/Flipkart/foxtrot/wiki/Introduction) for detailed documentation.

Version
----
6.8.8-1

Docker
------
Docker can be found on [DockerHub](https://hub.docker.com/layers/santanusinha/foxtrot/6.8.8-1/images/sha256-01cb327eb0353d31874681ee9ece4df8993b2152dfd3fa7279a31e3d7e32ee7e?context=explore)

Docker can be customised using environment variables. Refer [here](https://github.com/Flipkart/foxtrot/blob/simple_auth/config/docker.yml) 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:

* [Elasticsearch](http://www.elasticsearch.org/) - awesome distributed search query store based on lucene
* [HBase](http://hbase.apache.org/) - distributed, scalable big data-store
* [Hazelcast](http://hazelcast.org/) - distributed data grid
* [Dropwizard](https://dropwizard.github.io/dropwizard/) - REST web services framework
* [Twitter Bootstrap 3](http://getbootstrap.com/) - great UI boilerplate for modern web apps
* [Bootstrap validator](https://github.com/1000hz/bootstrap-validator) - a form validation plugin for bootstrap
* [Bootstrap select](http://silviomoreto.github.io/bootstrap-select/) - A ui selection widget for bootstrap
* [Flot](http://www.flotcharts.org/) - superfast javascript charting library
* [D3](http://d3js.org/) - data visualization library
* [Handlebars](http://handlebarsjs.com/) - templating library
* [jQuery](http://jquery.com) - backend API calls and DOM access
* [jQuery UI](http://jqueryui.com) - extensible ui framework

Contribution, Bugs and Feedback
-------------------------------

For bugs, questions and discussions please use the [Github Issues](https://github.com/Flipkart/foxtrot/issues).

Please follow the [contribution guidelines](https://github.com/Flipkart/foxtrot/blob/master/CONTRIBUTING.md) when submitting pull requests.

LICENSE
-------

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.