https://github.com/lincolnloop/salmon

A simple monitoring system.
https://github.com/lincolnloop/salmon

Last synced: 2 days ago
JSON representation

A simple monitoring system.

• Host: GitHub
• URL: https://github.com/lincolnloop/salmon
• Owner: lincolnloop
• License: bsd-3-clause
• Archived: true
• Created: 2013-04-24T04:19:51.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-04-17T22:11:34.000Z (over 10 years ago)
• Last Synced: 2024-09-30T17:12:25.022Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 1.12 MB
• Stars: 473
• Watchers: 34
• Forks: 55
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - lincolnloop/salmon - A simple monitoring system. (Python)

README

        
salmon

======

This project is unmaintained

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

My need for simple monitoring quickly became a need for more complex monitoring. I'm no longer using Salmon, as such, I'm no longer maintaining it. If you would like to continue developing Salmon, feel free to fork the repo and we can point this to your fork.

....

.. image:: https://secure.travis-ci.org/lincolnloop/salmon.png?branch=master

   :target: http://travis-ci.org/lincolnloop/salmon

.. image:: https://coveralls.io/repos/lincolnloop/salmon/badge.png?branch=master

   :target: https://coveralls.io/r/lincolnloop/salmon?branch=master

A simple monitoring system built on top of Django.

The intent is to serve both as an alerting system like `monit `_  and a monitoring system like `munin `_ (using `Graphite's whisper database `_).

The original release of Salmon was coupled to `Salt `_ and designed to monitor servers (**Sal** t **Mon** itor). As of v0.2.0, the system has been decoupled from Salt and ingests data via a simple HTTP interface.

.. image:: http://cl.ly/image/3s340i0W0N06/content.png

.. image:: https://cloudup.com/chXR0xnFtkf+

Installation

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

To bootstrap the project::

    virtualenv salmon

    source salmon/bin/activate

    pip install salmon

    salmon init

    salmon upgrade

    salmon collectstatic

Fire up the web server with::

    salmon start

Sending Metrics to Salmon

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

Metrics are sent in as JSON over HTTP. The format for a single metric::

    {

        "source": "test.example.com",

        "name": "load",

        "value": 0.1

    }

Multiple metrics can be sent as an array::

    [

        {"source": "test.example.com", "name": "load", "value": 0.1},

        {"source": "multi.example.com", "name": "cpu", "value": 55.5}

    ]

The API endpoint is ``/api/v1/metric/``. If your Salmon server lives at http://salmon.example.com, you can ``POST`` to ``http://salmon.example.com/api/v1/metric/``. Pass in your API key as found in ``~/.salmon/conf.py`` for authentication. Using Curl, it would look something like this::

    curl -i --user ":" \

         -H "Content-Type: application/json" \

         -X POST \

         -d '{"source": "test.example.com", "name": "load", "value": 0.1}' \

         http://salmon.example.com/api/v1/metric/

Using Salt

^^^^^^^^^^

1. Setup the `salt-stats `_ states on your master or just grab the `salmon returner `_

2. Add the path to your Salmon install and API key (found in ``~/.salmon/conf.py``) to your Salt Pillar. (`salmon pillar example `_)

3. Add a `schedule` pillar. (`schedule pillar example `_)

4. Run ``salt '*' saltutil.sync_all``

*Note:* To use Salt's ``ps`` module, `psutil `_ must be installed on

the minions. Ubuntu provides a ``python-psutil`` package or it can be installed via ``pip install psutil``.