{"id":13626012,"url":"https://github.com/lincolnloop/salmon","last_synced_at":"2025-04-16T11:31:05.408Z","repository":{"id":8205964,"uuid":"9639301","full_name":"lincolnloop/salmon","owner":"lincolnloop","description":"A simple monitoring system.","archived":true,"fork":false,"pushed_at":"2014-04-17T22:11:34.000Z","size":1171,"stargazers_count":470,"open_issues_count":5,"forks_count":54,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-03-18T17:24:50.509Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lincolnloop.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-24T04:19:51.000Z","updated_at":"2025-03-04T11:16:54.000Z","dependencies_parsed_at":"2022-08-06T22:00:41.176Z","dependency_job_id":null,"html_url":"https://github.com/lincolnloop/salmon","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lincolnloop%2Fsalmon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lincolnloop%2Fsalmon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lincolnloop%2Fsalmon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lincolnloop%2Fsalmon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lincolnloop","download_url":"https://codeload.github.com/lincolnloop/salmon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249235039,"owners_count":21235134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T21:02:07.851Z","updated_at":"2025-04-16T11:31:05.009Z","avatar_url":"https://github.com/lincolnloop.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"salmon\n======\n\nThis project is unmaintained\n-----------------------------\n\nMy 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.\n\n....\n\n.. image:: https://secure.travis-ci.org/lincolnloop/salmon.png?branch=master\n   :target: http://travis-ci.org/lincolnloop/salmon\n\n.. image:: https://coveralls.io/repos/lincolnloop/salmon/badge.png?branch=master\n   :target: https://coveralls.io/r/lincolnloop/salmon?branch=master\n\nA simple monitoring system built on top of Django.\n\nThe intent is to serve both as an alerting system like `monit \u003chttp://mmonit.com/monit/\u003e`_  and a monitoring system like `munin \u003chttp://munin-monitoring.org/\u003e`_ (using `Graphite's whisper database \u003chttp://graphite.readthedocs.org/en/latest/whisper.html\u003e`_).\n\nThe original release of Salmon was coupled to `Salt \u003chttp://docs.saltstack.com/\u003e`_ 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.\n\n\n.. image:: http://cl.ly/image/3s340i0W0N06/content.png\n\n.. image:: https://cloudup.com/chXR0xnFtkf+\n\nInstallation\n-------------\n\nTo bootstrap the project::\n\n    virtualenv salmon\n    source salmon/bin/activate\n    pip install salmon\n    salmon init\n    salmon upgrade\n    salmon collectstatic\n\nFire up the web server with::\n\n    salmon start\n\nSending Metrics to Salmon\n-------------------------\n\nMetrics are sent in as JSON over HTTP. The format for a single metric::\n\n    {\n        \"source\": \"test.example.com\",\n        \"name\": \"load\",\n        \"value\": 0.1\n    }\n\nMultiple metrics can be sent as an array::\n\n    [\n        {\"source\": \"test.example.com\", \"name\": \"load\", \"value\": 0.1},\n        {\"source\": \"multi.example.com\", \"name\": \"cpu\", \"value\": 55.5}\n    ]\n\nThe 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::\n\n    curl -i --user \"\u003cAPI_KEY\u003e:\" \\\n         -H \"Content-Type: application/json\" \\\n         -X POST \\\n         -d '{\"source\": \"test.example.com\", \"name\": \"load\", \"value\": 0.1}' \\\n         http://salmon.example.com/api/v1/metric/\n\n\nUsing Salt\n^^^^^^^^^^\n\n1. Setup the `salt-stats \u003chttps://github.com/lincolnloop/salt-stats\u003e`_ states on your master or just grab the `salmon returner \u003chttps://github.com/lincolnloop/salt-stats/blob/master/salt/_returners/salmon_return.py\u003e`_\n2. Add the path to your Salmon install and API key (found in ``~/.salmon/conf.py``) to your Salt Pillar. (`salmon pillar example \u003chttps://github.com/lincolnloop/salt-stats/blob/master/salt/_returners/salmon_return.py#L10-L12\u003e`_)\n3. Add a `schedule` pillar. (`schedule pillar example \u003chttps://gist.github.com/ipmb/8009715\u003e`_)\n4. Run ``salt '*' saltutil.sync_all``\n\n*Note:* To use Salt's ``ps`` module, `psutil \u003chttps://code.google.com/p/psutil/\u003e`_ must be installed on\nthe minions. Ubuntu provides a ``python-psutil`` package or it can be installed via ``pip install psutil``.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flincolnloop%2Fsalmon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flincolnloop%2Fsalmon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flincolnloop%2Fsalmon/lists"}