# Fritzbox Input Plugin This plugin gathers status information from [FRITZ!][fritz] devices (routers, repeaters, etc) using the device's [TR-064][tr064] interface. ⭐ Telegraf v1.35.0 🏷️ network, iot 💻 all [fritz]: https://fritz.com/ [tr064]: https://fritz.com/en/pages/interfaces ## Global configuration options Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md][CONFIGURATION.md] for more details. [CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins ## Configuration ```toml @sample.conf # Gather fritzbox status [[inputs.fritzbox]] ## URLs of the devices to query including login credentials urls = [ "http://user:password@fritz.box:49000/" ] ## The information to collect (see README for further details). # collect = [ # "device", # "wan", # "ppp", # "dsl", # "fiber", # "wlan", # ] ## The http timeout to use. # timeout = "10s" ## Optional TLS Config # tls_ca = "/etc/telegraf/ca.pem" # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" # tls_key_pwd = "secret" ## Use TLS but skip chain & host verification # insecure_skip_verify = false ``` ### Collect options The following collect options are available: `device` : Collect device information like model name, SW version, uptime etc for the configured devices. Will create `fritzbox_device` metrics. `wan` : Collect generic WAN connection status like bit rates, transferred bytes for the configured devices. Will create `fritzbox_wan`metrics. `ppp` : Collect PPP connection parameters like bit rates, uptime for the configured devices. Will create `fritzbox_ppp` metrics. `dsl` : Collect DSL line status and statistics for the configured devices. Will create `fritzbox_dsl` metrics. `fiber` : Collect Fiber line status and statistics for the configured devices. Will create `fritzbox_fiber` metrics. `wlan` : Collect status and number of associated devices for all WLANs. Will create `fritzbox_wlan` metrics. `hosts` : Collect detailed information of the mesh network including connected nodes, there role in the network as well as their connection bandwidth. Will create `fritzbox_hosts` metrics. > [!NOTE] Collecting `hosts` metrics is time consuming and generates > very detailed data. If you activate this option, consider increasing > the plugin's query interval to avoid interval overruns and to minimize > the amount of collected data. An empty `collect` option defaults to the set `["device", "wan", "ppp", "dsl", "wlan"]` supported by the initial release of the plugin. Newly added options like `fiber` must be enabled explicitly. ## Metrics By default field names are directly derived from the corresponding [interface specification][tr064]. - `fritzbox_device` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - fields - `uptime` (uint) - Device's uptime in seconds. - `model_name` (string) - Device's model name. - `serial_number` (string) - Device's serial number. - `hardware_version` (string) - Device's hardware version. - `software_version` (string) - Device's software version. - `fritzbox_wan` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - fields - `layer1_upstream_max_bit_rate` (uint) - WAN interface's maximum upstream bit rate (bits/sec) - `layer1_downstream_max_bit_rate` (uint) - WAN interface's maximum downstream bit rate (bits/sec) - `upstream_current_max_speed` (uint) - WAN interface's current maximum upstream transfer rate (bytes/sec) - `downstream_current_max_speed` (uint) - WAN interface's current maximum downstream data rate (bytes/sec) - `total_bytes_sent` (uint) - Total number of bytes sent via the WAN interface (bytes) - `total_bytes_received` (uint) - Total number of bytes received via the WAN interface (bytes) - `fritzbox_ppp` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - fields - `uptime` (uint) - Uptime of the PPP connection in seconds - `upstream_max_bit_rate` (uint) - Maximum upstream bit rate negotiated for the PPP connection (bits/sec) - `downstream_max_bit_rate` (uint) - Maximum downstream bit rate negotiated for the PPP connection (bits/sec) - `fritzbox_dsl` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - `status` - The status of the DLS line (Up or Down) - fields - `upstream_curr_rate` (uint) - Current DSL upstream rate (kbits/sec) - `downstream_curr_rate` (uint) - Current DSL downstream rate (kbits/sec) - `upstream_max_rate` (uint) - Maximum DSL upstream rate (kbits/sec) - `downstream_max_rate` (uint) - Maximum DSL downstream rate (kbits/sec) - `upstream_noise_margin` (uint) - Upstream noise margin (db) - `downstream_noise_margin` (uint) - Downstream noise margin (db) - `upstream_attenuation` (uint) - Upstream attenuation (db) - `downstream_attenuation` (uint) - Downstream attenuation (db) - `upstream_power` (uint) - Upstream power - `downstream_power` (uint) - Downstream power - `receive_blocks` (uint) - Received blocks - `transmit_blocks` (uint) - Transmitted blocks - `cell_delin` (uint) - Cell delineation count - `link_retrain` (uint) - Link retrains - `init_errors` (uint) - Initialization errors - `init_timeouts` (uint) - Initialization timeouts - `loss_of_framing` (uint) - Loss of frame errors - `errored_secs` (uint) - Continuous seconds with errors - `severly_errored_secs` (uint) - Continuous seconds with severe errors - `fec_errors` (uint) - Local Modem Forward Error Correction errors - `atuc_fec_errors` (uint) - Remote DSLAM Forward Error Correction errors - `hec_errors` (uint) - Local Modem Header Error Control errors - `atuc_hec_errors` (uint) - Remote DSLAM Header Error Control errors - `crc_errors` (uint) - Local Modem Cyclic Redundancy Check error - `atuc_crc_errors` (uint) - Remote DSLAM Cyclic Redundancy Check errors - `fritzbox_fiber` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - fields - `optical_signal_level` (uint) - Optical signal level (mdBm) - `lower_optical_threshold` (uint) - Lower optical threshold (mdBm) - `upper_optical_threshold` (uint) - Upper optical threshold (mdBm) - `transmit_optical_level` (uint) - Transmit optical signal level (mdBm) - `lower_transmit_power_threshold` (uint) - Lower transmit power threshold (mdBm) - `upper_transmit_power_threshold` (uint) - Upper transmit power threshold (mdBm) - `sfp_vendor` (string) - SFP module vendor - `sfp_part_number` (string) - SFP module part number - `sfp_serial_number` (string) - SFP module serial number - `sfp_type` (uint) - SFP module type - `tx_wave_length` (uint) - TX wave length (nm) - `fiber_mode` (string) - Current fiber mode - `bytes_sent` (uint) - Total bytes sent - `bytes_received` (uint) - Total bytes received - `packets_sent` (uint) - Total packets sent - `packets_received` (uint) - Total packets received - `packet_errors_sent` (uint) - Total send packet errors - `packet_errors_received` (uint) - Total receive packet errors - `packets_multicast` (uint) - Total multicast packets - `connection_rate_down` (uint) - Downstream connection rate (bit/s) - `connection_rate_up` (uint) - Upstream connection rate (bit/s) - `best_train_state` (uint) - Best train state - `resyncs` (uint) - Number of resyncs - `minutes_in_showtime` (uint) - Minutes in showtime - `fritzbox_wlan` - tags - `source` - The name of the device (this metric has been queried from) - `service` - The service id used to query this metric - `wlan` - The WLAN SSID (name) - `channel` - The channel used by this WLAN - `band` - The band (in MHz) used by this WLAN - `status` - The status of the WLAN line (Up or Down) - fields - `total_associations` (uint) - The number of devices connected to this WLAN. - `fritzbox_hosts` - tags - `source` - Device name this metric has been queried from - `service` - Service ID used to query this metric - `node` - Node name connected to the mesh network - `node_role` - Node role in the network ("master" = mesh master, "slave" = mesh slave, "client") - `node_ap` - Name of the access point this node is connected to - `node_ap_role` - Access point's role in the network ("master" = mesh master, "slave" = mesh slave) - `link_type` - Link type ("WLAN" or "LAN") of the peer connection - `link_name` - Link name of the connection - fields - `max_data_rate_tx` (uint) - The connection's maximum transmit rate (kbits/sec) - `max_data_rate_rx` (uint) - The connection's maximum receive rate (kbits/sec) - `cur_data_rate_tx` (uint) - The connection's maximum transmit rate (kbits/sec) - `cur_data_rate_rx` (uint) - The connection's current receive rate (kbits/sec) ## Example Output ```text fritzbox_device,service=DeviceInfo1,source=fritz.box uptime=2058438i,model_name="Mock 1234",serial_number="123456789",hardware_version="Mock 1234",software_version="1.02.03" 1737003520174438000 fritzbox_wan,service=WANCommonInterfaceConfig1,source=fritz.box layer1_upstream_max_bit_rate=48816000i,layer1_downstream_max_bit_rate=253247000i,upstream_current_max_speed=511831i,downstream_current_max_speed=1304268i,total_bytes_sent=129497283207i,total_bytes_received=554484531337i 1737003587690504000 fritzbox_ppp,service=WANPPPConnection1,source=fritz.box uptime=369434i,upstream_max_bit_rate=44213433i,downstream_max_bit_rate=68038668i 1737003622308149000 fritzbox_dsl,service=WANDSLInterfaceConfig1,source=fritz.box,status=Up downstream_curr_rate=249065i,downstream_max_rate=249065i,downstream_power=513i,init_timeouts=0i,atuc_crc_errors=13i,errored_secs=25i,atuc_hec_errors=0i,upstream_noise_margin=80i,downstream_noise_margin=60i,downstream_attenuation=140i,receive_blocks=490282831i,transmit_blocks=254577751i,init_errors=0i,crc_errors=53i,fec_errors=0i,hec_errors=0i,upstream_max_rate=48873i,upstream_attenuation=80i,upstream_power=498i,cell_delin=0i,link_retrain=2i,loss_of_framing=0i,upstream_curr_rate=46719i,severly_errored_secs=0i,atuc_fec_errors=0i 1737003645769642000 fritzbox_fiber,service=X_AVM_DE_WANFiber1,source=127.0.0.1 optical_signal_level=0i,lower_optical_threshold=0i,upper_optical_threshold=-5900i,transmit_optical_level=0i,lower_transmit_power_threshold=-500i,upper_transmit_power_threshold=0i,sfp_vendor="XXXX XXx",sfp_part_number="",sfp_serial_number="AB12345678901",sfp_type=0i,tx_wave_length=1310u,fiber_mode="Unknown",bytes_sent=664548698u,bytes_received=0u,packets_sent=1328165u,packets_received=0u,packet_errors_sent=0u,packet_errors_received=0u,packets_multicast=2944821u,connection_rate_down=0u,connection_rate_up=1250000u,best_train_state=0u,resyncs=0u,minutes_in_showtime=0u 1737088741855188000 fritzbox_wlan,band=2400,channel=13,service=WLANConfiguration1,source=fritz.box,ssid=MOCK1234,status=Up total_associations=11i 1737003673561198000 fritzbox_hosts,node=device#17,node_ap=device#1,node_ap_role=master,node_role=slave,link_name=AP:2G:0,link_type=WLAN,service=Hosts1,source=fritz.box cur_data_rate_tx=216000i,cur_data_rate_rx=216000i,max_data_rate_tx=216000i,max_data_rate_rx=216000i 1737003707257394000 fritzbox_hosts,node=device#24,node_ap=device#17,node_ap_role=slave,node_role=client,link_name=LAN:1,link_type=LAN,service=Hosts1,source=fritz.box max_data_rate_tx=1000000i,max_data_rate_rx=1000000i,cur_data_rate_tx=0i,cur_data_rate_rx=0i 1737003707257248000 ```