History

Cody Lee 4b19b873ab address issue		2025-04-04 08:33:58 -05:00
..
LICENSE	all to pkg	2022-12-02 20:48:01 -05:00
README.md	go 1.19 interface{} -> any	2022-12-03 16:32:12 -06:00
commands.go	add integration test guard;	2023-07-31 14:40:33 -05:00
config.go	add integration test guard;	2023-07-31 14:40:33 -05:00
inputs.go	add integration test guard;	2023-07-31 14:40:33 -05:00
logger.go	go 1.19 interface{} -> any	2022-12-03 16:32:12 -06:00
outputs.go	add integration test guard;	2023-07-31 14:40:33 -05:00
start.go	address issue	2025-04-04 08:33:58 -05:00
testutil.go	rename package per per comment, add comments, and drop unnecessary compile time check	2023-08-03 09:27:09 -05:00

README.md

poller

UniFi Poller Core

This module ties the inputs together with the outputs.

Aggregates metrics on request. Provides CLI app and args parsing.

Ideal

This library has no notion of "UniFi" or controllers, or Influx, or Prometheus. This library simply provides an input interface and an output interface. Each interface uses an []any type, so any type of data can be used. That is to say, you could write input and output plugins that work with, say, Cisco gear, or any other network (or even non-network) data. The existing plugins should provide ample example of how to use this library, but at some point the godoc will improve.

Features

Automatically unmarshal's plugin config structs from config file and/or env variables.
Initializes all "imported" plugins on startup.
Provides input plugins a Logger, requires an interface for Metrics and Events retrieval.
Provides Output plugins an interface to retrieve Metrics and Events, and a Logger.
Provides automatic aggregation of Metrics and Events from multiple sources.