diff options
| author | Silvio Rhatto <rhatto@riseup.net> | 2017-03-29 18:15:17 -0300 |
|---|---|---|
| committer | Silvio Rhatto <rhatto@riseup.net> | 2017-03-29 18:15:17 -0300 |
| commit | d4d8cb96d14525569db9f62cc641532da849813e (patch) | |
| tree | db4205875eee00cb78bdfd69ad0305722e59b919 /README.rst | |
| parent | 3a133d7bc052c7bc9dfd6f3ee03113758324b3dd (diff) | |
| download | metrics-d4d8cb96d14525569db9f62cc641532da849813e.tar.gz metrics-d4d8cb96d14525569db9f62cc641532da849813e.tar.bz2 | |
Moves docs to markdown
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/README.rst b/README.rst deleted file mode 100644 index 039db10..0000000 --- a/README.rst +++ /dev/null @@ -1,46 +0,0 @@ -metrics: distributed measurement system -======================================= - -Goals ------ - -- essential, simple and reliable. -- minimum maintenance. - -Architecture ------------- - -- probes: run probes that gather data from the current or any remote node. -- analyzers: process collected hosts, triggering events (notifications, graphing, etc). -- syncer: send collected and analyzed data to remote locations. - -Worflow -------- - -- cronjob: synced dispatch. -- command line: asynced dispatch. - -Plugable --------- - -- plugin lookup in shared folders such as `~/.local/share` and `/usr/local/share`. -- analyzer cronjobs detects collected data and dispatch available analyzers. - -Formats -------- - -- outputs: yaml, json or any other format understood by each probe/analyzer pair. -- version field: so analyzers knows by which schema they should process data. - -Filesystem ----------- - -- unique locations per host/probe/analyzer to ease syncing. -- folders: {/etc,/var/lib}/metrics/$HOSTNAME/{probes,analyzers,syncers}/{localhost,$HOST}/$NAME/. -- files: config.yaml (failing back to defaults) and $TIMESTAMP.{json,yaml,rrd,etc}. - -Usage ------ - -:: - metrics <action> <target> |