diskover is an open source file system crawler and disk usage software that uses Elasticsearch to index and manage data across heterogeneous storage systems. Using diskover, you are able to more effectively search and organize files and system administrators are able to manage storage infrastructure, efficiently provision storage, monitor and report on storage use, and effectively make decisions about new infrastructure purchases.
As the amount of file data generated by business' continues to expand, the stress on expensive storage infrastructure, users and system administrators, and IT budgets continues to grow.
Using diskover, users can identify old and unused files and give better insights into data change, file duplication and wasted space.
diskover is written and maintained by Chris Park (shirosai) and runs on Linux and OS X/macOS using Python 2/3.
Screenshotsdiskover-web (diskover's web file manager, analytics app, file system search engine, rest-api)
Kibana dashboards/saved searches/visualizations and support for Gource
Diskover Gource videos
Installation Guide
Requirements
Linux or OS X/macOS(tested on OS X 10.11.6, Ubuntu 16.04)Python 2.7. or Python 3.5./3.6.(tested on Python 2.7.14, 3.5.3, 3.6.4)Python elasticsearch client modulePython requests modulePython scandir modulePython progressbar2 modulePython redis modulePython rq moduleElasticsearch 5(local or AWS ES Service, tested on Elasticsearch 5.4.2, 5.6.4) Elasticsearch 6 is not supported yet.Redis(tested on 4.0.8)
Optional Installs
- diskover-web (diskover's web file manager and analytics app)
- Redis RQ Dashboard (for monitoring redis queue)
- sharesniffer (for scanning your network for file shares and auto-mounting for crawls)
- Kibana (for visualizing Elasticsearch data, tested on Kibana 5.4.2, 5.6.4)
- X-Pack (Kibana plugin for graphs, reports, monitoring and http auth)
- Gource (for Gource visualizations of diskover Elasticsearch data, see videos above)
Download
$ git clone https://github.com/shirosaidev/diskover.git
$ cd diskoverRequirements
You need to have at least Python 2.7. or Python 3.5. and have installed required Python dependencies using
pip.$ pip install -r requirements.txtGetting Started
Copy diskover config
diskover.cfg.sample to diskover.cfg and edit for your environment.Start diskover worker bots (as many as you want, a good number might be cores x 2) with:
$ cd /path/with/diskover
$ python diskover_worker_bot.pyrq info or rq-dashboard to see if they are running. Run diskover-bot-launcher.sh to spawn and kill multiple bots.Start diskover main job dispatcher and file tree crawler with:
$ python /path/to/diskover.py -d /rootpath/you/want/to/crawl -i diskover-indexname -aUser Guide
Read the wiki for more documentation on how to use diskover.