Vhoops

Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Configure
   • Run
3. Usage
4. Roadmap
5. Contributing
6. License
7. Screenshots

About The Project

The Vhoops is a tool for using consolidate alerts that comes from different sources. It collects, de-duplicates, and consolidates the alerts. Also, you could define routing definitions for these alerts and get some action when alerts come from sources that match the defined patterns.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

1. Install following software components
   • RabbitMQ
   • Couchbase
   • MongoDB
   • MySQL
   • Redis
2. Clone the repo

   git clone https://github.com/yigitbasalma/vhoops.git

3. Go to static directory

   cd /path/to/vhoops/vhoops/static

4. Install necessaries npm packages and build css and js

   npm install && \
   gulp dist

5. Install python libraries. (you should run as root or pass the --user flag)

   pip install -r requirements.txt

Configure

1. Move config.example.py to config.py

   mv /path/to/vhoops/vhoops/config/config.example.py /path/to/vhoops/vhoops/config/config.py

2. Create MySQL database.

   create database vhoops character set utf8 collate utf8_bin;

3. Configure the sqlalchemy connection string.

   SQLALCHEMY_DATABASE_URI = "mysql+pymysql://username:[email protected]:3306/vhoops"

4. Configure the mail.

   MAIL_USERNAME = "[email protected]"
   MAIL_PASSWORD = "123456"
   MAIL_SERVER = "smtp.mail.com"

5. Configure the couchbase. (You need to create buckets manually for now)

   CACHE_CONN_STRING = "couchbase://192.168.56.2"
   CACHE_USERNAME = "Administrator"
   CACHE_PASSWORD = "123456*"
   CACHE_BUCKETS = [
       "app_cache"
   ]

6. Configure redis for page cache.

   CACHE_TYPE = "redis"
   CACHE_REDIS_HOST = "192.168.56.2"

7. Configure celery.

   CELERY_BROKER_URL = "redis://192.168.56.2:6379/1"

8. Configure AMQP for alert queue (in the celery_config.py)

   amqp_config = dict(
       host="192.168.56.3:5672",
       userid="admin",
       password="admin",
       hearbeat=30
   )

Run

1. Start run.py command. (you should run as root or manually create /var/log/vhoops directory)

   python /path/to/vhoops/run.py

2. Start celery

   cd /path/to/vhoops && \
   celery -A vhoops.celery worker --loglevel=info && \
   celery beat -l info -A vhoops.celery

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.