.. _voss-assurance-overview: Introduction to Insights monitoring --------------------------------------------- .. _21.1|VOSS-842: .. _21.3|EKB-12240: :bdg:`UC Monitoring` .. tip:: :ref:`use-action-search-to-navigate-automate` Overview ........... Users with both Automate and Insights deployed can enable monitoring of UC applications via the Automate Admin Portal, from an Insights Arbitrator server integrated with Automate. .. note:: For details around integrating Automate with the Insights Arbitrator server, see :ref:`voss-assurance-arbitrators` Once the integration is set up, you onboard customer server clusters, comprising one or more Cisco Unified Communication Manager (UCM) CallManager servers and/or Cisco Unity Connection (CUC) servers, to an Arbitrator server for monitoring, from within the Automate Admin Portal. The following servers are supported: * Cisco Unity Connection (CUC) servers * Cisco UCM servers Provisioning is supported for these UCM server types: * Voice (VOICE_VIDEO) * IM and Presence Service (IM_P) .. note:: The image displays a customer with four Cisco UCM servers that are part of the same cluster. The cluster is onboarded to the Arbitrator server for monitoring purposes. |cucm-server-clusters| This feature provides the following functionality in the Admin Portal: * Integrate Arbitrator servers, and view existing integrations, via the Insights **Arbitrators** page in Automate. See :ref:`voss-assurance-arbitrators` .. note:: The Arbitrator server should be at version SP23 or higher. * View currently configured monitoring set up for server clusters, if any: * For UCM servers, go to the **Servers** page (for UCM), then click on a cluster to view the following: * On the **Base** tab, view the cluster name and server type (VOICE_VIDEO or IM_P), and whether the server is a Publisher server or a Subscriber server. * On the **Publisher** tab, view monitoring details, including the monitoring Arbitrator server, if any. |cucm-server-base-tab| * For CUC servers, go to the CUC **Servers** page, then click on a cluster to view monitoring details, including the monitoring Arbitrator server, if any. * When adding new UCM or CUC server in a cluster, you can choose an Arbitrator to monitor the servers (via the Monitoring fields for Cisco Publisher servers) .. note:: At the time of writing (Automate v21.3), modifying any existing monitoring setup on UC apps is not supported. However, deleting a UC app on Automate will remove the asset and related configuration from all corresponding Insights Arbitrator servers. .. _onboarding-provisioning: Onboarding provisioning ......................... The onboarding process triggers a workflow that finds all the servers in the cluster, then provisions all required monitoring elements (which differ depending on whether the server is UCM or CUC, Publisher or Subscriber, or CUCM server type VOICE_VIDEO, or IM_P). .. note:: You can view all workflow provisioning steps via the transaction log in the Admin Portal. |CUCM-arbitrator-provisioning| The table describes the onboarding provisioning that occurs for the server types supported for Arbitrator monitoring: .. tabularcolumns:: |p{5cm}|p{10cm}| +---------------------------------+-------------------------------------------------------------+ | Server in the cluster | Onboarding Provisioning | +=================================+=============================================================+ | CUCM VOICE Publisher (PUB) | Provisioning on Arbitrator: | | | | | | 1. Creates the asset on Arbitrator. | | | 2. Adds the asset into an asset group on Arbitrator (or | | | updates the asset group if it already exists) | | | 3. Creates a credential for the server. | | | 4. Creates a server-specific probe and probe group | | | combination. | | | 5. Creates five Arbitrator monitoring profiles, which | | | define the schedule for the probe to run on | | | the asset (for example, every 5 minutes, or once a day): | | | | | | * A server-specific PERFMON CUCM group profile that | | | associates the probe and probe group combination with | | | the asset and the credential. | | | * Four profiles that associate static probes (which | | | are always on the Arbitrator) with the asset: RIS, | | | PING Monitor, Version, RTMT | | | | | | The static probes must exist on the Arbitrator for | | | Arbitrator monitoring to work. The static probes are | | | associated with new assets, using the profiles. | | | | | | Provisioning on the CallManager: | | | | | | * Creates the application user. When onboarding multiple | | | servers, you can ignore a *fail* status at this step | | | ``Create Cucm App User``, since duplicate user creation | | | is ignored. | | | * Updates service parameters | +---------------------------------+-------------------------------------------------------------+ | CUCM VOICE Subscriber (SUB) | Provisioning on Arbitrator: | | | | | | 1. Creates the asset on Arbitrator. | | | 2. Adds the asset into an asset group on Arbitrator (or | | | updates the asset group if it already exists) | | | 3. Creates a credential for the server. | | | 4. Creates one Arbitrator monitoring profile (ping test | | | only). | +---------------------------------+-------------------------------------------------------------+ | CUCM IM_P Publisher (PUB) | Provisioning on Arbitrator: | | | | | | 1. Creates the asset on Arbitrator. | | | 2. Adds the asset into an asset group on Arbitrator (or | | | updates the asset group if it already exists) | | | 3. Creates a credential for the server. | | | 4. Creates a server-specific probe and probe group | | | combination. | | | 5. Creates two Arbitrator monitoring profiles, which | | | define the schedule for the probe to run on | | | the asset (for example, every 5 minutes, or once a day): | | | | | | * A server-specific PERFMON CUCM group profile that | | | associates the probe and probe group combination with | | | the asset and the credential. | | | * A PING Monitor profile | +---------------------------------+-------------------------------------------------------------+ .. tabularcolumns:: |p{5cm}|p{10cm}| +---------------------------------+-------------------------------------------------------------+ | Server in the cluster | Onboarding Provisioning | +=================================+=============================================================+ | CUCM IM_P Subscriber (SUB) | Provisioning on Arbitrator: | | | | | | 1. Creates the asset on Arbitrator. | | | 2. Adds the asset into an asset group on Arbitrator (or | | | updates the asset group if it already exists) | | | 3. Creates a credential for the server. | | | 4. Creates one Arbitrator monitoring profile (ping test | | | only). | +---------------------------------+-------------------------------------------------------------+ | CUC Publisher (PUB) | View the transaction and sub-transaction log for details. | +---------------------------------+-------------------------------------------------------------+ | CUC Subscriber (SUB) | View the transaction and sub-transaction log for details. | +---------------------------------+-------------------------------------------------------------+ For details, see :ref:`concepts-onboard-voss-assurance-assets` .. note:: All provisioned elements can be viewed on the Insights Arbitrator dashboard. For details, see the Insights documentation. |arbitrator-provisioning-dashboard| .. _probe-names-profile-timings: Probe groups, profiles, and asset onboarding .................................................. The table describes the probe groups and profiles that are added to the Insights Arbitrator server when assets are onboarded, and removed when assets are off-boarded. .. tabularcolumns:: |p{4cm}|p{11.5cm}| +----------------------------+------------------------------------------------------------+ | PERFMON CUCM Group Profile | +============================+============================================================+ | Probe name | ``axlGetPerfmonCounters_CUCM_INTF ()`` | +----------------------------+------------------------------------------------------------+ | Probe Group Name | ``-CUCM Perfmon AXL ()`` | +----------------------------+------------------------------------------------------------+ | Frequency | 600 sec (10 min) | +----------------------------+------------------------------------------------------------+ | For Publisher Server | Yes | +----------------------------+------------------------------------------------------------+ | For Subscriber Server | No | +----------------------------+------------------------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11.5cm}| +----------------------------+------------------------------------------------------------+ | PERFMON CUC Group Profile | +============================+============================================================+ | Probe name | ``axlgetperfmon ()`` | +----------------------------+------------------------------------------------------------+ | Probe Group Name | ``-Cisco Unity AXL ()`` | +----------------------------+------------------------------------------------------------+ | Frequency | 300 sec (5 min) | +----------------------------+------------------------------------------------------------+ | For Publisher Server | Yes | +----------------------------+------------------------------------------------------------+ | For Subscriber Server | No | +----------------------------+------------------------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11.5cm}| +-----------------------+-----------------------------------------------------------+ | RIS Group Profile | +=======================+===========================================================+ | Probe Group Name | ``1-Cisco CUCM RIS CmDevice_creds`` | +-----------------------+-----------------------------------------------------------+ | Frequency | 300 sec (5 min) | +-----------------------+-----------------------------------------------------------+ | For Publisher Server | Yes | +-----------------------+-----------------------------------------------------------+ | For Subscriber Server | No | +-----------------------+-----------------------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11.5cm}| +-----------------------+---------------------+ | PINGMON Group Profile | +=======================+=====================+ | Probe Group Name | ``1b-PING Monitor`` | +-----------------------+---------------------+ | Frequency | 300 sec (5 min) | +-----------------------+---------------------+ | For Publisher Server | Yes | +-----------------------+---------------------+ | For Subscriber Server | Yes | +-----------------------+---------------------+ .. tabularcolumns:: |p{4cm}|p{11.5cm}| +-----------------------+--------------------------+ | VERSION Group Profile | +=======================+==========================+ | Probe Group Name | ``4-Cisco CUCM Version`` | +-----------------------+--------------------------+ | Frequency | 86400 sec (24 hr) | +-----------------------+--------------------------+ | For Publisher Server | Yes | +-----------------------+--------------------------+ | For Subscriber Server | No | +-----------------------+--------------------------+ .. tabularcolumns:: |p{4cm}|p{11.5cm}| +-----------------------+-------------------+ | RTMT Group Profile | +=======================+===================+ | Probe Group Name | ``5-Cisco RTMT`` | +-----------------------+-------------------+ | Frequency | 1800 sec (30 min) | +-----------------------+-------------------+ | For Publisher Server | Yes | +-----------------------+-------------------+ | For Subscriber Server | No | +-----------------------+-------------------+ Offboarding assets .................... Should you wish to disable monitoring and remove data from the Arbitrator server, you can offboard these assets (and their related configuration) from the Arbitrator server. For details see :ref:`concepts-offboard-voss-assurance-assets` .. |cucm-server-clusters| image:: /src/images/cucm-server-clusters.png .. |cucm-server-base-tab| image:: /src/images/cucm-server-base-tab.png .. |cucm-arbitrator-provisioning| image:: /src/images/cucm-arbitrator-provisioning.png .. |arbitrator-provisioning-dashboard| image:: /src/images/arbitrator-provisioning-dashboard.png