Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nbs-system/mapster
Live events map as a Kibana plugin
https://github.com/nbs-system/mapster
geospatial kibana kibana-plugin visualization
Last synced: 3 months ago
JSON representation
Live events map as a Kibana plugin
- Host: GitHub
- URL: https://github.com/nbs-system/mapster
- Owner: nbs-system
- License: gpl-3.0
- Created: 2016-06-16T16:46:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-10T20:47:51.000Z (about 7 years ago)
- Last Synced: 2024-06-26T13:32:44.844Z (5 months ago)
- Topics: geospatial, kibana, kibana-plugin, visualization
- Language: JavaScript
- Size: 1.77 MB
- Stars: 73
- Watchers: 12
- Forks: 34
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-elasticsearch - nbs-system/mapster - a visualization which allows to create live event 3d maps in Kibana (Kibana plugins and applications / Kibana Visualization plugins)
- elasticsearch-collection - nbs-system/mapster - a visualization which allows to create live event 3d maps in Kibana (Kibana plugins and applications / Kibana Visualization plugins)
README
# Mapster
[](https://www.codacy.com/app/xarkes/mapster)
Mapster is a real-time event map implemented as a [Kibana](https://github.com/elastic/kibana) [visualization](https://www.elastic.co/guide/en/kibana/current/visualize.html).
# How does it work
Mapster is not truely in real-time. It fetches the events from ElasticSearch using Kibana and replays the events in real
time with a lag corresponding to the Kibana refresh time.
For best performances, Kibana dashboard should be set to collect events from last 30 seconds and to refresh every 30 seconds too.
The refresh rate should be equal to the window time.
To draw the 2D map, Mapster uses [d3js](https://d3js.org/) and it uses [threejs](https://threejs.org/) to draw the 3D globe.
# Installation
## Requirements
- Kibana 4.5.0 (the only supported version for now)
## Instructions
Simply clone the repository into your Kibana plugins folder:
```sh
cd installedPlugins && git clone https://github.com/xarkes/mapster
```
If you are using Kibana from git and starting it in `dev` mode, Kibana will automatically refresh its cache and the plugin
will be successfully loaded.
Otherwise you can force it by stopping kibana, deleting the cache and starting kibana again.
```sh
rm -r optimize/bundles
./bin/kibana
```
From now, you should see that Mapster is available in the Visualization tab of Kibana. Now set your kibana events to
last 30 seconds, enable auto-refresh and enjoy !
# Configuration
To add Mapster to a dashboard, first create a new [visualization](https://www.elastic.co/guide/en/kibana/current/visualize.html).
## Important information
Notice that when customizing the visualization some options are not automatically refreshed and you might need to do a manual refresh (F5).
## Choosing correct aggregations
The metric should be set to `Count`.
The first aggregation is as described the timestamp matching the event. You should use a `Date Histogram` with the Interval set to `Seconds`.
The second aggregation is the event coordinates so you have to use a `Geohash` matching the event's origin.
The third aggregation is the target IP. It is used to aggregate multiple events from the same IP on the map.
The fourth aggregation is the sensor. The sensor is used to differentiate event types on the map.
Then you can add any other aggregation if you need to filter your events using the kibana search field.
## Plugin options
| Option name | Meaning |
|-------------------------------|--------------------------------------------------------------------------------------------|
| Use a 3D Map ? | Well ... do you prefer a 2D plan or a 3D globe ? |
| Object shape | The svg shape of the object thrown from the origin to the target. |
| Object scale | The scale of the above shape. |
| Object rotation | The object rotation. If the object is looking to the top, the rotation is 90 degrees. |
| Target coords | This is the location on the map of the target. |
| Special effects | The sensor field used to display the event as a special effect. |
| Special effects scale | The scale of the special effects. |
| Special shape | Shape used to mark a special event on the map. |
| Special scale | The scale of the above shape. |
| Special remaining time | The duration the special shape stays on the map. |
| Origin default size | The default size of a circle (origin). |
| Origin maximum size | The maximum size of a circle. |
| Origin dying time | The time the origin dies. |
| Hide events at (0,0) | If some of your data are located at (0,0) you can choose to hide them or not. |
| Enable explosions | Do you want explosions ?! |
| Explosion file | The name of your explosion file (GIF format). It should be located under the img/ folder. |
| Explosion height | The height of the explosion file (if you want to resize it). |
| Explosion width | The width of the explosion file (if you want to resize it too). |
| Explosion delay (in ms) | The duration in ms of the gif. |
| Number of events in the logs | Number of lines in the event logs table. |
| | |
# Screenshots
