p3exporter.collector package¶

Entry point for collector sub module.

class p3exporter.collector.Collector(config: p3exporter.collector.CollectorConfig)[source]¶

Bases: object

Base class to load collectors.

All collectors have to be placed inside the directory collector. You have to follow the naming convention:

Place the collector code in a <name>.py file (e.g. my.py)
Within the file <name>.py` a class <Name>Collector (e.g. MyController) needs to be defined. This is the main collector class which will be imported, instantiate and registered automatically.

class p3exporter.collector.CollectorBase(config: p3exporter.collector.CollectorConfig)[source]¶

Bases: object

Base class for all collectors.

This class will provide methods that do generic work.

property collector_name_from_class¶

Convert class name to controller name.

The class name must follow naming convention:

This will convert MyCollector class name to my collector name.

class p3exporter.collector.CollectorConfig(**kwargs)[source]¶

Bases: object

Class that provide all the logic needed for configuration handling.

Submodules¶

class p3exporter.collector.example.ExampleCollector(config: p3exporter.collector.CollectorConfig)[source]¶

A sample collector.

It does not really do much. It only runs a method and return the time it runs as a gauge metric.

class p3exporter.collector.loadavg.LoadavgCollector(config: p3exporter.collector.CollectorConfig)[source]¶

collect()[source]¶

Collect load avg for 1, 5 and 15 minutes interval.

Returns three gauge metrics. One for each load.

class p3exporter.collector.netdev.NetdevCollector(config: p3exporter.collector.CollectorConfig)[source]¶

collect()[source]¶

Collect netdev metrics.

Returns several info, couter and gauge metrics for interfaces.