ffhb/yanic
ffhb
/
yanic
mirror of https://github.com/FreifunkBremen/yanic.git
1
0
Fork 0
Code Issues Releases Wiki Activity

chore(docs): improve for influxdb2

This commit is contained in:
Florian Maurer 2023-09-20 09:29:02 +02:00 committed by genofire
parent f98fea7041
commit f5d462ff34
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
config_example.toml
View File

@ -195,7 +195,7 @@ delete_interval = "1h"
#enable = true #enable = true
# Save collected data to InfluxDB. # Save collected data to InfluxDB.
# There are the following measurments: # There are the following measurements:
# node: store node specific data i.e. clients memory, airtime # node: store node specific data i.e. clients memory, airtime
# link: store link tq between two interfaces of two different nodes # link: store link tq between two interfaces of two different nodes
# global: store global data, i.e. count of clients and nodes # global: store global data, i.e. count of clients and nodes
@ -220,7 +220,7 @@ password = ""
#site = "ffhb" #site = "ffhb"
# Save collected data to InfluxDB2. # Save collected data to InfluxDB2.
# There are the following measurments: # There are the following measurements:
# node: store node specific data i.e. clients memory, airtime # node: store node specific data i.e. clients memory, airtime
# link: store link tq between two interfaces of two different nodes with i.e. nodeid, address, hostname # link: store link tq between two interfaces of two different nodes with i.e. nodeid, address, hostname
# global: store global data, i.e. count of clients and nodes # global: store global data, i.e. count of clients and nodes
@ -233,12 +233,12 @@ address = "http://localhost:8086"
token = "" token = ""
organization_id = "" organization_id = ""
# fallback of no specific bucket for measurement is setup # fallback of no specific bucket for measurement is setup
bucket_default = "" bucket_default = "yanic"
# Specify bucket per measurement (of not set fallback bucket_default is used or panic) # Specify bucket per measurement (of not set fallback bucket_default is used or panic)
# #
# WARNING: # WARNING:
# yanic do NOT prune node's data (so please setup it in InfluxDB2 setup). # yanic does NOT prune node's data (so please set up data retention in InfluxDB2 setup).
# #
# We highly recommend to setup e.g. Data retention in your InfluxDB2 server per measurements. # We highly recommend to setup e.g. Data retention in your InfluxDB2 server per measurements.
# https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/ # https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/
@ -247,7 +247,7 @@ bucket_default = ""
#link = "yanic-temp" #link = "yanic-temp"
#node = "yanic-temp" #node = "yanic-temp"
#dhcp = "yanic-temp" #dhcp = "yanic-temp"
global = "yanic" global = "yanic-persistent"
#firmware = "yanic-temp" #firmware = "yanic-temp"
#model = "yanic-temp" #model = "yanic-temp"
#autoupdater = "yanic-temp" #autoupdater = "yanic-temp"

18
docs/docs/configuration.md
View File

@ -393,7 +393,7 @@ site = "ffhb"
### [[database.connection.influxdb2]] ### [[database.connection.influxdb2]]
Save collected data to InfluxDB2. Save collected data to InfluxDB2.
There are the following measurments: There are the following measurements:
- **node**: store node specific data i.e. clients memory, airtime - **node**: store node specific data i.e. clients memory, airtime
- **link**: store link tq between two interfaces of two different nodes with i.e. nodeid, address, hostname - **link**: store link tq between two interfaces of two different nodes with i.e. nodeid, address, hostname
@ -407,7 +407,7 @@ There are the following measurments:
A bucket has to be set in buckets and buchet_default otherwise yanic would panic. A bucket has to be set in buckets and buchet_default otherwise yanic would panic.
!!! warning !!! warning
yanic do NOT prune node's data (so please setup it in InfluxDB2 setup). yanic does NOT prune node's data (so please set up data retention in InfluxDB2 setup).
We highly recommend to setup e.g. [Data retention](https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/) in your InfluxDB2 server per measurements. We highly recommend to setup e.g. [Data retention](https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/) in your InfluxDB2 server per measurements.
@ -417,13 +417,13 @@ enable = false
address = "http://localhost:8086" # (1) address = "http://localhost:8086" # (1)
token = "" # (2) token = "" # (2)
organization_id = "" # (3) organization_id = "" # (3)
bucket_default = "" # (4) bucket_default = "yanic" # (4)
[database.connection.influxdb2.buckets] # (5) [database.connection.influxdb2.buckets] # (5)
#link = "yanic-temp" #link = "yanic-temp"
#node = "yanic-temp" #node = "yanic-temp"
#dhcp = "yanic-temp" #dhcp = "yanic-temp"
global = "yanic" global = "yanic-persistent"
#firmware = "yanic-temp" #firmware = "yanic-temp"
#model = "yanic-temp" #model = "yanic-temp"
#autoupdater = "yanic-temp" #autoupdater = "yanic-temp"
@ -438,19 +438,19 @@ global = "yanic"
#site = "ffhb" #site = "ffhb"
``` ```
1. Address to connect on InfluxDB2 server. 1. Address to connect to the InfluxDB2 server.
2. Token to get acces to InfluxDB2 server. 2. Token to get access to InfluxDB2 server.
3. Set organization using the InfluxDB2 server. 3. Set organization using the InfluxDB2 server.
4. Bucket in which are the data stored. 4. Bucket in which are the data stored.
Fallback of bucket per measurment, see `[database.connection.influxdb2.buckets]` Fallback of bucket per measurement, see `[database.connection.influxdb2.buckets]`
5. Buckets per measurement. 5. Buckets per measurement.
If not set data `bucket_default` is used. If no buckets are set, the default bucket `bucket_default` is used.
6. You could set manuelle tags with inserting into a influxdb. 6. You can set additional tags which are added to all data written into the influxdb.
Useful if you want to identify the yanic instance when you use multiple own on the same influxdb (e.g. multisites). Useful if you want to identify the yanic instance when you use multiple own on the same influxdb (e.g. multisites).