yanic/README.md
2017-06-14 21:33:15 +02:00

2.3 KiB

Yanic

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

Build Status Coverage Status 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

Quick startup

Usage

Usage of ./yanic:
  -config path/to/config.toml

Configuration

Read comments in config_example.toml for more information.

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:

Respondd for servers: