warren

command module
v0.0.0-...-d6aee50 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2017 License: BSD-2-Clause Imports: 14 Imported by: 0

README

Warren

Warren is a program to act as part of a monitoring system on a home network. It exports data for external programs to acquire and log to timeseries databases. Currently, Warren exports data in a way that is intended for scraping by Prometheus.

It's largely a personal project, which may or may not be useful to others. It's highly likely to change as my own requirements do. Currently monitors and exports data from:

  • Linux OS-exposed data.
  • CurrentCost serial XML output.
  • Pattern-matched lines in "tailed" file(s).
  • Pattern-matched lines on stdout/stderr from command(s).
  • Metrics updated in response to HTTP requests.

Installation

go get github.com/huin/warren

Running

example.cfg contains an example configuration, which is in the TOML configuration language. Comments in the file should (hopefully) explain. Use the --config flag to provide the configuration.

Documentation

Overview

Warren is a program to act as part of a monitoring system on a home network. It exports data for external programs to acquire and log to timeseries databases. Currently, Warren exports data in a way that is intended for scraping by Prometheus - http://prometheus.io/.

Directories

Path Synopsis
Package nullmetric contains placeholder metrics for prometheus that do nothing.
Package nullmetric contains placeholder metrics for prometheus that do nothing.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL