README
¶
ResourceD Master receives server data from ResourceD agents and serves them as HTTP+JSON.
NOTE: This README provides a quick start guide. For comprehensive documentation, checkout the main website.
Installation for users
-
Install PostgreSQL 9.5.x
-
Create PostgreSQL databases.
# This example shows you how to create databases under resourced user. # Make sure user, password, and pg_hba.conf are configured correctly. sudo su - postgres createuser -P -e resourced createdb --owner=resourced resourced-master createdb --owner=resourced resourced-master-hosts createdb --owner=resourced resourced-master-ts-checks createdb --owner=resourced resourced-master-ts-events createdb --owner=resourced resourced-master-ts-executor-logs createdb --owner=resourced resourced-master-ts-logs createdb --owner=resourced resourced-master-ts-metrics -
Download the tar.gz, unpack it, and run the binary using init/systemd/supervisord. You can follow the examples of init scripts here.
Installation for developers/contributors
See INSTALL.md and BUILD.md
Configuration
ResourceD Master needs to know path to its configuration directory.
You can set it via -c flag or RESOURCED_MASTER_CONFIG_DIR environment variable.
The .tar.gz file provides you with a default config directory. In there, you will see the following files:
-
general.tomlAll default settings are defined ingeneral.toml. -
hosts.tomlAll settings related to storing hosts data. -
metrics.tomlAll settings related to storing metrics data. -
events.tomlAll settings related to storing events data. -
logs.tomlAll settings related to storing logs data. -
checks.tomlAll settings related to storing checks data.
RESTful Endpoints
Every HTTP request requires AccessToken passed as user. Example:
# Notice the double colon at the end of Access Token.
curl -u 0b79bab50daca910b000d4f1a2b675d604257e42: https://localhost:55655/api/hosts
For a comprehensive list of API endpoints, visit: resourced.io/docs
Querying
ResourceD offers SQL-like language to query your data. You can use it to query various data:
-
Hosts: by hostname, by tags, or by JSON path (Docs).
-
Logs: by hostname, by tags, or by full-text search (Docs).
Check out the docs for more info, visit: resourced.io/docs.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package application allows the creation of Application struct.
|
Package application allows the creation of Application struct. |
|
Package config provides data structures for Application configurations.
|
Package config provides data structures for Application configurations. |
|
Package handlers provides HTTP request handlers for the Application.
|
Package handlers provides HTTP request handlers for the Application. |
|
Package libhttp provides http related library functions.
|
Package libhttp provides http related library functions. |
|
Package libslice provides slice related library functions.
|
Package libslice provides slice related library functions. |
|
Package libsmtp provides SMTP related library functions.
|
Package libsmtp provides SMTP 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 libunix provides UNIX related library functions.
|
Package libunix provides UNIX related library functions. |
|
Package mailer provides simple abstraction around sending email.
|
Package mailer provides simple abstraction around sending email. |
|
Package middlewares provides common middleware handlers.
|
Package middlewares provides common middleware handlers. |
|
models
|
|
|
cassandra
Package dal is the Data Access Layer between the Application and PostgreSQL database.
|
Package dal is the Data Access Layer between the Application and PostgreSQL database. |
|
cassandra/querybuilder
Package querybuilder parses ResourceD query and turn it into Cassandra + Lucene query.
|
Package querybuilder parses ResourceD query and turn it into Cassandra + Lucene query. |
|
pg
Package dal is the Data Access Layer between the Application and PostgreSQL database.
|
Package dal is the Data Access Layer between the Application and PostgreSQL database. |
|
pg/querybuilder
Package querybuilder parses ResourceD query and turn it into PostgreSQL query.
|
Package querybuilder parses ResourceD query and turn it into PostgreSQL query. |