Xuc & Xucmgt (CC & UC applications)

XUC overview page

XUC overview page available at @XUC_IP:PORT, usually @SERVER_IP:8090. You have to check if the “Internal configuration cache database” contains agents, queues etc.

XUC sample page

XUC sample page available at @XUC_IP:PORT/sample, usually @SERVER_IP:8090/sample. You can use this page to check user login and other API functions. CCManager, agent and assistant web use functions available on the sample page.

XUC Internal Metrics

Internal metrics are also available - see XUC Internal Metrics page.

Agent states after XUC restart

Please see the note in restarting XUC server with active calls.

Queue created

New queue will not appear immediately in CCAgent and CCManager until the agent or the manager is not relogged to these applications accordingly. The Xuc server restart is not required.

Queue deleted

Deleted queue will still appear in CCAgent and CCManager until the Xuc server is restarted.

Audio quality issues

If something goes wrong with the quality of an ongoing call, it will be reflected in live, every 20 seconds, inside the xuc server logs, with the following format:

WARN  s.ClientLogger- [userw] 1590da900aba2a761573c0493c04a0a1@192.168.56.2:5060 Audio quality issues ->  RTT 186ms - Jitter upstream 1ms / downstream 0ms - Packet loss upstream 21% / downstream 6%

At the end of each call, a call quality report will also be sent in the xuc server logs, with the following format:

INFO  s.ClientLogger- [userw] 1590da900aba2a761573c0493c04a0a1@192.168.56.2:5060 Call quality report -> Highest RTT 186ms - Highest Jitter upstream 3ms / downstream 3ms - Highest Packet loss upstream 21% / downstream 12%

Both those format include the user as well as the sip call id, so it can be grepped. It can also be grepped by the type of message, “Audio quality issues” and “Call quality report”.

Audio quality visualisation

When needed, a dedicated module can be setup to allow graphical representation of those data. See the following section for more details.

Activation

On XiVO PBX:

  1. In /var/lib/postgresql/15/data/pg_hba.conf add rights for following users on specific tables (replace the <XUC_IP> with the IP of VM where xuc is running):

    HOST  call_quality_stats    rografana   <XUC_IP>/32    md5
HOST  call_quality_stats    rwfluent    <XUC_IP>/32    md5

  2. Add the service in file /etc/docker/xivo/docker-xivo.grafana.yml to /etc/docker/xivo/docker-xivo.override.yml.

  3. And finally run:

    xivo-dcomp reload db
xivo-dcomp up -d

On XiVO CC / UC Addon:

  1. Add the service in file /etc/docker/compose/docker-xivocc.fluentd.yml to /etc/docker/xivo/docker-xivocc.override.yml.

  2. And then run:

    xivocc-dcomp up -d

Usage

When audio quality visualisation activation step is done.

You can access grafana web page via:

https://<XIVO_IP>:3000/

Replace the <XIVO_IP> with the IP of your Xivo PBX.

Dashboard view :

../../../_images/grafana.png

On grafana dashboard you can:

  1. Select user that you want to display thank to the users_list parameter

  2. Zoom out by pressing CRTL+Z or by clicking on the magnifier

Warning

All the added dashboards will not be saved in case of update.

Xuc CLI

The xuc CLI is a small terminal tool that allows you to retrieve a bit of informations on the state of xuc internal tracking mechanics. You can compare them with your Asterisk state and clean them up if needed, which can troubleshoot some issues in production without the need to restart xuc.

The main command is the following : xivocc-dcomp exec xuc bin/xuc-cli

This command allows you to list the available command submodules and typing the command with one of those submodule allows you to list the available actions or run the command directly.

Here is a sum up of everything available (you need the xivocc-dcomp part mentionned above in front of each command) :

  • getversion: Prints xuc version

  • starttime: Prints xuc start time

  • info: Prints start time, version, and agent / users available in xuc internal repository

  • mds YOURMDS: Prints AMI infos and connectivity of YOURMDS (replace with the technical name of your mds)

  • siptracker YOURCONTACTID info: Prints infos of YOURCONTACTID (replace with the contact name of your choice, retrieved from asterisk)

  • siptracker YOURCONTACTID clearcalls: Clear the list of calls that is tracked internally by xuc. Can be used to fix ghost call and stuck transfert issues

  • siptracker YOURCONTACTID stop: Stops the xuc internal call tracker for this specific contact. The user will need to refresh his assistant to initialize a clean one