drewdunne / MicrObserv

An open source real-time & event-driven observability tool for microservices.

MicrObserv

A real-time & event driven observability tool for microservices!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

MicrObserv is here to simplify observability for your microservice architecture by consolidating all logs and tracers into one consolidated database.

(back to top)

Demo

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

Make sure you are running version v18.10.0 of node.

• npm

  npm install npm@latest -g

Installation

1. Install NPM package into each of your microservices for a given application

   npm install

2. Clone the repo

   git clone https://github.com/oslabs-beta/MicrObserv.git

3. Start the application

4. Input application/system name and PostgreSQL database URI and click ADD
5. Click on the newly created System Name to open up the dashboard

(back to top)

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

(back to top)

Roadmap

• Add README
• Add back to top links
• Add GitHub Merges Tracking.
• Add Login & Registration.
• Add Multiple Charts to keep track of different metrics.

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

• Andrew Ngo - @andrew-tien-ngo - [e-mail]

• Chancellor Kupersmith - @chance-kupersmith - [e-mail]

• Otis Jones - @otis-jones - [e-mail]

• Vardan Vanyan - @vardanvanyan - [e-mail]

• Project Link: https://github.com/oslabs-beta/MicrObserv

(back to top)

Acknowledgments

• OSlabs
• Electron Docs
• React Docs
• Webpack Docs
• Tailwindcss Docs
• Daisy UI
• Express Docs
• PostgresSQL

(back to top)