Fogbow metrics for any scraper
Explore the docs »
Open Source

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The telemetry aggregator is intended as a flexible monitoring middleware that offers support for platforms such as Prometheus (for now, the only supported) that can centralize information from Fogbow instances and even federations.

Built With

• Golang
• Mongodb
• Docker tools (swarm and so on)
• Remote deployment provided by Ansible

Getting Started

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

You can simply deploy a stack of the services required to run the Aggregator only by running the deploy script with root privileges.

sh deploy-stack.sh

Remote deployment

1. Clone the repo

git clone https:://github.com/emanueljoivo/aggregator.git  

2. Enter to the ansible folder and fill the fields on the hosts.conf file

cd ansible/ && vim hosts.conf  

3. Once the information in the file is correct, execute the follow command with root privileges

sh install.sh

Usage

The API tends to be REST and has only one endpoint with two methods

POST /metric
GET  /metric/{id}

where {id} is the id of the metric generated when it was generated.

{
   "name":"metric_name",
   "value": 0,
   "timestamp":1568834244853,
   "help":"Some short description about the metric.",
   "metadata":{
      "service": "some_service"
   }   
}

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.

Contact

Emanuel Joívo - @emanueljoivo - emanueljoivo@gmail.com

Project Link: https://github.com/emanueljoivo/aggregator