store_json: Base the memstore emitter on the store-writer API.
[sysdb.git] / ReleaseNotes
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  Compatibility Note:
10  ~~~~~~~~~~~~~~~~~~~
12   All pre 1.0 development snapshots are not considered stable yet. That is,
13   all interfaces, including the plugin API, the network protocol, or the query
14   language, may change in an incompatible way at any time. All changes are
15   documented here.
17  About SysDB:
18  ~~~~~~~~~~~~
19   “System DataBase” (SysDB) is a multi-backend system management and inventory
20   collection service. It stores system and inventory information about
21   hardware and software systems. This information is (continuously) collected
22   from various configurable backends (inventory services, monitoring services,
23   etc.) and stored in a graph-like hierarchy of generic objects. The store may
24   be queried through a generic interface independent of the active backends.
25   Object names are canonicalized before they are added to the store to ensure
26   a consistent view of your infrastructure.
28   <>
30 Version 0.7.0, Release Date: 2015-02-21
31 ---------------------------------------
33   This release introduces various features related to running SysDB as an
34   agent. Objects may now also be submitted by arbitrary applications using the
35   network protocol. Two new plugins are available to collect local facter fact
36   values and to mirror all store operations to another instance. Various fixes
37   and improvements have been applied to the client program (sysdb).
39    * build system:
40      - Added support for C++.
41    * sysdb:
42      - Fixed terminal resets on exit.
43      - Don't exit if the server closed the connection; instead reconnect
44        automatically on the next user input.
45      - Fixed string parsing: previously, quoted strings were not handled at
46        all and might have been terminated by an embedded semicolon.
47      - Also store failed commands in the history to enable history editing in
48        such cases.
49      - Improved program output: don't mix log messages with prompts after
50        sending a command; print log messages to the standard error channel.
51      - Fixed lookup of the .sysdb_history file for cases where the SysDB user
52        does not match the current operating system user.
53    * sysdbd:
54      - SSL options can be specified inside a <Listen> block.
55      - Unload all plugins on exit to ensure a clean shutdown.
56    * client:
57      - Simplified RPC handling by providing a helper function.
58      - Added support for TCP connections using SSL/TLS and supporting, both,
59        IPv4 and IPv6. Remote peer verification is required for any such
60        connection.
61      - New command line flags -K, -C, and -A to specify the SSL private key,
62        client certificate, and CA certificates file names.
63    * core:
64      - Fully support arrays of all types.
65      - Fixed (implemented) reloading of time-series fetcher plugins.
66      - Added new callback type for "store-writers", making that part of the
67        store pluggable (queries are not supported).
68    * store:
69      - Added support for querying an object's siblings.
70      - Send all stored objects to store-writer plugins in addition to storing
71        them in the in-memory store.
72    * frontend:
73      - Fixed parsing of time values.
74      - Add support for storing hosts, services, metrics, and attributes using
75        the new 'STORE' command.
76      - Fixed handling of subsequent requests on the same connection by
77        avoiding unnecessary pauses of up to one second, thus, greatly speeding
78        up request handling.
79      - Added support for TCP connections supporting, both, IPv4 and IPv6.
80        SSL/TLS is enforced for any such connection.
81      - Added support for and require actual client authentication:
82        UNIX socket connections require peer authentication.
83        TCP connections require client SSL certificate authentication.
84    * query language:
85      - Added support for expressions accessing an object's siblings by using
86        the '<object_type>.<sibling_type>' syntax.
87    * JSON format:
88      - Fixed handling of special characters which are now being escaped.
89      - Include a flag indicating whether time-series data are available for a
90        metric.
91    * utils:
92      - os: This utility module provides some Operating System related helper
93        functions: access user information (current user, homedir), manage
94        directories (create, delete, resolve), I/O helpers (select, read,
95        write), networking helpers (DNS resolution).
96      - proto: Added support for marshaling and unmarshaling messages encoding
97        a datum of any type, hosts, services, metrics, and attributes.
98      - ssl: This new module provides convenience functions for SSL/TLS
99        servers, clients, and sessions using OpenSSL.
101   Backends:
102    * facter: Added a plugin collecting local facter fact values using
103      libcfacter (C++).
104    * store::network: Added a store-writer plugin sending all data to another
105      SysDB instance using the client library and low-level STORE commands.
107   Plugins:
108    * syslog: The log-level is now configurable using the "LogLevel" option.
110 Version 0.6.0, Release Date: 2014-11-17
111 ---------------------------------------
113   This release focuses on a clearer query language. The underlying
114   architecture has been refactored to allow for more powerful and generic
115   expressions.
117    * core:
118      - Added support for arrays. Elements may be of any other supported
119        data-type but only integers, decimals, and strings are fully supported.
120    * store:
121      - Refactored matchers: all matchers now operate on one or two expressions
122        or other matchers, replacing the old and less flexible conditional
123        matchers.
124      - Attribute values may now be used anywhere in an expression.
125      - On data-type mismatch when comparing attribute values, the values will
126        be cast to string (previously only done for regex matches).
127      - Added support for querying an object's backends (array of strings).
128      - Added support for iterating child objects and array values.
129      - All matchers now return false if any operand is NULL (except for IS
130        NULL).
131      - All operations now return NULL if any operand is NULL.
132      - Fixed behavior of not-operators (!=, !~) and let them not match if any
133        of the operands is NULL.
134      - Add support for looking up all object types (hosts, services, metrics).
135      - Refactored the JSON formatter to be more flexible and powerful.
136      - Record parent objects for each stored object.
137    * frontend:
138      - Added a separate parser mode for expressions.
139      - Added a new queryable field 'name' to be used in place of the rather
140        magical keyword 'host' when looking up hosts.
141      - Improved error reporting in the parser and the (newly introduced)
142        analyzer.
143      - Apply filters to hosts in the FETCH command.
144    * query language:
145      - All operators may now be used in all places if the involved data-types
146        support the respective operation. For example, regular expressions may
147        be used to match any value. Non-string values are cast to strings for
148        that purpose. IS NULL / IS NOT NULL may be applied to arbitrary
149        expressions.
150      - Introduced the 'IN' operator to check if a value or an array of values
151        is included in an array.
152      - Added support for arrays: [<elem1>,<elem2>,...]
153      - Added support for string and array concatenation using the '||'
154        operator.
155      - Attribute names have to be strings instead of identifiers now.
156      - Access object fields using '<field>' rather than '.<field>'.
157      - Let the LOOKUP and FETCH commands support services and metrics.
158      - Introduced 'FETCH service|metric <host>.<name' for fetching services
159        and metrics.
160      - Added support for 'ANY' and 'ALL' operators which apply a matcher to
161        each value emitted by an iterator (a host's services and metrics or
162        arrays). 'MATCHING ANY service|metric|attribute <cmp> <expr>' replaces
163        'MATCHING service|metric|attribute <cmp> <value>' expressions.
165 Version 0.5.0, Release Date: 2014-10-06
166 ---------------------------------------
168   This release focuses on simplifications and more flexibility in the frontend
169   and the query language. Most of those changes are not backward-compatible
170   but easy client implementations.
172    * sysdb:
173      - Include priority when printing log messages.
174      - Fixed handling of empty queries.
175    * store:
176      - When serializing the entire store (LIST command), return an array of
177        host objects (rather than wrapping it into another object).
178      - Fixed JSON format of time-series data.
179      - Fixed error checks of invalid compare expressions and reject them.
180      - Fixed lookups by back-end name.
181      - Added support for comparing attributes with different types by
182        comparing their string values.
183    * frontend:
184      - Clarified details about asynchronous messages and authentication
185        options and made client implementation more robust.
186      - Introduced a new message type encoding the JSON serialized response of
187        a query and its data type.
188      - Include the priority in log messages.
189      - Include object types in FETCH, LIST, and LOOKUP messages.
190      - Added support for including services and metrics in LIST responses and
191        skip hosts without the respective children.
192    * query language:
193      - Added support for services and metrics to LIST command.
194      - Changed syntax for attribute lookup to 'attributes[<name>]'.
195      - Changed syntax for accessing queryable fields to '.<field>'.
196    * utils:
197      - strbuf: Improved memory management.
199 Version 0.4.0, Release Date: 2014-09-01
200 ---------------------------------------
202   This release features support for metrics and transparent access to a
203   backend's time-series data. Some backward-incompatible changes were applied
204   to some query commands for more consistency.
206    * build system:
207      - Added checks for format strings and arguments.
208      - Changed configure option for collectd::unixsock to
209        --enable-collectd-unixsock.
210    * core:
211      - Added support for “metric” objects which may be assigned to a host.
212      - Introduced support for handling time-series data: added new data
213        structures describing time-series data and a new type of plugins called
214        “time-series fetchers” which are used to access time-series
215        information.
216    * store:
217      - Fixed a memory leak.
218      - Apply (very) simple optimizations to lookup expressions.
219      - Added support for metrics and their “data-stores” (describing how to
220        access the actual data referenced by a metric).
221      - Added support for querying time-series data through the newly
222        introduced “time-series fetcher” plugins.
223    * frontend:
224      - Fixed a bug that might have caused reading too much data from the
225        connection buffer in certain situations.
226    * query language:
227      - The ‘MATCHING’ clause is now optional in ‘LOOKUP’ queries.
228      - The ‘LIST’ and ‘FETCH’ commands support ‘FILTER’ clauses as well.
229      - ‘LIST’ / ‘FETCH’ were changed to ‘LIST hosts’ / ‘FETCH host’.
230      - Added the ‘TIMESERIES’ command to query arbitrary time-series which
231        fetches time-series data from a backend's data-store for a given period
232        of time.
233      - Added support for date/time values.
234      - Added support for single quotes in string values: two adjacent single
235        quotes may be used to specify a single quote.
236    * documentation:
237      - Documented the frontend protocol in frontend/proto.h.
238      - Documented changes to the query language and new / updated plugins.
239      - Documented all supported data types.
241   Backends:
242    * collectd::unixsock:
243      - The plugin now uses metrics in place of services.
244      - New config options ‘TimeseriesBackend’ and ‘TimeseriesBaseURL’ to
245        specify access to time-series, currently limited to ‘rrdtool’ and
246        ‘rrdcached’ access.
248   Plugins:
249    * timeseries::rrdtool:
250      - New plugin adding support to fetch time-series from local RRD files.
251      - Supports flushing of values in RRDCacheD.
253 Version 0.3.0, Release Date: 2014-08-01
254 ---------------------------------------
256   This release includes major enhancements and new features in the SysDB store
257   which is the core of the database. Most notably, complex expressions are now
258   supported when looking up information and filters may be used to preselect
259   the information to be returned. Some backward-incompatible changes were
260   introduced in the query language to avoid potentially confusing semantics.
262    * sysdb: Fixed non-interactive mode when using libedit.
263    * core:
264      - Fixed weird behavior when collector callbacks were registered without
265        any plugin context information (as it would, e.g., happen when using
266        LoadPlugin instead of LoadBackend in sysdbd).
267    * store:
268      - Introduced service attributes -- similar to host attributes but
269        assigned to a service object.
270      - Don't log “value too old” messages if an updated object uses the same
271        timestamp as the old object.
272      - Switched from linked-lists to AVL trees for storing all object types to
273        reduce lookup times from O(n) to O(log n).
274      - Added infrastructure for handling and evaluating arithmetic
275        expressions and filters (see also the changes to the query language
276        below).
277      - Export various fields describing base attributes of all stored object
278        types: last_update, age, interval, and backend. These fields may be
279        used when querying the store.
280    * frontend: Include new service attributes in JSON output.
281    * query language:
282      - Added support for ‘IS NULL’ attribute checks matching on non-existent
283        attributes.
284      - Changed ‘LOOKUP ... WHERE’ queries to ‘LOOKUP ... MATCHING’ to avoid
285        confusion with SQL semantics.
286      - Switched from ‘<obj>.name’ to ‘<obj>’ in MATCHING clauses, thus, no
287        longer shadowing attributes called “name”.
288      - Added support for arithmetic expressions in places that used simple
289        data values before. Arithmetic expressions support addition,
290        subtraction, multiplication, division, modulo, and concatenation
291        operations. The expressions may be based on constant values or
292        queryable fields of the stored objects (specified as ‘:last_update’,
293        ‘:age’, ‘:interval’, and ‘:backend’).
294      - Added ‘FILTER’ support to ‘LOOKUP’ queries. Filters are conditional
295        expressions which may optionally be used to limit the query and the
296        result to object (of any type) matching the filter condition.
297      - Added support to specify date and time values.
298    * utils:
299      - avltree: Added an AVL tree (self-balancing binary tree) implementation.
300    * documentation: Added documentation for the new query language features.
301    * testing: Run all unit tests through valgrind by default (if available).
303   Backends:
304    * collectd::unixsock:
305      - Added support for spaces in identifiers.
306      - Store plugin identifier (host, plugin, plugin_instance, type,
307        type_instance) as service attributes.
309 Version 0.2.0, Release Date: 2014-07-02
310 ---------------------------------------
312   This is another development snapshot of SysDB. The main focus of this
313   release is on stabilizing existing features and extending the query
314   infrastructure to support all attribute types and further operators.
316    * build system: Fixed linking of sysdbd to include *all* necessary object
317      files. This bug caused some plugins to be un-loadable.
318    * sysdbd: Fixed shutdown process in case of errors.
319    * sysdb: Fixed a bug causing some server replies to be ignored when exiting
320      from the client.
321    * core:
322      - Always log to the standard output stream if no user-provided logging
323        callbacks had been specified. Previously this was disabled after
324        enabling logging to clients in the frontend.
325      - Simplified plugin naming information and determine configuration
326        callback names automatically to ensure better consistency.
327    * store:
328      - Simplified internal data management.
329      - Store the list of backends along with each stored object which provide
330        the respective object.
331    * frontend:
332      - Simplified and improved the internal architecture matching / looking up
333        objects.
334      - Fixed parser to correctly reject invalid object types.
335      - Automatically create the base directory of a listening UNIX socket.
336    * query language: Added support for numeric constants and added operators
337      for less and greater than or equal attribute comparison.
338    * documentation: Added missing files to the distribution tarball.
340   Plugins:
341    * syslog: Don't log debug messages to syslog.
343 Version 0.1.0, Release Date: 2014-06-01
344 ---------------------------------------
346   This is the initial release of SysDB. It provides the following core
347   features:
349    * sysdb: A terminal-based, interactive client program. Supports
350      line-editing and history based on libreadline or libedit and uses an
351      asynchronous, event-driven architecture to handle user input and server
352      replies simultaneously.
353    * sysdbd: The database backend service configurable through a configuration
354      file. The daemon supports online reconfiguration.
355    * core: Flexible, multi-threaded core architecture providing a configurable
356      plugin infrastructure for querying external data-sources and extending
357      core functionality. The following plugin types are supported:
358      - data collection
359      - hostname canonicalization
360      - logging
361    * store: Central, in-memory object store managing host and service objects
362      and their attributes. Host names may be canonicalized through respective
363      plugins. Each object is automatically attributed with last update and
364      interval information using nano-seconds resolution. Attributes may have
365      various types (integer, decimal, string, date-time, binary).
366    * frontend: The frontend handling client connections uses a multi-threaded,
367      asynchronous, event-driven architecture capable of handling multiple
368      listen addresses.
369    * query language: The store may be queried using the ‘LIST’, ‘LOOKUP’, and
370      ‘FETCH’ commands returning JSON formatted objects.
371    * utils: A rich set of abstract data-types and utility functions for
372      internal use:
373      - generic channels for asynchronous, multi-threaded I/O
374      - DBI wrapper to ease common database access operations
375      - thread-aware error handling and reporting
376      - doubly linked-lists
377      - dynamic sized memory buffers supporting formatted strings and binary
378        data
379      - UNIX socket client implementation
380    * documentation: Full documentation for the tools, all plugins, and the
381      query language provided as manpages and HTML pages.
382    * testing: Unit and integration tests exist for most parts except plugins
383      covering 77% of all functions. Valgrind and Clang's address sanitzer are
384      used to detect memory leaks and programming errors.
386   The following plugins are shipped with this version of SysDB:
388   Backends:
389    * collectd::unixsock: Query collectd through its ‘unixsock’ interface
390    * mk-livestatus: Query arbitrary (monitoring) systems using the Check_MK
391      Livestatus interface.
392    * puppet::store-configs: Query Puppet through its “stored configuration”
393      database.
395   Plugins:
396    * cname::dns: Canonicalize hostnames by querying DNS information.
397    * syslog: Send log messages to the system log service.