sealife/fritzbox-exporter

Fritz!Box Prometheus 指标导出器

!https://img.shields.io/gitlab/pipeline/SeaLife-Docker/fritzbox_exporter/master?gitlab_url=https%3A%2F%2Fgit.r3ktm8.de&style=flat-square !https://img.shields.io/docker/v/sealife/fritzbox-exporter?sort=semver&style=flat-square&label=docker%20release !https://img.shields.io/github/v/release/sealife/fritzbox_exporter?include_prereleases&label=software%20release&style=flat-square

镜像概述

这是一个简单直接的AVM Fritz!Box指标导出器，用于向Prometheus提供监控数据。目前存在一些预设条件，可能并非适用于所有Fritz!Box型号。已在AVM Fritz!Box 7590（DSL）上测试通过。若使用其他型号导致数据缺失，请在GitHub提交issue或PR。

核心功能与特性

• 收集Fritz!Box关键指标：设备运行时间、系统信息、网络流量（LAN/WAN）、DSL连接状态、错误统计等
• 支持通过环境变量配置单设备监控
• 支持通过JSON配置文件监控多台Fritz!Box设备
• 提供Prometheus兼容的metrics端点
• 轻量级Docker镜像，基于Python Alpine构建

使用场景与适用范围

适用于需要监控Fritz!Box设备状态的用户，特别是已部署Prometheus监控系统的环境。可用于：

• 网络流量监控与分析
• 设备运行状态跟踪
• DSL连接质量监控
• 网络故障排查与预警

构建与运行

非Docker环境要求

• Python >=3.6
• fritzconnection >= 0.6.5
• prometheus-client >= 0.6.0

源码中包含requirements.txt文件，建议在虚拟环境中使用以下命令安装依赖：

bash
pip install -r requirements.txt

系统服务运行

可直接从shell运行导出器：

1. 按照配置部分设置环境变量
2. 在代码目录执行：python3 -m fritzbox_exporter

（欢迎提交systemd单元文件PR）

Docker Compose部署

yaml
version: '3'
services:
  fritzbox_exporter:
    image: docker.io/sealife/fritzbox-exporter:latest
    restart: unless-stopped
    ports:
      - 8765:8765
    environment:
      FRITZ_HOST: 192.168.178.1  # Fritz!Box的IP地址
      FRITZ_USER: monitoring     # 认证用户名
      FRITZ_PASS: monitoring9987!  # 认证密码

Docker部署

推荐使用Docker容器运行导出器。预构建镜像可在Docker Hub获取：https://hub.docker.com/repository/docker/sealife/fritzbox-exporter

构建镜像：

bash
docker build -t fritzbox_exporter:latest .

运行容器：

bash
docker run -d --name fritzbox_exporter \
  -p <PORT>:<FRITZ_EXPORTER_PORT> \
  -e FRITZ_USER=<YOUR_FRITZ_USER> \
  -e FRITZ_PASS=<YOUR_FRITZ_PASS> \
  fritzbox_exporter:latest

验证运行状态：

bash
curl localhost:<FRITZ_EXPORTER_PORT>/metrics

预期输出示例：

# HELP python_gc_objects_collected_total Objects collected during gc
# TYPE python_gc_objects_collected_total counter
python_gc_objects_collected_total{generation="0"} 481.0
python_gc_objects_collected_total{generation="1"} 112.0
python_gc_objects_collected_total{generation="2"} 0.0
...

配置

环境变量配置

配置完全通过环境变量完成：

多设备配置

可通过绑定挂载settings.json文件到/app/settings.json来配置多台Fritz!Box设备：

json
[
  {
    "host": "fritz.box",
    "username": "prometheus",
    "password": "prometheus"
  },
  {
    "host": "192.168.178.20",
    "username": "prometheus",
    "password": "prometheus"
  }
]

指标

以下是Fritz!Box 7590的指标输出示例，包含主要监控指标：

系统与Python相关指标

• python_gc_objects_collected_total: GC收集的对象总数
• python_gc_objects_uncollectable_total: 不可回收的对象总数
• python_gc_collections_total: GC收集次数
• python_info: Python平台信息
• process_virtual_memory_bytes: 进程虚拟内存大小
• process_resident_memory_bytes: 进程物理内存大小
• process_start_time_seconds: 进程启动时间
• process_cpu_seconds_total: 进程CPU时间
• process_open_fds: 打开的文件描述符数量
• process_max_fds: 最大文件描述符数量

Fritz!Box设备指标

• fritzbox_uptime_total: 设备运行时间（标签包含型号、序列号、软件版本）
• fritzbox_update_available: 是否有更新可用（1=有更新，0=无更新）
• fritzbox_lan_status_enabled: LAN接口是否启用
• fritzbox_lan_status: LAN接口状态
• fritzbox_lan_received_bytes_total: LAN接收字节数
• fritzbox_lan_transmitted_bytes_total: LAN发送字节数
• fritzbox_lan_received_packets_total: LAN接收数据包数
• fritzbox_lan_transmitted_packets_total: LAN发送数据包数
• fritzbox_dsl_status_enabled: DSL是否启用（仅DSL型号可用）
• fritzbox_dsl_status: DSL状态（仅DSL型号可用）
• fritzbox_dsl_datarate_kbps: DSL数据速率（当前/最大，上行/下行）
• fritzbox_internet_online_monitor: 在线监控统计
• fritzbox_dsl_noise_margin_dB: 噪声裕量（dB）
• fritzbox_dsl_attenuation_dB: 线路衰减（dB）
• fritzbox_ppp_connection_uptime: PPP连接运行时间
• fritzbox_ppp_conection_state: PPP连接状态
• fritzbox_wan_data_bytes_total: WAN数据字节数（上行/下行）
• fritzbox_wan_data_packets_total: WAN数据包数（上行/下行）
• fritzbox_dsl_errors_fec: FEC错误数
• fritzbox_dsl_errors_crc: CRC错误数
• fritzbox_dsl_power_upstream: 上行功率
• fritzbox_dsl_power_downstream: 下行功率

注意：所有fritzbox_dsl_*指标仅在使用DSL连接时可用。

版权信息

Copyright 2019 Patrick Dreker <***>

基于Apache License 2.0许可（详见LICENSE）。您必须遵守许可条款才能使用此软件。许可副本可在以下地址获取：

http://www.apache.org/licenses/LICENSE-2.0

除非***要求或书面同意，软件按"原样"分发，不提供任何明示或暗示的担保。