Standard Logging Facilities

The cobald.daemon provides several separate logging channels. Each exposes information from a different view and for a different audience. Both core components and plugins should hook into these channels to supply appropriate information.

Logging Channels

Channels are separated by a hierarchical logging name.

"cobald.runtime"

Diagnostic information on the health of the daemon and its abstractions. This includes resources initialised (e.g. databases or modules), and any failures that may affect daemon stability (e.g. unavailable resources).

"cobald.control"

Information specific to the pool control model. This includes decisions made and statistics used for this purpose.

"cobald.monitor"

Monitoring information for automated processing.

Log providers hook into channels by creating a sub-logger. For example, the daemon core uses the "cobald.runtime.daemon" logger for diagnostics.

The Monitor Channel

In contrast to other channels, the "cobald.monitor" channel provides structured data. This data is suitable for data transfer formats such as JSON or telegraf. Each entry consists of an identifier and a dictionary of data:

# get a separate logger in the 'cobald.monitor' channel
logger = logging.getLogger('cobald.monitor.wheatherapi')
# `message` forms the identifier, `args` contains data
logger.info('forecast', {'temperature': 298, 'humidity': 0.45})

Note that the message is not formatted with the content of args` The specific output format is defined by the logging.Formatter used for a logging.Handler.

LineProtocolFormatter

Formatter for the InfluxDB Line Protocol, as used by InfluxDB and Telegraf. This is a structured format, without access to the underlying report metadata. The report message always acts as the measurement key.

Supports adding default data as tags, e.g. as LineProtocolFormatter({'latitude': 49, 'longitude': 8}).

forecast,latitude=49,longitude=8 humidity=0.45,temperature=298

cobald.monitor.format_json.JsonFormatter

Formatter for the JSON format. This is an unstructured format, with optional access to the underlying report metadata.

Supports adding default data, e.g. as JsonFormatter({'latitude': 49, 'longitude': 8}).

{"latitude": 49, "longitude": 8, "temperature": 298, "humidity": 0.45, "message": "forecast"}