From d4d8cb96d14525569db9f62cc641532da849813e Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Wed, 29 Mar 2017 18:15:17 -0300 Subject: Moves docs to markdown --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.rst | 46 ---------------------------------------------- TODO.md | 25 +++++++++++++++++++++++++ TODO.rst | 25 ------------------------- 4 files changed, 70 insertions(+), 71 deletions(-) create mode 100644 README.md delete mode 100644 README.rst create mode 100644 TODO.md delete mode 100644 TODO.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..77a47db --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +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 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 diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..20e1b61 --- /dev/null +++ b/TODO.md @@ -0,0 +1,25 @@ +TODO +==== + +- website and repository. +- search for similar software +- initial plugins: + - hddtemp + - lshw -json + - facter + - sensors + - raid + - smartmontools + - load + - memory + - cpu + - disk + - smtp + - imap + - http/https + - website + - ping + - ssh +- other plugins: + - collectd + - munin-plugins diff --git a/TODO.rst b/TODO.rst deleted file mode 100644 index 20e1b61..0000000 --- a/TODO.rst +++ /dev/null @@ -1,25 +0,0 @@ -TODO -==== - -- website and repository. -- search for similar software -- initial plugins: - - hddtemp - - lshw -json - - facter - - sensors - - raid - - smartmontools - - load - - memory - - cpu - - disk - - smtp - - imap - - http/https - - website - - ping - - ssh -- other plugins: - - collectd - - munin-plugins -- cgit v1.2.3