Get (Performance Information)

Gets information about the performance counters in the system.

URL:

https://<ServerIP>:<Port>/sm-dp/rest/DiagnosticPortal/GetPerformanceInformation

HTTPS method:

GET

Elements:

xmlns: XML namespace "dp" defined for Diagnostic Portal specific elements to avoid naming errors.

Schema Version: This element is defined for tracking the version.

The performance API retrieves information in the form of "Property Name" and "Value" for each of the following categories:

systemInfo:

The following counters are retrieved for the system services such as Runtime, XMPP, Webapp, Indexer, and Datastore:

  • System/Available Processors
  • System/Committed Virtual Memory Size
  • System/Free Physical Memory Size
  • System/Free Swap Space Size
  • System/Max File Descriptor Count
  • System/Open File Descriptor Count
  • System/Process Cpu Time
  • System/System Load Average
  • System/Total Physical Memory Size
  • System/Total Swap Space Size
  • Threading/Peak Thread Count
  • Threading/Thread Count
  • Threading/Total Started Thread Count

The property name is retrieved in the following format:

<service name>/<counter name>

feedstatuses: The property name is retrieved in the following format:

Feed Status(feed name)/<counter name>

Information about the following counters is retrieved

  • statusDescription
  • feedRefURL
  • fetchSuccessRate
  • lastSuccessfulFetchTimeInSeconds
  • lastFetchCount

notifiers: The property name is retrieved in the following format:

Notifier(connection name)/<counter name>

Information about the following counters is retrieved

  • notificationsSent
  • lastFailureCause
  • notificationsDropped
  • connectionStatus
  • notificationsFailed
  • outQueueWait
  • outQueueDepth

notificationRuleStatuses: The property name is retrieved in the following format:

Notification Rule Status(notification name)/<counter name>

Information about the following counters is retrieved

  • total
  • failure
  • status
  • type
  • Success

eventingInfo: The property name is retrieved in the following format:

Eventing Info/<counter name>

Information about the following counters is retrieved

  • dsNfyMsgsRcvd
  • connectionStatus
  • xmppEventsDropped
  • xmppEventsSent
  • outQueueWait
  • xmppEventsFailed
  • outQueueDepth

For information about the elements, see Serviceability API Parameters.

Example XML response: 


<dp:GetPerformanceInformationReply xmlns:dp="https://www.cisco.com/vtg/diagnosticportal" ReturnCode="0">
		<dp:Schema Version="1.0"/>
		<dp:PerformanceInformation>
			<dp:PropertyList>
				<dp:Property Name="Runtime/System/Total Physical Memory Size" Value="8508125184"/>
				<dp:Property Name="Runtime/System/System Load Average" Value="0.82"/>
				<dp:Property Name="Runtime/Threading/Thread Count" Value="581"/>
				<dp:Property Name="Runtime/System/Process Cpu Time" Value="2695750000000"/>
				<dp:Property Name="Runtime/Threading/Total Started Thread Count" Value="8235"/>
				<dp:Property Name="Runtime/System/Free Swap Space Size" Value="2113822720"/>
				<dp:Property Name="Runtime/System/Max File Descriptor Count" Value="64000"/>
				<dp:Property Name="Runtime/System/Committed Virtual Memory Size" Value="2046943232"/>
				<dp:Property Name="Runtime/System/Available Processors" Value="2"/>
				<dp:Property Name="Runtime/Threading/Peak Thread Count" Value="618"/>
				<dp:Property Name="Runtime/System/Free Physical Memory Size" Value="1680343040"/>
				<dp:Property Name="Runtime/System/Open File Descriptor Count" Value="245"/>
				<dp:Property Name="Runtime/System/Total Swap Space Size" Value="2113822720"/>
				<dp:Property Name="Feed Status(Feed Name)/statusDescription" Value="NETWORK_NOT_REACHABLE"/>
				<dp:Property Name="Eventing Info/dsNfyMsgsRcvd" Value="220"/>
				<dp:Property Name="Notifier(Connection Name)/notificationsSent" Value="11"/>
				<dp:Property Name="Notification Rule Status(Notification Name)/total" Value="1"/>
				/dp:PropertyList>
		</dp:PerformanceInformation>
</dp:GetPerformanceInformationReply>