Licenses: Updated the list of licenses and added a PDF containing all license texts
[check_mk.git] / .werks / 6679
blob54aa5d9515a95ec244f590db40af17a5ec9aa041
1 Title: Introducing BI datasource program and get_bi_aggregations API call
2 Level: 1
3 Component: checks
4 Compatible: compat
5 Edition: cre
6 Version: 1.6.0i1
7 Date: 1541775502
8 Class: feature
10 This werks introduces the
11 <ul>
12 <li>Thew new Web API interface get_bi_aggregations</li>
13 <li>A datasource program, which uses this interface</li>
14 <li>Two checks bi_aggregation and bi_aggregation_connection, which evaluate the data</li>
15 </ul>
17 Monitoring of BI aggregations was already available with the active check <tt>Check state of BI aggregation</tt>.
18 This active check could only monitor one aggregation at a time and furthermore drastically slowed the Web GUI when
19 configured for multiple hosts. In some rare instances, when configured for hundreds of hosts it could also lock down
20 the GUI by occupying all available apache workers.
22 The purpose of this datasource program is to fetch all data in one call and distribute it to specific hosts via piggyback.
23 The use of the BI datasource program is the new recommended way when monitoring BI aggregations.
26 <h3>New API Interface: <tt>get_bi_aggregations</tt></h3>
27 Calling this API interface without any extra options returns a dictionary, which includes
28 a list of all aggregation and some additional information about unresponsive sites and unavailable aggregations
29 You can specify a filter dictionary which currently may have two different kind of filter types.
31 For example
32 <tt>"filter": {"names": ["Aggr HostA", "Aggr HostB"]}</tt><br>
33 <tt>"filter": {"groups": ["AggregationGroup1", "AggregationGroup2"]}</tt><br>
34 <tt>"filter": {"names": ["Aggr HostA"], "groups": ["AggregationGroup1"]}</tt>
36 You can find more information in our official documentation soon.
39 <h3>New datasource program: <tt>Check BI Aggregations via Web Interface</tt></h3>
40 The datasource program is configurable in WATO. It is able to contact multiple monitoring sites at the same time.
41 Each site can be configured indepedently. The configuration offers the following options
42 <ul>
43 <li>Filter fetched aggregations by regex and aggregation groups</li>
44 <li>Assign fetched aggregations to specific hosts via piggyback, for example all hosts which are affected by this aggregations</li>
45 <li>Rewrite of aggregation states, e.g. State if aggregation is in downtime, State if aggregation is acknowledged</li>
46 </ul>
48 <h3>New checks</h3>
49 There are two new checks.
51 <tt>bi_aggregation</tt> simply displays the state of the aggregation. It is not configurable
52 <tt>bi_aggregation_connection</tt> shows connections problems with the monitoring site(s).