Git Product home page Git Product logo

son-monitor's Introduction

Build Status

Monitoring Framework

5GTango/Sonata monitoring system gathers and analyzes performance information from network service (NS) and Virtual Network Functions (VNF) and provides alarm notifications, based on rule definitions which are defined by the users. The architecture of the system is based on data exporters and a monitoring server. Data exporters send monitoring data from NS and respective VNF to monitoring server which collects, analyses and stores data and generates the appropriate notifications in case of rule violations. In general, monitoring server consists of a RESTful API interface, an alerting mechanism, a timeseries database and a set of convenient notification services, including a pub/sub based message bus, SMS, email, etc.

Installing / Getting started

Each micro service of the framework is executed in its own Docker container. Building steps are defined in a Dockerfile of each service

Build containers

docker build -f pushgatwway/Dockerfile -t registry.sonata-nfv.eu:5000/son-monitor-pushgateway .
docker build -f prometheus/Dockerfile -t registry.sonata-nfv.eu:5000/son-monitor-prometheus .
docker build -f alertmanager/Dockerfile -t registry.sonata-nfv.eu:5000/son-monitor-alertmanager .
docker build -f manager/Dockerfile -t registry.sonata-nfv.eu:5000/son-monitor-manager .
docker build -f snmpmng/Dockerfile -t registry.sonata-nfv.eu:5000/son-monitor-snmpmng .

Installation

docker run -d --name son-monitor-influxdb -p 8086:8086 registry.sonata-nfv.eu:5000/son-monitor-influxdb
docker run -d --name son-monitor-postgres -e POSTGRES_DB=dbname -e POSTGRES_USER=user -e POSTGRES_PASSWORD=pass -p 5433:5432 ntboes/postgres-uuid
docker run -d --name son-monitor-pushgateway -p 9091:9091 registry.sonata-nfv.eu:5000/son-monitor-pushgateway
docker run -d --name son-monitor-alertmanager -p 9093:9093 registry.sonata-nfv.eu:5000/son-monitor-alertmanager
docker run -d --name son-monitor-prometheus -p 9090:9090 -p 9089:9089 -e RABBIT_URL=<son-broker-ip>:5671 --add-host pushgateway:127.0.0.1 --add-host influx:127.0.0.1 registry.sonata-nfv.eu:5000/son-monitor-prometheus
docker run -d --name son-monitor-manager --add-host postgsql:127.0.0.1 --add-host prometheus:127.0.0.1 -p 8000:8000 registry.sonata-nfv.eu:5000/son-monitor-manager
docker run -d --name son-monitor-snmpmng -e POSTGS_PORT=<postgres_port> -e POSTGS_HOST=<postgres_ip> -e DB_USER_NAME=<user_name> -e DB_USER_PASS=<password> -e PROM_SRV=[\"<pushgateway_url>\"]  registry.sonata-nfv.eu:5000/son-monitor-snmpmng

Developing

SONATA's monitoring system is based on following services:

  1. Monitoring manager: is a Django/rest-framework server including a relational database (mysql,postgres ect) that relates each monitoring metric in Prometheus DB (timeseries) with Sonata's monitored entities like NS/VNFs, VMs and VIMs.

  2. Prometheus server: Prometheus is an open-source monitoring and alerting toolkit, which is bundled in a standalone server, independent of any strict requirements, like network storage or dependency on remote services.

  3. Prometheus pushgateway: Despite the fact that the default approach proposed by Prometheus is to retrieve the metrics data by performing http get requests to exporters (containers, vms etc), the utilization of Pushgateway might provide several advantages in Sonata implementation, like no need for exporters to implement a web socket in order to be reached from Prometheus, no need to reconfigure Prometheus each time a VNF is created or changes IP address etc. In that sense, Pushgateway functoinality is supported by the current implementation of Sonata monitoring framework.

  4. SNMP manager: Monitoring framework provides a mechanism (based on SNMP protocol) to collect metrics from VNFs which supports this fuctionality. The needed SNMP information (i.e. port, OIDs, metric names etc.) are defined within the VNF descriptor.

Built With

  • Django
  • django-filter
  • django-rest-multiple-models
  • django-rest-swagger
  • Prometheus.io

Submiting changes

To contribute to the development of the 5GTango/SONATA monitoring framwork you have to fork the repository, commit new code and create pull requests.

Versioning

The most up-to-date version is v5.0.

Tests

Unit tests are automatically executed during the building stage.

Api Reference

Documentation of the RESTful API of Monitoring Manager is provided by a Swagger UI from each instance of the Monitoring Manager and also in 5GTango documentation page.

Licensing

Monitoring framework is published under Apache 2.0 license. Please see the LICENSE file for more details.

Lead Developers

The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.

  • Panos Karkazis (pkarkazis)
  • Panos Trakadas (trakadasp)

Feedback-Chanel

  • You may use the mailing list sonata-dev-list
  • You may use the GitHub issues to report bugs

son-monitor's People

Contributors

pkarkazis avatar trakadasp avatar mbredel avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.