Werk #6679: Introducing BI datasource program and get_bi_aggregations API call

Component Checks & agents
Title Introducing BI datasource program and get_bi_aggregations API call
Date Nov 9, 2018
Checkmk Edition Checkmk Raw (CRE)
Checkmk Version 1.6.0b1
Level Trivial Change
Class New Feature
Compatibility Compatible - no manual interaction needed

This werks introduces the

  • Thew new Web API interface get_bi_aggregations
  • A datasource program, which uses this interface
  • Two checks bi_aggregation and bi_aggregation_connection, which evaluate the data

Monitoring of BI aggregations was already available with the active check Check state of BI aggregation. This active check could only monitor one aggregation at a time and furthermore drastically slowed the Web GUI when configured for multiple hosts. In some rare instances, when configured for hundreds of hosts it could also lock down the GUI by occupying all available apache workers.

The purpose of this datasource program is to fetch all data in one call and distribute it to specific hosts via piggyback. The use of the BI datasource program is the new recommended way when monitoring BI aggregations.

New API Interface: get_bi_aggregations

Calling this API interface without any extra options returns a dictionary, which includes a list of all aggregation and some additional information about unresponsive sites and unavailable aggregations You can specify a filter dictionary which currently may have two different kind of filter types.

For example "filter": {"names": ["Aggr HostA", "Aggr HostB"]}
"filter": {"groups": ["AggregationGroup1", "AggregationGroup2"]}
"filter": {"names": ["Aggr HostA"], "groups": ["AggregationGroup1"]}

You can find more information in our official documentation soon.

New datasource program: Check BI Aggregations via Web Interface

The datasource program is configurable in WATO. It is able to contact multiple monitoring sites at the same time. Each site can be configured indepedently. The configuration offers the following options

  • Filter fetched aggregations by regex and aggregation groups
  • Assign fetched aggregations to specific hosts via piggyback, for example all hosts which are affected by this aggregations
  • Rewrite of aggregation states, e.g. State if aggregation is in downtime, State if aggregation is acknowledged

New checks

There are two new checks.

bi_aggregation simply displays the state of the aggregation. It is not configurable bi_aggregation_connection shows connections problems with the monitoring site(s).

To the list of all Werks