Yet another node info collector - for respondd to be used with meshviewer to Grafana (with influxdb or graphite)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
genofire a6f61f9d3e
[BUGFIX] respondd module encoding
9 months ago
.circleci Trash Travis-CI 2 years ago
.github Add PR template for communities using Yanic 2 years ago
.gitlab/issue_templates [TASK] add support for gitlab 2 years ago
cmd [DOC] improve raw-output 9 months ago
contrib [TASK] Add editorconfig & format code (#94) 3 years ago
data add support for custom fields 9 months ago
database [TASK] improve neighbours stats (+ babel support) 1 year ago
docs [DOC] improve raw-output 9 months ago
lib lib/duration: Implement encoding.TextUnmarshaler 2 years ago
output raw output: add custom fields 9 months ago
respond [BUGFIX] respondd module encoding 9 months ago
rrd [TASK] improve logging 1 year ago
runtime add support for custom fields 9 months ago
webserver [TASK] improve logging 1 year ago
.drone.yml add drone 2 years ago
.editorconfig [TASK] Add editorconfig & format code (#94) 3 years ago
.gitignore [TEST] improve gitlab-ci 1 year ago
.gitlab-ci.yml [TEST] improve gitlab-ci 1 year ago
.gitmodules switch to config-file 4 years ago
Gopkg.lock update dep 1 year ago
Gopkg.toml add support for custom fields 9 months ago
INSTALL.md [DOC] update install 1 year ago
LICENSE Use license from Github template 2 years ago
README.md [DOC] update install 1 year ago
SUMMARY.md [TASK] add rules for documentation, PR and testing 2 years ago
book.json [TASK] add rules for documentation, PR and testing 2 years ago
config_example.toml [DOC] improve raw-output 9 months ago
main.go not export logging stdout / stderr hook 1 year ago

README.md

Yanic

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

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 ff05::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

Installation

Take a look into the Documentation (see above) or for Quick Overview in INSTALL.md.

If you like Docker you may want to take a look here.

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
      --loglevel uint32   Show log message starting at level (default 40)
      --timestamps        Enables timestamps for log output

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

Serve

Runs the yanic server

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

Global Flags:
      --loglevel uint32   Show log message starting at level (default 40)
      --timestamps        Enables timestamps for log output

Query

Sends a query on the interface to the destination and waits for a response

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

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

Flags:
  -h, --help        help for query
      --ip string   ip address which is used for sending (optional - without definition used the link-local address)
      --port int    define a port to listen (if not set or set to 0 the kernel will use a random free port at its own)
      --wait int    Seconds to wait for a response (default 1)

Global Flags:
      --loglevel uint32   Show log message starting at level (default 40)
      --timestamps        Enables timestamps for log output

Import

Imports global statistics from the given RRD files (ffmap-backend).

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

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

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

Global Flags:
      --loglevel uint32   Show log message starting at level (default 40)
      --timestamps        Enables timestamps for log output

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.