Go to file

Julian Kornberger cbb5f2e59b Switch to cobra for the CLI		2017-10-01 17:09:12 +02:00
cmd	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00
contrib	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00
data	[TASK] add per-link statistics (#57 )	2017-09-27 13:55:02 +02:00
database	[TASK] add per-link statistics (#57 )	2017-09-27 13:55:02 +02:00
jsontime	improve complete code with comments and co (thanks linter)	2017-01-20 22:27:44 +01:00
meshviewer	[TASK] add per-link statistics (#57 )	2017-09-27 13:55:02 +02:00
respond	[TASK] add per-link statistics (#57 )	2017-09-27 13:55:02 +02:00
rrd	fix bugs rrd importer -> clients are no nodes :)	2016-10-04 15:00:54 +02:00
runtime	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00
webserver	Remove API and simplify webserver	2017-01-29 20:35:50 +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	Add Coveralls	2016-03-20 13:51:54 +01:00
.travis.yml	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00
config_example.toml	[TASK] Delay startup until a multiple of the period since zero time (#68 )	2017-06-14 09:44:15 +02:00
INSTALL.md	[TASK] Make yanic more modular for multiple databases (#33 )	2017-04-10 18:54:12 +02:00
main.go	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00
README.md	Switch to cobra for the CLI	2017-10-01 17:09:12 +02:00

README.md

Yanic

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

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

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%wlp4s0]:1001"

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

Live

meshviewer Freifunk Bremen with a patch to show state-version of nodes.json
grafana Freifunk Bremen show data of InfluxDB

Collecting data from respondd:

HopGlass Server written in Node.js

Respondd for servers:

ffnord-alfred-announce from FreiFunkNord
respondd from Sunz3r