https://github.com/alignak-monitoring-contrib/alignak-backend

Backend for alignak (REST API for configuration, retention, livestate, logs) based on Python Eve
https://github.com/alignak-monitoring-contrib/alignak-backend

alignak backend eve monitoring monitoring-server python rest

Last synced: 5 months ago
JSON representation

Backend for alignak (REST API for configuration, retention, livestate, logs) based on Python Eve

• Host: GitHub
• URL: https://github.com/alignak-monitoring-contrib/alignak-backend
• Owner: Alignak-monitoring-contrib
• License: agpl-3.0
• Created: 2015-08-23T21:32:21.000Z (about 10 years ago)
• Default Branch: develop
• Last Pushed: 2018-09-03T05:08:37.000Z (about 7 years ago)
• Last Synced: 2025-04-15T21:48:48.825Z (6 months ago)
• Topics: alignak, backend, eve, monitoring, monitoring-server, python, rest
• Language: JavaScript
• Homepage:
• Size: 6 MB
• Stars: 11
• Watchers: 5
• Forks: 4
• Open Issues: 47
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
Alignak Backend

===============

*Python Eve REST Backend for Alignak monitoring framework*

.. image:: https://travis-ci.org/Alignak-monitoring-contrib/alignak-backend.svg?branch=develop

    :target: https://travis-ci.org/Alignak-monitoring-contrib/alignak-backend

    :alt: Develop branch build status

.. image:: https://landscape.io/github/Alignak-monitoring-contrib/alignak-backend/develop/landscape.svg?style=flat

    :target: https://landscape.io/github/Alignak-monitoring-contrib/alignak-backend/develop

    :alt: Development code static analysis

.. image:: https://codecov.io/gh/Alignak-monitoring-contrib/alignak-backend/branch/develop/graph/badge.svg

    :target: https://codecov.io/gh/Alignak-monitoring-contrib/alignak-backend

    :alt: Development code coverage

.. image:: http://readthedocs.org/projects/alignak-backend/badge/?version=develop

    :target: http://alignak-backend.readthedocs.io/en/latest/?badge=develop

    :alt: Development documentation Status

.. image:: https://badge.fury.io/py/alignak_backend.svg

    :target: https://badge.fury.io/py/alignak_backend

    :alt: Most recent PyPi version

.. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat

    :target: http://webchat.freenode.net/?channels=%23alignak

    :alt: Join the chat #alignak on freenode.net

.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg

    :target: http://www.gnu.org/licenses/agpl-3.0

    :alt: License AGPL v3

Short description

-----------------

This package is an Alignak Backend.

It is used to:

* manage monitoring configuration (hosts, services, contacts, timeperiods...)

    end user (WebUI, alignak-backend-cli, python/php client, curl command line,...) can get, add, edit monitoring configurations elements

    inner templating system to easily create new hosts, services, users, ...

    Alignak gets this configuration when its arbiter module starts

* manage retention

    Alignak saves and loads retention information for checks/hosts/services from the backend

* manage the monitoring live state

    Alignak add/update states for hosts and services

    end user (webui, command line...) can get these information

* manage the metrics from the checks performance data

    Alignak backend automatically send metrics to Graphite / InfluxDB timeseries databases

    Alignak backend automatically creates Grafana panels for hosts / services metrics

Installation

------------

From Alignak packages repositories

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

More information in the online Alignak backend documentation. Here is only an abstract...

Debian::

    # Alignak DEB stable packages

    sudo echo deb https://dl.bintray.com/alignak/alignak-deb-stable xenial main | sudo tee -a /etc/apt/sources.list.d/alignak.list

    sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv D401AB61

    sudo apt-get update

    sudo apt install alignak-backend

CentOS::

    sudo vi /etc/yum.repos.d/alignak-stable.repo:

       [Alignak-rpm-stable]

       name=Alignak RPM stable packages

       baseurl=https://dl.bintray.com/alignak/alignak-rpm-stable

       gpgcheck=0

       repo_gpgcheck=0

       enabled=1

    sudo yum repolist

    sudo yum install python-alignak-backend

From PyPI

~~~~~~~~~

To install the package from PyPI::

   sudo pip install alignak-backend

From source files

~~~~~~~~~~~~~~~~~

To install the package from the source files::

   git clone https://github.com/Alignak-monitoring-contrib/alignak-backend

   cd alignak-backend

   sudo pip install .

Documentation

-------------

The Alignak backend documentation is available on `Read the docs `_ or in the */docs* folder of this repository.

To build the doc::

    cd docs

    python models_to_rst.py

    make clear

    make html

Release strategy

----------------

Alignak backend and its *satellites* (backend client, and backend import tools) must all have the

same features level. As of it, take care to install the same minor version on your system to

ensure compatibility between all the packages. Use 0.4.x version of Backend import and Backend

client with a 0.4.x version of the Backend.

Bugs, issues and contributing

-----------------------------

Please report any issue using the project `issues page `_.