341f58f1af0bd5db6327f5dd01c2dc8d5df05fa8
1 SysDB Release Notes
2 =====================
4 The release notes contain noteworthy changes in each System DataBase (SysDB)
5 release, with a summary of the most important changes at the top. A complete
6 and very detailed list of changes can be obtained from the Git logs for each
7 release.
9 About SysDB:
10 ~~~~~~~~~~~~
11 “System DataBase” (SysDB) is a multi-backend system management and inventory
12 collection service. It may be used to (continuously) collect information
13 about your systems from various backends (inventory services, monitoring
14 services, etc.) and provides a unique interface to access the information
15 independent of the active backends.
17 <https://github.com/tokkee/sysdb>
19 Version 0.1.0, Release Date: tbd
20 --------------------------------
22 This is the initial release of SysDB. It provides the following core
23 features:
25 * sysdb: A terminal-based, interactive client program. Supports
26 line-editing and history based on libreadline or libedit and uses an
27 asynchronous, event-driven architecture to handle user input and server
28 replies simultaneously.
29 * sysdbd: The database backend service configurable through a configuration
30 file. The daemon supports online reconfiguration.
31 * core: Flexible, multi-threaded core architecture providing a configurable
32 plugin infrastructure for querying external data-sources and extending
33 core functionality. The following plugin types are supported:
34 - data collection
35 - hostname canonicalization
36 - logging
37 * store: Central, in-memory object store managing host and service objects
38 and their attributes. Host names may be canonicalized through respective
39 plugins. Each object is automatically attributed with last update and
40 interval information using nano-seconds resolution. Attributes may have
41 various types (integer, decimal, string, date-time, binary).
42 * frontend: The frontend handling client connections uses a multi-threaded,
43 asynchronous, event-driven architecture capable of handling multiple
44 listen addresses.
45 * query language: The store may be queried using the ‘LIST’, ‘LOOKUP’, and
46 ‘FETCH’ commands returning JSON formatted objects.
47 * documentation: Full documentation for the tools, all plugins, and the
48 query language provided as manpages and HTML pages.
49 * testing: Unit and integration tests exist for most parts except plugins
50 covering 77% of all functions. Valgrind and Clang's address sanitzer are
51 used to detect memory leaks and programming errors.
53 The following plugins are shipped with this version of SysDB:
55 Backends:
56 * collectd::unixsock: Query collectd through its ‘unixsock’ interface
57 * mk-livestatus: Query arbitrary (monitoring) systems using the Check_MK
58 Livestatus interface.
59 * puppet::store-configs: Query Puppet through its “stored configuration”
60 database.
62 Plugins:
63 * cname::dns: Canonicalize hostnames by querying DNS information.
64 * syslog: Send log messages to the system log service.