bbricardo/fritzinfluxdb

Fritz InfluxDB

"fritzinfluxdb" 是一个用Python编写的工具，用于从FritzBox路由器获取数据并写入InfluxDB。其功能与fritzcollectd相当，可直接写入InfluxDB。

收集的数据类型

• 连接相关信息（数据量、吞吐量、每日上传/下载统计）
• 所有日志消息
• 家庭自动化（温度、功耗、 heating 设置）
• 通话记录（呼入、呼出、未接、拦截）
• 系统统计（CPU使用率/温度、内存使用率）
• WLAN信息（客户端数量、状态、信道）
• ***/DynDNS信息（活跃用户、***主机名、DynDNS设置）

支持InfluxDB 1和InfluxDB 2版本

!https://raw.githubusercontent.com/bb-Ricardo/fritzinfluxdb/main/grafana/grafana_dashboard.png

重要提示:

为确保正常工作，需启用"允许应用程序访问"和"通过UPnP提供状态数据"功能。

要求

• Python 3.7或更高版本
• influxdb（用于InfluxDB 1）
• influxdb_client（用于InfluxDB 2）
• fritzconnection
• pytz

已在FritzOS 7.29版本上测试。旧版本可能仍可工作，但部分数值可能缺失。

支持DSL和电缆调制解调器版本的FritzBox。启动时可能会有关于禁用服务的消息，这是正常现象，因为某些型号不支持特定数值。

环境要求

• Grafana >= 9.1.0

安装配置

• 假设安装目录为 /opt

配置文件

克隆仓库后，从https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/fritzinfluxdb-sample.ini%E5%A4%8D%E5%88%B6%E9%85%8D%E7%BD%AE%E5%88%B0 fritzinfluxdb.ini 并编辑设置。所有设置在文件中均有说明。

环境变量

配置值也可通过环境变量覆盖。
格式：<SECTION_NAME>_<CONFIG_OPTION>（均为大写）
例如InfluxDB令牌：
export INFLUXDB_TOKEN="abcedef"

环境变量将覆盖配置文件中定义的选项。

系统安装

shell
sudo apt-get install python3-virtualenv
cd /opt
git clone https://github.com/bb-Ricardo/fritzinfluxdb.git
cd fritzinfluxdb
virtualenv -p python3 .venv
. .venv/bin/activate
pip3 install -r requirements.txt

shell
yum install git python36-virtualenv
cd /opt
git clone https://github.com/bb-Ricardo/fritzinfluxdb.git
cd fritzinfluxdb
virtualenv-3 .venv
. .venv/bin/activate
pip3 install -r requirements.txt

shell
dnf install git-core python3-virtualenv
cd /opt
git clone https://github.com/bb-Ricardo/fritzinfluxdb.git
cd fritzinfluxdb
virtualenv-3 .venv
. .venv/bin/activate
pip3 install -r requirements.txt

shell
dnf install git-core
cd /opt
git clone https://github.com/bb-Ricardo/fritzinfluxdb.git
cd fritzinfluxdb
python3 -m venv .venv
. .venv/bin/activate
pip3 install -r requirements.txt

• 修改配置并测试

./fritzinfluxdb.py

安装为systemd服务

Ubuntu

cp /opt/fritzinfluxdb/fritzinfluxdb.service /etc/systemd/system

RHEL/CentOS/Rocky/Alma

sed -e 's/nogroup/nobody/g' /opt/fritzinfluxdb/fritzinfluxdb.service > /etc/systemd/system/fritzinfluxdb.service

systemctl daemon-reload
systemctl start fritzinfluxdb
systemctl enable fritzinfluxdb

Docker部署

可在Docker容器中运行应用。可自行构建镜像或使用Docker Hub上的镜像。

Docker Hub地址：https://hub.docker.com/r/bbricardo/fritzinfluxdb

• 应用工作目录为 /app

自行构建镜像：

shell
docker build -t bbricardo/fritzinfluxdb:latest .

启动容器：

shell
docker run --rm -d -v /PATH/TO/fritzinfluxdb.ini:/app/fritzinfluxdb.ini --name fritzinfluxdb docker.xuanyuan.run/bbricardo/fritzinfluxdb:latest

也可使用提供的https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/docker-compose.yml%EF%BC%9A

docker-compose up -d

如果InfluxDB也在同一主机的Docker中运行，需在运行命令中添加--link参数。

示例:

• 启动InfluxDB容器

docker run --name=influxdb -d -p 8086:8086 docker.xuanyuan.run/influxdb

• 在fritzinfluxdb.ini中设置InfluxDB主机为influxdb
• 运行fritzinfluxdb容器

docker run --link influxdb -d -v /PATH/TO/fritzinfluxdb.ini:/app/fritzinfluxdb.ini --name docker.xuanyuan.run/fritzinfluxdb fritzinfluxdb

升级

• 更新虚拟环境 pip3 install -r requirements.txt
• 使用更新后的配置文件，并从旧配置中迁移凭据和地址信息

InfluxDB设置

创建InfluxDB 1数据库或InfluxDB 2桶（包括保留策略映射）时，建议首次运行使用管理员凭据/令牌。初始设置完成后请勿使用管理员令牌。

InfluxDB 1示例：

shell
export INFLUXDB_USERNAME=admin
export INFLUXDB_PASSWORD=SuperSecret

InfluxDB 2示例：

shell
export INFLUXDB_TOKEN=InfluxDBAdminToken

如通过Docker运行，可参考https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file%E3%80%82

对于InfluxDB 2，强烈建议为指定桶创建专用的只写令牌。

运行脚本

usage: fritzinfluxdb.py [-h] [-c fritzinfluxdb.ini [fritzinfluxdb.ini ...]] [-d] [-v]

fritzinfluxdb
Version: 1.2.4 (2024-10-15)
Project URL: https://github.com/bb-Ricardo/fritzinfluxdb

可选参数:
  -h, --help            显示帮助信息并退出
  -c fritzinfluxdb.ini [fritzinfluxdb.ini ...], --config fritzinfluxdb.ini [fritzinfluxdb.ini ...]
                        指定配置文件路径，默认为'./fritzinfluxdb.ini'
  -d, --daemon          以systemd守护进程模式运行
  -v, --verbose         启用详细输出以获取调试日志，'-vv'将同时打印所有HTTP调用

Grafana集成

用于显示收集数据的仪表板位于https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana%E7%9B%AE%E5%BD%95%E4%B8%8B%E3%80%82%E7%94%B1%E4%BA%8EInfluxDB 1.8 Flux语言实现的限制，仪表板已分离。

Influx数据源配置：

InfluxDB 1.8:

• 必须选择"查询语言"为InfluxQL
• 已弃用：这些仪表板将不再开发/扩展

InfluxDB >=2.2.0:

• 必须选择"查询语言"为Flux
• 需将包含FritzBox数据的桶设置为默认桶（所有仪表板使用默认桶）

仪表板

包含以下仪表板：

InfluxDB 1.8.X（已弃用）:

• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx1_dashboards/fritzbox_system_dashboard.json
• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx1_dashboards/fritzbox_logs_dashboard.json
• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx1_dashboards/fritzbox_call_log_dashboard.json

InfluxDB >=2.2.0:

• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx2_dashboards/fritzbox_system_dashboard.json
• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx2_dashboards/fritzbox_logs_dashboard.json
• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx2_dashboards/fritzbox_call_log_dashboard.json
• https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/grafana/influx2_dashboards/fritzbox_home_automation_dashboard.json

此项目深受以下项目启发：https://grafana.com/grafana/dashboards/713-fritz-box-router-status/

配置更多属性

可参考以下链接了解更多可添加的属性 https://wiki.fhem.de/w/index.php?title=FRITZBOX

新服务可在https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/fritzinfluxdb/classes/fritzbox/service_definitions%E4%B8%AD%E5%AE%9A%E4%B9%89

许可证

完整许可证可查看https://github.com/bb-Ricardo/fritzinfluxdb/blob/main/LICENSE.txt

本项目采用MIT许可证。