Yet another node info collector - for respondd to be used with meshviewer to Grafana (with influxdb or graphite) https://www.gitbook.com/book/freifunkbremen/yanic/details
Go to file
Martin Geno 0c4e17406d
[TASK] influxdb ping on startup
2018-01-19 04:44:01 +01:00
.github Add PR template for communities using Yanic 2018-01-13 16:37:37 +01:00
cmd [BUGFIX] after database refactory 2018-01-19 04:31:33 +01:00
contrib [TASK] Add editorconfig & format code (#94) 2017-11-06 00:59:42 +01:00
data [TASK] extract enable to all databases + increase testing in database 2017-12-31 16:01:11 +01:00
database [TASK] influxdb ping on startup 2018-01-19 04:44:01 +01:00
docs Fix misspells 2018-01-13 17:04:26 +01:00
lib lib/duration: Implement encoding.TextUnmarshaler 2018-01-13 15:06:18 +01:00
output [BUGFIX] fix link type detection by different sources 2018-01-15 02:03:55 +01:00
respond Fix misspells 2018-01-13 17:04:26 +01:00
rrd [TEST] increase test coverage of package runtime to maximum (#75) 2017-10-12 15:25:00 +02:00
runtime Simplify with `gofmt -s -w .` 2018-01-13 16:40:23 +01:00
webserver Move config structs to packages 2018-01-13 15:06:18 +01:00
.editorconfig [TASK] Add editorconfig & format code (#94) 2017-11-06 00:59:42 +01:00
.gitignore Make configuration more intuitive and consistent 2017-01-29 20:35:50 +01:00
.gitmodules switch to config-file 2016-03-07 09:52:52 +01:00
.test-coverage Check for test in cmd package 2018-01-13 15:55:55 +01:00
.travis.gofmt.sh Check gofmt in travis tests 2018-01-13 17:04:26 +01:00
.travis.yml Check for misspells 2018-01-13 17:52:20 +01:00
INSTALL.md [TASK] add rules for documentation, PR and testing 2017-12-31 16:01:19 +01:00
LICENSE Use license from Github template 2018-01-06 15:11:02 +01:00
README.md Readme: explain frontend of Freifunk Nord and Kiel 2018-01-14 15:27:41 +01:00
SUMMARY.md [TASK] add rules for documentation, PR and testing 2017-12-31 16:01:19 +01:00
book.json [TASK] add rules for documentation, PR and testing 2017-12-31 16:01:19 +01:00
circle.yml [TASK] use circle ci for build artifacts + enable data race detection (#95) 2017-11-14 19:33:28 +01:00
config_example.toml Fix misspells 2018-01-13 17:04:26 +01:00
main.go Switch to cobra for the CLI 2017-10-01 17:09:12 +02:00

README.md

Yanic

__   __          _
\ \ / /_ _ _ __ (_) ___
 \ V / _` | '_ \| |/ __|
  | | (_| | | | | | (__
  |_|\__,_|_| |_|_|\___|
Yet another node info collector

Build Status CircleCI Coverage Status codecov Go Report Card

yanic is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:

  • Generating JSON for Meshviewer
  • Storing statistics in InfluxDB or Graphite to be analyzed by Grafana
  • Provide a little webserver for a standalone installation with a meshviewer

How it works

In the first step Yanic sends a multicast message to the group ff02:0:0:0:0:0:2:1001 and port 1001. Recently seen nodes that does not reply are requested via a unicast message.

Documentation

Take a look at the git or Gitbook

Configuration

Read comments in config_example.toml for more information.

Running

Yanic provides several commands:

Usage

Run Yanic without any arguments to get the usage information:

Usage:
  yanic [command]

Available Commands:
  help        Help about any command
  import      Imports global statistics from the given RRD files, requires InfluxDB
  query       Sends a query on the interface to the destination and waits for a response
  serve       Runs the yanic server

Flags:
  -h, --help         help for yanic
      --timestamps   Enables timestamps for log output

Use "yanic [command] --help" for more information about a command.

Serve

Usage:
  yanic serve [flags]

Examples:
  yanic serve --config /etc/yanic.toml

Flags:
  -c, --config string   Path to configuration file (default "config.toml")
  -h, --help            help for serve

Import

Usage:
  yanic import <file.rrd> [flags]

Examples:
  yanic import --config /etc/yanic.toml olddata.rrd

Flags:
  -c, --config string   Path to configuration file (default "config.toml")
  -h, --help            help for import

Query

Usage:
  yanic query <interface> <destination> [flags]

Examples:
  yanic query wlan0 "fe80::eade:27ff:dead:beef"

Flags:
  -h, --help       help for query
      --wait int   Seconds to wait for a response (default 1)

Communities using Yanic

Do you know someone else using Yanic? Create a pull request!

Collecting data from respondd:

Respondd for servers:

License

This software is licensed under the terms of the AGPL v3 License.