NethVoice: metrics to be stored

[andrea-marchionni]

Description:
To improve observability, troubleshooting, and resource planning, NethVoice monitoring should be extended to track both usage and configuration metrics across installations. This will provide greater visibility into how NethVoice is deployed and used in real-world environments, supporting better product decisions and customer support.

Metrics to be collected

Installations & Infrastructure

• Number of installations of NethVoice Proxy
• Community or subscription installation
• Number of NethVoice per nodes

Users & Accounts

• Number of users configured per NethVoice instance
• User domain location: internal/external
• User domain type: ad/openldap

Telephony & Routing

• Number of VoIP trunks added (with trunk type)
• Number of physical gateways configured
• Number of incoming routes
• Number of outbound routes

CTI & Devices

• Number of NethVoice CTI profiles used
• Number of groups
• Number of users with NethVoice CTI configured
• Number of physical phones added (with model/type)
• Number of custom devices configured
• Number of Web Phones added

Apps & Integrations

• Number of NethVoice Apps configured and active
• Number of NethLink instances configured and active
• Number of customer cards configured
• Number of streaming sources configured
• Number of parameterized URLs configured
• Number of Phone lines and announcements configured

Call Handling Features

• Number of IVRs configured
• Number of CQRs configured
• Number of queues configured
• Number of ring groups configured

Applications

• NethVoice Hotel module enabled/disabled

AI

• AI call transcription
• AI voicemail transcription
• AI call summary status

Usage Metrics

• Daily call volume
• Total calls processed

[gsanchietti]

Test commands

Install fresh:

api-cli add-module ghcr.io/nethesis/nethvoice:pr-870.242-1.c69e3d0

Update existing:

api-cli run update-module --data '{"module_url":"ghcr.io/nethesis/nethvoice:pr-870.242-1.c69e3d0","instances":["nethvoice1"],"force":true}'

Test case 1

Verify facts collection:

api-cli run module/nethvoice1/get-facts

Output example:

{"nethvoice_users_count": 2, "nethvoice_trunks_count": 0, "nethvoice_inbound_routes_count": 1, "nethvoice_outbound_routes_count": 4, "nethvoice_ivr_count": 0, "nethvoice_queues_count": 1, "nethvoice_ringgroups_count": 0, "nethvoice_cqr_count": 0, "nethvoice_trunks_by_tech": {}, "nethvoice_calls_last_24h": 0, "nethvoice_total_calls": 6, "nethvoice_cti_profiles_count": 3, "nethvoice_cti_groups_count": 1, "nethvoice_cti_users_count": 2, "nethvoice_streaming_count": 0, "nethvoice_paramurl_count": 0, "nethvoice_announcements_count": 0, "nethvoice_offhour_count": 1, "nethvoice_customer_cards_count": 2, "nethvoice_nethlink_active_count": 0, "nethvoice_devices_count": 2, "nethvoice_devices_by_type": {"webrtc": 2}, "nethvoice_physical_devices_by_vendor": {}, "nethvoice_physical_devices_by_model": {}, "nethvoice_hotel_enabled": false, "nethvoice_ai_call_summary_enabled": false, "nethvoice_ai_call_transcription_enabled": false, "nethvoice_ai_voicemail_transcription_enabled": false, "nethvoice_subscription_enabled": false, "nethvoice_user_domain_type": "rfc2307", "nethvoice_user_domain_location": "internal", "nethvoice_trunks_by_provider": {}}

Verify phonehome merge:

runagent print-phonehome | jq '.facts.modules[]|select(.module=="nethvoice")'

Test case 2

fter upgrade, execute runagent print-phonehome returns info about associated user domain, check for user_domain field.

Output example:

# runagent print-phonehome | jq '.facts.modules[]|select(.module=="nethvoice")'
...
  "user_domains": [
    "a002d23c.net"
  ],
...
}