-
Notifications
You must be signed in to change notification settings - Fork 25
Documentation
Welcome to Edda! We're glad you made it here. Here's what you need to do to get Edda up and running:
-
Install pip
Pip is a tool for installing Python packages. If you don't already have pip, you can install it here:
http://www.pip-installer.org/en/latest/installing.html# -
Install MongoDB (which you should all do anyway because it is awesome)
Help all of us at 10gen out by downloading the first release candidate for MongoDB 2.2.0, and helping us test for 2.2!
http://www.mongodb.org/downloads -
Install a non-text-based browser
We recommend Google Chrome or Firefox. -
Install Edda
$ pip install edda
In order to run Edda, you must also have a mongod running in the background:
$ ./mongod
Edda is runnable from the command line. Once you have a mongod running, navigate to the top-level Edda directory and run the following:
FROM GITHUB:
$ PYTHONPATH=. python edda/run_edda.py logfile1 logfile2...
FROM PIP INSTALL:
$ edda logfile1 logfile2...
Feed Edda your log files, raw, ".gz"compressed, or an edda processed ".json" file, as command line arguments. If you don't have any log files to try with Edda, we've provided some samples so you don't have to miss out on the fun:
$ python edda/edda.py test/sample_logs/hp/* or
$ python edda/edda.py test/sample_logs/pr/*
After each run, a new file is created with the past run's configuration. It will be created at the location that you run it on the command line and will be called "[collection_name].json", in the event you didn't provide a custom collection name, a random one will be provided for you. This file can be used for quicker repeated visualizing and sharing.
Once Logl has launched a web page, it will spawn a python server that will run until you shut it down with Ctrl+C. Be sure to kill this server once you are finished with the visualizer. Happy viewing!
We'd love to hear your input! If you'd like to report a bug or request a new feature for the next version of Edda, please use github's issue tracker to file a new issue on this repository.