Skip to main content

Analysis tool for funnel visualization with log from Elasticsearch

Project description

## Elastic Funnel

This is an analysis tool for funnel visualization with log from Elasticsearch. Even though we have [Kibana] to display log very well,
it can't fit our goal to analyze series log with context.

[Kibana]:https://www.elastic.co/products/kibana

### Constraint

** You have to add at least a field with ```state_name``` into your index **

### Quick Start CLI

Install

```
pip install elastic_funnel
```

Arguments

```
usage: elastic_funnel [-h] [--host HOST] [--port PORT] [--index INDEX]
--stages STAGES [STAGES ...] [--start START] [--end END]
[--query QUERY]

optional arguments:
-h, --help show this help message and exit
--host HOST Host of Elasticsearch
--port PORT Port of Elasticsearch
--index INDEX Index name of Elasticsearch, e.g., user-behavior-log-*
--stages STAGES [STAGES ...]
Set a path of stages , e.g., index explore user
explore
--start START Start time of log, e.g., 2016-03-24T00:00:00
--end END End time of log, e.g., 2016-03-28T00:00:00
--query QUERY Additional query using syntax of Lucene, https://lucen
e.apache.org/core/2_9_4/queryparsersyntax.html. You
can narrow you search target by syntax, e.g.,
country:US
```

Run for a funnel

```
elastic_funnel --host=<elasticsearch_ip> --port=<elasticsearch_port> --stages index newTopic playgroundTopic --start 2016-03-25T00:00:00
```

Funnel visualization

```
Funnel: index newTopic playgroundTopic
###############################################################################
██████████████████████████████████████████████████ 27 100.0% index
██████████████ 8 29.6% newTopic
█ 1 12.5% playgroundTopic
```

### Quick Start with Gunicorn and cRUL (Developing)

To run this script, a Gunicorn server will be run on your host:

```
$ ./funnel_web.sh
```

```
curl -XPOST -H "Content-Type: application/json" http://localhost:5578/funnel -d '
{
"start_time": "2016-03-24T00:00:00",
"end_time": "2016-03-26T00:00:00"
}'
```

```
Funnel
###############################################################################
███████████████████████████████████████████████████ 30 100.0% index
██████ 4 13.3% newTopic
0 0.0% playgroundTopic
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elastic_funnel-0.0.3.tar.gz (5.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page