Monitoring Cisco Unified Presence, Release 8.6
Performance counters
Downloads: This chapterpdf (PDF - 2.09MB) The complete bookPDF (PDF - 3.32MB) | Feedback

Performance counters

Contents

Performance counters

Monitor performance counters using Unified Operations Manager

Unified Operations Manager 8.6 and 8.7 allows the monitoring of the following counters on Cisco Unified Presence Service 8.6.4 and earlier:

  • Cisco UP Presence Engine > Active IM Sessions as Active IM Sessions
  • Cisco UP XCP JSM > JsmLoginRate as Login Rate
  • Cisco UP XCP JSM > JsmOnlineUsers as Online Users
  • Cisco UP XCP CM > CmConnectedSockets as Total XMPP client connections

Monitor performance counters using Unified RTMT

All Cisco Unified Presence counters are monitored in Unified RTMT through the Performance menu item, under the System tools:

Figure 1. Real Time Monitoring Tool window



Using Unified RTMT it is possible to create custom alerts based on the values of any Performance Counter. The following procedure is an example of creating a custom alert for Cisco UP SIP Proxy – NumIdleSipdWorkers.

Procedure
    Step 1   Select Performance from the Performance menu item in Unified RTMT.
    Step 2   Double-click the NumIdleSipdWorkers counter.
    Step 3   Select the counter graph in the main Unified RTMT pane.
    Figure 2. Counter graph



    Step 4   Right-click, select Set Alert/Properties

    The Alert Properties: General window opens.

    Figure 3. Alert Properties: General window



    Step 5   Ensure the Enable Alert check box is checked.
    Step 6   In the Description field, enter a brief description for the alert.
    Step 7   In the Recommended Action field, enter a brief action for the alert.
    Step 8   Choose a severity from the Severity drop-down menu.
    Step 9   Click Next.

    The Alert Properties: Threshold & Duration window opens.

    Figure 4. Alert Properties: Threshold & Duration window



    Step 10   In the Threshold field, specify the alerting threshold for the counter.
    Step 11   In the Value Calculated As field, specify how this threshold is calculated.
    Step 12   In the Duration field, specify duration of time that the counter value must be above or below the specified threshold before the alert is triggered.
    Note   

    Cisco recommends that on Cisco Unified Presence this counter should not remain below a value of 5 for a period of 60 minutes (or 3600 seconds). For more details about this counter, see the List of Recommended Performance Counters.

    Step 13   Click Next.

    The Alert Properties: Frequency & Schedule window opens.

    Figure 5. Alert Properties: Frequency & Schedule window



    Step 14   In the Frequency field, specify the amount of times the custom alert is triggered. The default is:

    "Trigger alert on every poll."

    Step 15   In the Schedule field, specify when the alert is triggered. The default is:

    "Trigger Alert when it occurs (Non-Stop Monitoring)."

    Step 16   Click Next

    The Alert Properties: Email Notification window opens.

    Figure 6. Alert Properties: Email Notification window



    Step 17   To receive email notifications, ensure the Enable Email check box is checked.
    Note   

    If you do not wish to receive email notifications, uncheck the Enable Email check box and proceed to Step 20.

    Step 18   In the Trigger Alert Action field, use the drop-down menu to select the profile this alert will use.
    Step 19   In the User-defined email text field, enter a brief message for the alert.
    Step 20   Click Save.

    Archive performance counters in Unified RTMT

    The Trace and Log Collection tool in Unified RTMT collects and pushes Perfmon Counter CSV files out to an external server. The following procedure describes how to archive Perfmon Counter CSV files using Cisco RIS Data Collector PerfMon Log.
    Procedure
      Step 1   Open Trace and Log Collection.
      Step 2   Double-click Schedule Collection. The Schedule Collection window opens to the Select System Services/Applications table.
      Figure 7. Schedule Collection window



      Step 3   Choose the Cisco RIS Data CollectorPerfMon Log service.
      Step 4   To download the PerfMon logs:
      From... ... take this action:
      All nodes in the cluster Check All Servers.
      A single node Select the node name.
      Step 5   Choose Next. The Schedule Collection Options window opens.
      Figure 8. Schedule Collection Options window



      Step 6   In the Schedule Options field, configure the following drop-down menus, as desired:
      • Select task Server Time Zone
      • Schedule Start Date/Time
      • Schedule End Date/Time
      • Scheduler Frequency
      • Collect Files generated in the last
      Step 7   In the Action Options field, check the Download Files check box. The Trace Download Configuration window opens.
      Figure 9. Trace Download Configuration window



      Step 8   Choose the archive location for the PerfMon logs. The default is Localhost.
      Note   

      When choosing an SFTP/FTP server, you must choose Test Connection to ensure your setup is correct.

      Step 9   Click OK. The Trace Download Configuration window closes.
      Step 10   Click Finish. The Schedule Collection window closes.


      Note


      You can find the CSV files by navigating down the directory structure to cm/log/ris/csv.  This unusual directory structure is necessary as it is possible to use Unified RTMT to archive many different logs in one query. It is possible to use Trace and Log collection to archive every log the server generates. Each log will have its own specific path for the sake of organization.


      List of recommended performance counters

      Client connections

      WebCMConnectedSockets

      The WebCMConnectedSockets performance counter in the Cisco UP XCP WebCM folder contains the current number of CAXL web clients that are connected to the Cisco UP XCP Web Connection Manager on an individual Cisco Unified Presence server. This number rises and falls based on the usage patterns of your deployment. Further investigation may be required if this number is higher than expected for your user base.

      ConnectedSockets

      The ConnectedSockets performance counter in the Cisco UP XCP CM folder contains the current number of XMPP clients that are connected to the Cisco UP XCP Connection Manager on an individual Cisco Unified Presence server. This number rises and falls based on the usage patterns of your deployment. Further investigation may be required if this number is higher than expected for your user base.

      Database

      CcmDbSpace_Used

      The Database Space Used performance counter contains the percentage of ccm dbspace used. Monitor this counter for an indication of when you will run out of database space.

      ReplicationQueueDepth

      The Replication Queue Depth performance counter contains the replication queue depth. A high value is an indication of replication issues.

      Replicate_state

      The Replication Status performance counter represents the current state of database replication. This is applicable for multinode Cisco Unified Presence Distributions. It has five potential values:
      0
      Initializing. The counter equals 0 when the server is not defined or when the server is defined but the realize template has not completed.
      1
      The system that is created replicates of some tables but not all tables. Cisco recommends that you run utils dbreplication status on the CLI to determine the location and cause of the failure.
      2
      Replication is good, replication is set up correctly, and most of the tables in the database should be in sync for all nodes of the cluster.
      3
      Bad replication. When the counter displays a value of 3, consider replication in the cluster as bad. It does not mean that replication failed on a particular node. Cisco recommends that you run utils dbreplication status on the CLI to determine the location and cause of the failure.
      4
      Replication set up did not succeed.

      Instant messaging

      JsmMsgsInLastSlice

      The total number of IM packets handled by the Cisco Unified Presence node across all users in the past 60 seconds. This counter is reset to zero every 60 seconds. The same rules for counting IM packets apply as for TotalMessagePackets. Monitoring of this counter helps identify the busy IM hours in your organization.

      JsmSessionMessagesOut

      The IM Packets received per session performance counter contains the total number of IMs that are sent by the user from the user's IM client or session. Note that the term SessionMessagesIn is defined from the perspective of Cisco Unified Presence: the IM packet that was sent by the client is an inbound IM packet to Cisco Unified Presence. On large deployments of Cisco Unified Presence there can be many instances of this counter, and viewing individual counters in Unified RTMT can be time consuming. To get a long list of the value of this counter for every user on Cisco Unified Presence, use the CLI command:

      show perf query counter "Cisco XCP JSM Session Counters" JsmSessionMessagesOut

      JsmTotalMessagePackets, JsmMsgsInLastSlice, JsmSessionMessagesIn and JsmSessionMessagesOut each represent instant message packets being sent to Cisco Unified Presence and are not exact figures of Instant Messages on the system. The amount of IM packets that are sent to Cisco Unified Presence per IM can vary depending on the client in use.

      Example
      If Alice and Bob are both using Cisco Unified Personal Communicator 8.5, when Alice sends Bob a single instant message, Cisco Unified Personal Communicator 8.5 will send to Cisco Unified Presence:
      • A composed packet to indicate Alice is typing a new message.
      • The instant message packet containing the message body.
      • A paused packet to indicate the end of the communication.

      In this scenario JSM counters will increment by three.

      JsmSessionMessagesIn

      The IM Packets sent per session performance counter counts the total number of IM packets that are sent to the user on the user's IM client or session. Note that the term SessionMessagesOut is defined from the perspective of Cisco Unified Presence: the IM packet is sent to the client and is an outbound IM packet from Cisco Unified Presence. On large deployments of Cisco Unified Presence there can be many instances of this counter, and viewing individual counters in Unified RTMT can be time consuming. To get a long list of the value of this counter for every user on Cisco Unified Presence use the CLI command:

      show perf query counter "Cisco XCP JSM Session Counters" JsmSessionMessagesIn

      JsmIMSessions

      The Number of IM Sessions performance counter contains the total number of IM sessions on the Cisco Unified Presence node across all users. The Cisco UP Presence Engine, which provides presence composition services and rich, always-on network presence, creates an IM session on behalf of all users at Presence Engine (PE) startup time. This is necessary so that network presence events such as Cisco Unified Communications Manager Telephony Presence and Exchange Calendar notifications are reflected in a user’s presence even if that user is not logged in on any of their IM clients. Every licensed user that is assigned to a Cisco Unified Presence node will have one IM Session for PE rich presence composition in addition to one IM Session for any logged-in clients.

      Example

      If:

      • 100 licensed users are assigned to the Cisco Unified Presence node.
      • 50 users are not logged in.
      • 40 users are logged in on one IM client.
      • 10 users are logged in on two IM clients.
      Then IM Sessions will total 160:
      • 100 x 1 for rich Presence Engine sessions, plus
      • 40 x 1 for users logged in on a single client, plus
      • 10 x 2 for users logged in on two clients

      Cisco UP XCP JSM Session Counters

      The Per User/Per Session counters exist only for the duration of an IM session or user login. One set of these counters exists per Presence Engine network presence session, and one set of these counters exists per client login session. In the example given above for IM Sessions, 160 different sets of Cisco UP XCP JSM Session Counters would exist. When a user logs out, or when the Cisco UP Presence Engine is stopped, the associated Cisco UP XCP JSM Session Counters instance is deleted.


      Note


      On versions earlier than Cisco Unified Presence 8.6.2 there was an issue where Session counters were not correctly deleted. This resulted in extra Session Counter instances.


      Administrators can use these counters to get a snapshot of all users that are currently logged in. These can be accessed by entering the following command on the CLI:

      show perf list instances "Cisco XCP JSM Session Counters"

      Every user that is assigned to an Cisco Unified Presence node that is logged in to the system will have a set of JSM session counters for their current logged-in client session and also their Presence Engine network session. On a Cisco Unified Presence node with 5000 users logged in, this would result in a minimum of 10,000 sets of JSM Session counters. Updating these counters with new values as they change would place the system under stress. To combat this problem, JSM Session counter values are cached locally by the system and are only updated to Unified RTMT every 30 minutes.

      JsmTotalMessagePackets

      The Total IM Packets performance counter gives the total number of IM packets that are handled by the Cisco Unified Presence node across all users.

      Example

      If user Alice sends an IM packet to user Bob, and both users are assigned to the same Cisco Unified Presence node, then this IM packet will be counted twice. This is because The Cisco UP XCP Router and Jabber Session Manager treat the two users separately. For example, Alice’s privacy rules will be applied to the IM packet before it is delivered to Bob, and then Bob’s privacy rules will be applied to the IM packet before it is delivered to Bob’s client. Whenever Cisco Unified Presence handles an IM packet, it is counted once for the originator and once for the terminator.

      If Alice and Bob are assigned to different Cisco Unified Presence nodes and Alice sends an IM packet to Bob, then the IM packet will be counted once on Alice’s node and once on Bob’s node.

      Presence

      ActiveCalendarSubscriptions

      The Number of Active Calendar Subscriptions performance counter contains the number of calendar subscriptions that are currently active on the box.

      ActiveJsmSessions

      The Number of Active JSM Sessions performance counter contains the number of client emulation sessions between the Cisco UP Presence Engine and Cisco UP XCP Router. The value of this counter should always equal the number of licensed users on the box.

      SIP federation

      SIPS2SSubscriptionsIn

      The Number of Active Inbound SIP Subscriptions performance counter contains the current number of active inbound SIP Subscriptions that are maintained by the Cisco UP XCP SIP Federation Connection Manager service on the Cisco Unified Presence server. Monitor this counter if the Cisco Unified Presence server is configured for SIP Interdomain Federation or SIP Intradomain Federation.

      The total combined count of SubscriptionsOut and SubscriptionsIn must not rise above 260,000 on any single Cisco Unified Presence server.

      SIPS2SSubscriptionsOut

      The Number of Active Outbound SIP Subscriptions performance counter contains the current number of active outgoing SIP Subscriptions being maintained by the Cisco UP XCP SIP Federation Connection Manager service on the Cisco Unified Presence server. Monitor this counter if Cisco Unified Presence server is configured for SIP Interdomain Federation or SIP Intradomain Federation.

      The sum of the values of the SubscriptionsOut and SubscriptionsIn performance counters must not rise above 260,000 on any single Cisco Unified Presence server.

      NumIdleSipdWorkers

      The Number of Idle SIP Proxy Worker Processes performance counter contains the current number of idle/free SIP worker processes on the Cisco Unified Presence SIP Proxy. This counter gives a good indication of the load being applied to the Cisco UP SIP Proxy on each Cisco Unified Presence server. Monitor this counter if Cisco Unified Presence server is configured for SIP Interdomain Federation or SIP Intradomain Federation.

      The number of idle processes can drop to zero on occasion and is not a cause for concern. However, if the number of idle processes is consistently below five processes, then it is an indication that the Cisco Unified Presence Server is being heavily loaded and requires further investigation.

      SIPInviteRequestIn

      The Number of INVITE Requests Received performance counter is a cumulative count of the number of SIP INVITE requests arriving into the Cisco UP SIP Proxy service since the service was last started. Depending on the Role of the Cisco Unified Presence server, these SIP INVITE requests can come from multiple sources:
      • On a Routing Cisco Unified Presence server this count captures outbound INVITE requests to federated SIP contacts from Cisco Unified Presence users.
      • On an Cisco Unified Presence server with users provisioned, this count captures:
        • All inbound INVITEs from federated SIP contacts to users that are provisioned on the Cisco Unified Presence server.
        • All outbound INVITEs to federated SIP contacts from users that are provisioned on the Cisco Unified Presence server.
        • All outbound INVITEs to local SIP clients from users that are provisioned on the Cisco Unified Presence server.

      SIPMessageRequestIn

      The Number of MESSAGE Requests Received performance counter is a cumulative count of the number of SIP MESSAGE requests arriving into the Cisco UP SIP Proxy since the service was last started. This is useful on the Routing Cisco Unified Presence server in terms of understanding the rate of IMs that are associated with SIP and federated SIP conversations. Depending on the role of the Cisco Unified Presence server, these SIP MESSAGE requests can come from multiple sources.

      • On a Routing Cisco Unified Presence server this count captures outbound MESSAGE requests to federated SIP contacts from Cisco Unified Presence users.
      • On an Cisco Unified Presence server with users provisioned, this count captures:
        • All inbound MESSAGE requests from federated SIP contacts to users that are provisioned on the Cisco Unified Presence server.
        • All outbound MESSAGE requests to federated SIP contacts from users that are provisioned on the Cisco Unified Presence server.
        • All outbound MESSAGE requests to local SIP clients from users that are provisioned on the Cisco Unified Presence server.

      SIPNotifyRequestIn

      The Number of NOTIFY Requests Received performance counter is a cumulative count of the number of SIP NOTIFY requests arriving into the Cisco UP SIP Proxy service since the service was last started. Depending on the role of the Cisco Unified Presence server, these SIP NOTIFY requests can come from multiple sources:
      • On a Routing Cisco Unified Presence server this count captures Outbound NOTIFY to federated SIP contacts from Cisco Unified Presence users.
      • On an Cisco Unified Presence server with users provisioned, this count captures:
        • All inbound NOTIFY requests from federated SIP contacts to users that are provisioned on the Cisco Unified Presence server.
        • All outbound NOTIFY requests to federated SIP contacts from users that are provisioned on the Cisco Unified Presence server.
        • All outbound NOTIFY requests to local SIP clients from users that are provisioned on the Cisco Unified Presence server.

      SIPS2SInviteIn

      The Number of SIP INVITE Messages Received performance counter is a cumulative total of the number of SIP INVITE messages that were received by the Cisco UP XCP SIP Federation Connection Manager service since the service was last started. A SIP INVITE message arrives from each IM conversation that is initiated by a federated SIP user. So this count equates to the number of inbound IM conversations that were established since the Cisco UP XCP SIP Federation Connection Manager was last started.

      SIPS2SInviteOut

      The Number of SIP INVITE Messages Sent performance counter contains the total number of SIP INVITE messages that were sent out by the Cisco UP XCP SIP Federation Connection Manager since the service was last started. A SIP INVITE message is sent out for each IM conversation that is initiated by a Cisco Unified Personal Communicator user to a federated SIP user. So this count equates to the number of outbound IM conversations that were established since the Cisco UP XCP SIP Federation Connection Manager was last started.

      Number of SIP MESSAGES Received (Cisco UP XCP SIP S2S - SIPS2SMessagesIn)

      The Number of SIP MESSAGES Received performance counter contains the total number of SIP MESSAGE packets that were received by the Cisco UP XCP SIP Federation Connection Manager service since the service was last started. Each Instant Message is sent in a SIP MESSAGE packet. So this count equates to the number of inbound IMs since the Cisco UP XCP SIP Federation Connection Manager was last started.

      SIPS2SMessagesOut

      The Number of SIP MESSAGES Sent performance counter contains the total number of SIP MESSAGE packets that were sent out by the Cisco UP XCP SIP Federation Connection Manager since the service was last started. Each Instant Message is sent in a SIP MESSAGE packet. So this count equates to the number of inbound IMs since the Cisco UP XCP SIP Federation Connection Manager was last started.

      SIPS2SNotifyIn

      The Number of SIP NOTIFY Messages Received performance counter contains the total number of SIP NOTIFY messages that were received by the Cisco UP XCP SIP Federation Connection Manager service since the service was last started.

      SIPS2SNotifyOut

      The Number of SIP NOTIFY Messages Sent performance counter contains the total number of SIP NOTIFY messages that were sent out from the Cisco UP XCP SIP Federation Connection Manager service since the service was last started.

      SIPSubscribeRequestIn

      The Number of SUBSCRIBE Requests Received performance counter contains the total number of SIP SUBSCRIBE requests arriving at the Cisco UP SIP Proxy service since the service was last started. This counter captures all SUBSCRIBE requests, including refresh SUBSCRIBE requests (sent every 2 hours to keep a SIP Subscription alive) and unSUBSCRIBE requests (to terminate the subscription). Depending on the role of the Cisco Unified Presence server, these SIP SUBSCRIBE requests can come from multiple sources.

      • On a Routing Cisco Unified Presenceserver, this count captures outbound SUBSCRIBE requests to federated SIP contacts from Cisco Unified Presence users.
      • On an Cisco Unified Presence server with users provisioned, this count captures:
        • All inbound SUBSCRIBE requests from federated SIP contacts to users that are provisioned on the Cisco Unified Presence server.
        • All outbound SUBSCRIBE requests to federated SIP contacts from users that are provisioned on the Cisco Unified Presence server.
        • All outbound SUBSCRIBE requests to local SIP clients from users that are provisioned on the Cisco Unified Presence server.

      Sip_Tcp_Requests

      The Number of TCP Requests Received performance counter contains a time-sliced count of the number of generic SIP packets arriving per second at the Cisco UP SIP Proxy over TCP connections, regardless of type. This includes any SIP requests (SUBSCRIBE/INVITE/MESSAGE/NOTIFY/INFO, etc.) and any SIP responses (100: Trying, 200: OK, 404: Not Found, etc.). You can use it to check for spikes in activity on the Cisco Unified Presence SIP Proxy.

      Text conferencing

      TCRoomMsgPacketsRecv

      The IMs received per room performance counter contains the number of IMs that are received by the room. On large deployments of Cisco Unified Presence there can be many instances of this counter, and viewing individual counters in Unified RTMT can be time consuming. To get a long list of the value of this counter for every user on Cisco Unified Presence, use the CLI command:

      show perf query counter "Cisco XCP TC Room Counters" TCRoomMsgPacketsRecv

      TCRoomNumOccupants

      The Number of occupants per room performance counter contains the current number of occupants of the chat room. For Persistent Chat rooms, monitoring the Number of occupants per room performance counter will give an indication of the room's usage trend. On large deployments of Cisco Unified Presence there can be many instances of this counter and viewing individual counters in Unified RTMT can be time consuming. To get a long list of the value of this counter for every user on Cisco Unified Presence use the CLI command:

      show perf query counter "Cisco XCP TC Room Counters" TCRoomNumOccupants

      It is possible to have a maximum of 16,500 Text Conferencing rooms on a Cisco Unified Presence node. Each of these rooms will have its own set of Per Chat Room counters. In a similar fashion to JSM Session counters, updating these with new values as they change would place the system under stress. To reduce the stress, Per Chat Room counter values are cached locally by the system and only updated to Unified RTMT every 30 minutes.

      Cisco UP XCP TC Room Counters

      Per Chat Room performance counters only exist for the lifetime of a chat room. For ad hoc chat rooms, these counter instances will be destroyed when the ad hoc chat room is destroyed. For persistent chat rooms, the counter instances will also be destroyed when the persistent chat room is destroyed; however, persistent chat rooms are long lived, so they should rarely be destroyed.

      Per Chat Room counters can be used to monitor the usage and participants in persistent (and ad hoc) chat rooms over their lifetime and can help identify persistent chat rooms that are no longer being used frequently.

      Administrators can use Per Chat Room counters to get a snapshot of all rooms that are currently hosted on the node. These can be accessed by using the following CLI command:

      show perf list instances "Cisco XCP TC Room Counters"

      TcAdHocRooms

      The Total ad hoc Group Chat Rooms performance counter contains the total number of ad hoc chat rooms that are currently hosted on the node. Note that ad hoc chat rooms are automatically destroyed when all users leave the room, so this counter should rise and fall in value regularly.

      TcPersistentRooms

      The Total Persistent Chat Rooms performance counter contains the total number of persistent chat rooms hosted on the node. Persistent chat rooms must be explicitly destroyed by the room owner. This counter can be monitored to identify if the total number of persistent chat rooms is very large and also to help identify if some persistent chat rooms are not being used regularly anymore.

      TcTotalRooms

      The Total Text Conferencing Rooms performance counter contains the total number of Text Conferencing rooms that are hosted on the node. This includes both ad hoc rooms and persistent chat rooms.