salmon 0.2.0

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 "<API_KEY>:" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"source": "test.example.com", "name": "load", "value": 0.1}' \
     http://salmon.example.com/api/v1/metric/