If you like BoxMatrix then please contribute Supportdata, Supportdata2, Firmware and/or Hardware (get in touch).
My metamonk@yahoo.com is not reachable by me since years. Please use hippie2000@webnmail.de instead.
Property:voipkpid (avmcmd)
| BoxMatrix >> Shell-Commands >> voipkpid (avmcmd) | @ BoxMatrix - IRC-Chat - Translate: de es fr it nl pl |
| News | Selectors | Models | Accessories | Components | Environment | Config | Commands | System | Webif | Software | Develop | Lexicon | Community | Project | Media |
| Startup-Scr | Hotplug-Scr | BusyBox-Cmds | Bash-Cmds | AVM-Cmds | Chipset-Cmds | Linux-Cmds | Shared-Libs | Kernel-Mods | Research |
 |
Name-Collision - multiple objects in this wiki use the name voipkpid!
|
AVM-Command
| Command: | voipkpid (avmcmd) - type Exec | Wiki | Freetz | IPPF | whmf | AVM | Web |
| Location: | Shell-Commands >> AVM-Commands - Origin: AVM | ||||||
| Path: | Release: /bin Lab+Rel: /bin | ||||||
| Properties: | Size: 9.2k - 13.6k - Firmware: 7.08 - 8.00 | ||||||
| Function: | VoIP quality KPI collector daemon. | ||||||
Goto: Examples - Events - Source - Dependencies - Model-Matrix - Symbols - SMW-Browser
Details
voipkpid is a VoIP quality KPI collector daemon creating a JSON KPI from data acquired from voipd.
KPI (Key Performance Indicators) are a collection of sensor values like they are required for professional system monitoring.
Many services collect sensor data and generate KPI and starting with fw 7.39 FRITZ!OS implements metering in avmcounterd.
KPI are sent as IPC messages with attached JSON data to ctlmgr which serves the me_KPI.ctl IPC endpoint for this purpose.
Explained KPI providers: aha, kpid, psetd (kpi), voipkpid (libvoipkpi.so), latencyd.
fw 7.29 help:
fritz3:/var/media/ftp $ voipkpid -? usage: voipkpid voipkpid [options] options: -? - print this help -f - run in foreground. (NOTSET) -s - stop daemon. (NOTSET) -n UNSIGNED - # last VoIP KPI entries. (0)
Examples
voipkpid can be run in client mode to get a KPI of the last selectable number of VoIP calls.
The following fw 7.29 example has been formatted for readability, the JSON is just a sigle line:
root@fritz1:/var/mod/root# voipkpid -n 2
VoIP 1 { "sv":"gen/v1", "env":{},"kpi":{
"Profile":[{
"SIPRegistrar":"sip.example.de",
"CallStat":[{
"IP":"212.227.XXX.XXX",
"oCall":0,"iCall":1,
"tCallT":1295,
"tByteTx":64102,
"tByteRx":64097,
"aRTT":0,
"aJITx":0,
"aJIRx":3,
"aPLossTx":0,
"aPLossRx":0,
"aSDrop":0,
"aSSDrop":0,
"Codec":[{
"cTx":"G.711",
"cRx":"G.711",
"tCall":1
}],
"Phone":[{
"type":"DECT3",
"dev":"",
"tCall":1
}]
},{
"IP":"212.227.XXX.XXX",
"oCall":0,
"iCall":1,
"tCallT":62,
"tByteTx":2716,
"tByteRx":2825,
"aRTT":61,
"aJITx":0,
"aJIRx":3,
"aPLossTx":0,
"aPLossRx":0,
"aSDrop":0,
"aSSDrop":0,
"Codec":[{
"cTx":"G.711",
"cRx":"G.711",
"tCall":1
}],
"Phone":[{
"type":"IP2",
"dev":"",
"tCall":1
}]
}]
}]
}}
Besides the IPs and registrar this is anonymized data from the Voice-Quality (german Sprachqualität) log in the Webinterface.
voipkpid does not send this KPI automatically, it is subscribed to the KPI_PRE_INFORM_NOTIFY event in the AVMIPC-Datastore
by its _anony($num)-($num) or since fw 7.39 _anony-voipkpid-($num)-($num) IPC endpoint, and sends the KPI
to ctlmgr on request.
Events
Daily updated index of AVM-Events and AVMIPC-Datastore nodes affecting this command. Last update: 2023-12-10 05:13 GMT.
The owners of Event-Sinks and Event-Sources are manual research, which may be incomplete or even wrong.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
A ** in the Mod column marks info from Supportdata2 probes, which by their nature will stay way more incomplete.
A - in the Mod column marks manual research, the Firmware then shows where the item occurs, not the Relation.
| Relation | Typ | Object | Mod | Firmware | Info | Origin |
|---|---|---|---|---|---|---|
| Endpoint | sock | me_anony-voipkpid-($num)-($num).ctl | 27* | 7.08 - 7.51 | Anonymous avmipc endpoint to trigger KPI creation by voipkpid. | AVM |
| Listens to | avmipc | KPI_PRE_INFORM_NOTIFY | 17** | 7.29 - 7.51 | Trigger event to create KPI. | AVM |
| 2 event relations for this command | ||||||
Source
The names of source files compiled into an executable often help to understand function blocks (and show gaps in the docs).
fw 7.39 source files:
$ strings /bin/voipkpid | grep -e '\.c$' -e '\.cpp$' <empty>
Dependencies
Daily updated index of all dependencies of this command. Last update: 2024-12-21 07:44 GMT.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
| Relation | Typ | Object | Mod | Firmware | Info | Origin |
|---|---|---|---|---|---|---|
| Started by | serv | voipkpid.service | 35 | 7.19 - 8.00 | supervisor service for voipkpid. | AVM |
| Stopped by | serv | voipkpid.service | 35 | 7.19 - 8.00 | supervisor service for voipkpid. | AVM |
| Runs as | proc | voipkpid (process) | 32* | 7.08 - 8.00 | Process running voipkpid | AVM |
| Serving | sock | me_anony-voipkpid-($num)-($num).ctl | 32* | 7.08 - 8.00 | Anonymous avmipc endpoint to trigger KPI creation by voipkpid. | AVM |
| Depends on | lib | ld.so | 13 | 7.08 - 8.00 | Dynamic linker / loader | Linux |
| Depends on | lib | libar7cfg.so | 21 | 7.90 - 8.00 | TFFS-Configuration API to ar7.cfg and many more. | AVM |
| Depends on | lib | libavmauth.so | 35 | 7.19 - 8.00 | Fritzbox authentification helpers | AVM |
| Depends on | lib | libavmcipher.so | 21 | 7.90 - 8.00 | AES / DES / Rijndael encryption / decryption. | AVM |
| Depends on | lib | libavmcsock.so | 35 | 7.08 - 8.00 | Networking, I/O and helper functions | AVM |
| Depends on | lib | libavmfbstate.so | 28 | 7.39 - 8.00 | IPC fritzbox state notification | AVM |
| Depends on | lib | libavmhmac.so | 35 | 7.19 - 8.00 | HMAC / SHA / MD5 hashing. | AVM |
| Depends on | lib | libavmwdt.so | 22 | 7.61 - 8.00 | AVM-Watchdogs management API | AVM |
| Depends on | lib | libboxenv.so | 21 | 7.90 - 8.00 | API to the rc.conf enhanced Config-Environment | AVM |
| Depends on | lib | libboxlib.so | 35 | 7.19 - 8.00 | Box status, logging and statistics functions | AVM |
| Depends on | lib | libc.so | 35 | 7.08 - 8.00 | Standard C library | Linux |
| Depends on | lib | libcore.so | 22 | 7.61 - 8.00 | Gathers the MAC addresses of the device and maintains its device mode. | AVM |
| Depends on | lib | libcrypto.so | 28 | 7.39 - 8.00 | OpenSSL general crypto and X.509 library | Linux |
| Depends on | lib | libdl.so | 7 | 7.08 - 8.00 | Dynamic linking library | Linux |
| Depends on | lib | libdputil.so | 34 | 7.19 - 8.00 | DataPipe / packet utilities | AVM |
| Depends on | lib | libewnwjson.so | 21 | 7.90 - 8.00 | JSON helper functions | AVM |
| Depends on | lib | libewnwlinux.so | 35 | 7.08 - 8.00 | Linux networking functions | AVM |
| Depends on | lib | libewnwnet.so | 35 | 7.19 - 8.00 | Internet helper functions | AVM |
| Depends on | lib | libfbconf.so | 22 | 7.61 - 8.00 | API to hardcoded fbconf.cfg | AVM |
| Depends on | lib | libjuisclient.so | 21 | 7.90 - 8.00 | Update-Search - second generation - JUIS | AVM |
| Depends on | lib | liblocalize.so | 21 | 7.90 - 8.00 | Charset conversion helper functions | AVM |
| Depends on | lib | libm.so | 5 | 7.19 - 8.00 | C math library | Linux |
| Depends on | lib | liboauth2.so | 21 | 7.90 - 8.00 | OAuth v2.0 authentificator | Linux |
| Depends on | lib | libpthread.so | 7 | 7.08 - 8.00 | POSIX threading library | Linux |
| Depends on | lib | librt.so | 7 | 7.08 - 8.00 | POSIX realtime extensions library | Linux |
| Depends on | lib | libslab_c++.so | 21 | 7.90 - 8.00 | C++ slab allocator | AVM |
| Depends on | lib | libsvctl.so | 35 | 7.19 - 8.00 | supervisor notification library | AVM |
| Depends on | lib | libtiinterpreter.so | 28 | 7.39 - 8.00 | Preprocessor for SSI-Files by TI. | AVM |
| Depends on | lib | libvoipkpi.so | 35 | 7.19 - 8.00 | VoIP quality KPI collector for voipkpid | AVM |
| Depends on | lib | libwdt.so | 32 | 7.19 - 7.81 | AVM-Watchdogs management API | AVM |
| Depends on | lib | libwebkpiclient.so | 28 | 7.39 - 8.00 | KPI sensor for system parts which use HTTP / HTTPS | AVM |
| Depends on | lib | libwebsrv.so | 35 | 7.19 - 8.00 | HTTP / HTTPS webserver and tools. | AVM |
| Depends on | lib | libyajl.so | 35 | 7.19 - 8.00 | Event-driven JSON parser | Linux |
| Depends on | lib | libz.so | 35 | 7.19 - 8.00 | Zlib compressor / decompressor | Linux |
| 38 dependencies for this command | ||||||
Model-Matrix
Daily updated index of the presence, path and size of this command for each model. Last update: 2024-12-21 05:44 GMT.
Showing all models using this command. Click any column header (click-wait-click) to sort the list by the respective data.
The (main/scrpn/boot/arm/prx/atom/rtl) label in the Model column shows which CPU is meant for Multi-Linux models.
Note that this list is merged from Firmware-Probes of all known AVM firmware for a model, including Recovery.exe and Labor-Files.
| Model | Firmware | Path | Size |
|---|---|---|---|
| FRITZ!Box 3490 (main) | 7.27 - 7.30 | /bin | 9.9k |
| FRITZ!Box 4040 | 7.24 - 8.00 | /bin | 9.3k - 9.5k |
| FRITZ!Box 4050 | 7.58 - 7.90 | /bin | 9.4k |
| FRITZ!Box 4060 | 7.29 - 7.90 | /bin | 9.3k - 9.4k |
| FRITZ!Box 5490 (main) | 7.27 - 7.29 | /bin | 9.9k |
| FRITZ!Box 5491 (main) | 7.27 - 7.29 | /bin | 9.9k |
| FRITZ!Box 5530 Fiber (main) | 7.21 - 8.00 | /bin | 9.8k - 9.9k |
| FRITZ!Box 5590 Fiber (main) | 7.29 - 8.00 | /bin | 9.3k - 9.4k |
| FRITZ!Box 5690 Pro (main) | 7.62 | /bin | 9.4k |
| FRITZ!Box 6430 Cable (atom) | 7.29 | /bin | 9.3k |
| FRITZ!Box 6490 Cable (atom) | 7.19 - 7.51 | /bin | 9.2k - 9.3k |
| FRITZ!Box 6590 Cable (atom) | 7.19 - 7.51 | /bin | 9.2k - 9.3k |
| FRITZ!Box 6591 Cable (atom) | 7.19 - 8.00 | /bin | 9.4k - 13.6k |
| FRITZ!Box 6660 Cable (atom) | 7.19 - 8.00 | /bin | 9.4k - 13.6k |
| FRITZ!Box 6670 Cable (atom) | 7.61 - 7.90 | /bin | 13.5k - 13.6k |
| FRITZ!Box 6690 Cable (atom) | 7.28 - 7.90 | /bin | 9.4k - 13.6k |
| FRITZ!Box 6850 LTE | 7.21 - 7.90 | /bin | 9.3k - 9.8k |
| FRITZ!Box 6850 5G | 7.24 - 7.90 | /bin | 9.3k - 9.5k |
| FRITZ!Box 6890 LTE (main) | 7.21 - 7.57 | /bin | 9.8k - 9.9k |
| FRITZ!Box 6890 LTE v1 (main) | 7.21 - 7.57 | /bin | 9.8k - 9.9k |
| FRITZ!Box 6890 LTE v2 (main) | 7.21 - 7.57 | /bin | 9.8k - 9.9k |
| FRITZ!Box 7430 (main) | 7.21 - 7.31 | /bin | 9.9k |
| FRITZ!Box 7490 (main) | 7.08 - 7.51 | /bin | 9.9k - 10.0k |
| FRITZ!Box 7510 | 7.30 - 8.00 | /bin | 9.3k - 9.4k |
| FRITZ!Box 7520 | 7.21 - 8.00 | /bin | 9.3k - 9.5k |
| FRITZ!Box 7520 v2 (main) | 7.30 - 8.00 | /bin | 9.3k - 9.5k |
| FRITZ!Box 7530 | 7.19 - 8.00 | /bin | 9.3k - 9.5k |
| FRITZ!Box 7530 AX | 7.20 - 8.00 | /bin | 9.5k - 9.6k |
| FRITZ!Box 7560 (main) | 7.24 - 7.30 | /bin | 9.8k |
| FRITZ!Box 7580 (main) | 7.21 - 7.30 | /bin | 9.8k |
| FRITZ!Box 7583 (main) | 7.21 - 7.59 | /bin | 9.8k - 9.9k |
| FRITZ!Box 7583 VDSL (main) | 7.19 - 8.00 | /bin | 9.8k - 9.9k |
| FRITZ!Box 7590 (main) | 7.08 - 8.00 | /bin | 9.8k - 9.9k |
| FRITZ!Box 7590 AX (main) | 7.19 - 8.00 | /bin | 9.8k - 9.9k |
| FRITZ!Box 7690 | 7.61 - 7.90 | /bin | 9.4k |
| 35 models use this command | |||
Symbols
Daily updated index of all symbols of this command. Last update: 2024-12-21 07:44 GMT.
| Firmware | Symbol |
|---|---|
| 7.08 - 8.00 | main |
| 7.08 - 7.19 | voipkpi_deinit_dyn_library |
| 7.08 - 7.11 | voipkpi_init_dyn_library |
| 3 symbols for this command | |
