README
¶
ResourceD: A single binary daemon that collects and report your server data with ease.
NOTE: This documentation refers to master branch. For stable release, checkout the main website.
Installation
-
Download the binary release here.
-
Use supervisor/upstart/systemd to daemonize. Click here for examples.
Running the Server
RESOURCED_CONFIG_DIR=$GOPATH/src/github.com/resourced/resourced/tests/resourced-configs \
$GOPATH/bin/resourced
Once you executed the command above, open this URL: http://localhost:55555/paths.
curl -X GET -H "Content-type: application/json" http://localhost:55555/r/load-avg
Configuration
ResourceD requires only 1 environment variable to run.
RESOURCED_CONFIG_DIR: Path to root config directory. If directory does not exist, it will be created.
In there, you will see the following subdirectories or files:
-
readers/Put all the TOML configurations for readers here (Example). -
writers/Put all the TOML configurations for writers here (Example). -
executors/Put all the TOML configurations for executors here (Example). -
tags/Each line in each file will be parsed as key=value tag (Example). -
general.tomlAll default settings are defined ingeneral.toml.
Data Gathering
ResourceD readers gather data on your server. The easiest way to create a reader is to use a scripting language.
-
Write the script following this one requirement: Output the JSON data through STDOUT
-
Write config file. Click here for examples.
For more info, follow this link.
RESTful Endpoints
-
GET
/Displays full JSON data of all readers and writers. -
GET
/pathsDisplays paths to all readers and writers data. -
GET
/rDisplays full JSON data of all readers. -
GET
/r/pathsDisplays paths to all readers data. -
GET
/wDisplays full JSON data of all writers. -
GET
/w/pathsDisplays paths to all writers data.
Third Party Data Source
Here are list of 3rd party data source that ResourceD use. Big thanks to these authors, without whom this project would not be possible.
Contributors
Are you a contributor, or looking to be one? Go here!
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent runs readers, writers, and HTTP server.
|
Package agent runs readers, writers, and HTTP server. |
|
Package config provides data structure for storing resourced reader/writer configurations.
|
Package config provides data structure for storing resourced reader/writer configurations. |
|
Package executors provides objects that gathers resource data from a host.
|
Package executors provides objects that gathers resource data from a host. |
|
Package host provides data structure for storing resourced host information.
|
Package host provides data structure for storing resourced host information. |
|
Package libdocker provides docker related library functions.
|
Package libdocker provides docker related library functions. |
|
Package libhttp provides http related library functions.
|
Package libhttp provides http related library functions. |
|
Package libprocess provides process related library functions.
|
Package libprocess provides process related library functions. |
|
Package libstring provides string related library functions.
|
Package libstring provides string related library functions. |
|
Package libtime provides time related library functions.
|
Package libtime provides time related library functions. |
|
Package loggers provides objects that gathers resource data from a host.
|
Package loggers provides objects that gathers resource data from a host. |
|
Package readers provides objects that gathers resource data from a host.
|
Package readers provides objects that gathers resource data from a host. |
|
docker
Package docker gathers Docker related data from a host.
|
Package docker gathers Docker related data from a host. |
|
haproxy
Package haproxy gathers haproxy related data from a host.
|
Package haproxy gathers haproxy related data from a host. |
|
mcrouter
Package mcrouter gathers mcrouter related data from a host.
|
Package mcrouter gathers mcrouter related data from a host. |
|
memcache
Package memcache gathers memcache related data from a host.
|
Package memcache gathers memcache related data from a host. |
|
mysql
Package mysql gathers MySQL related data from a host.
|
Package mysql gathers MySQL related data from a host. |
|
redis
Package redis gathers Redis related data from a host.
|
Package redis gathers Redis related data from a host. |
|
Package writers provides objects that can send colected resource data to external place.
|
Package writers provides objects that can send colected resource data to external place. |