Difference between revisions of "Draft: UCS/Current/UCSPEGuide/Metrics"

From Genesys Documentation
Jump to: navigation, search
m
(Tag: New redirect)
 
(19 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Article
+
#REDIRECT [[Draft:UCS/Current/UCSPEGuide/UCSMetrics]]
|Standalone=No
 
|DisplayName=Metrics
 
|Context=Learn which metrics you should monitor for <service_name> and when to sound the alarm.
 
|ComingSoon=No
 
|Section={{Section
 
|alignment=Vertical
 
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">Include a link to the "suite-level" documentation for monitoring: {{SuiteLevelLink|metrics}}
 
 
 
Describe metrics (compatible with Prometheus endpoints) that customers can use to create their own monitoring dashboard in a tool like Grafana.
 
 
 
Make to identify any metrics that are important to monitor for alarming purposes, and include sample thresholds the customer should alarm on.</div>UCS-X provides internal monitoring metrics through a Prometheus endpoint on port 10052.
 
<br />
 
|Status=No
 
}}{{Section
 
|sectionHeading=Common Performance Metrics
 
|alignment=Vertical
 
|structuredtext={{{!}} class="wikitable"
 
{{!}}-
 
!Name (type)
 
!Key
 
!Units
 
!Additional<br />keys
 
!Alarm condition
 
!Description
 
!Common description
 
{{!}}-
 
{{!}} rowspan="2" {{!}}ucsx_performance<br />(Gauge)
 
{{!}}metric="cpuUsage"
 
{{!}}%
 
{{!}} rowspan="2" {{!}}'nodeId',<br />'pid'
 
{{!}}> 95
 
{{!}}CPU usage
 
{{!}} rowspan="4" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}metric="loopDelay"
 
{{!}}ms
 
{{!}}
 
{{!}}event loop lag
 
{{!}}-
 
{{!}} rowspan="2" {{!}}ucsx_internal_queue<br />(Gauge)
 
{{!}}metric="queueSize"
 
{{!}}
 
{{!}} rowspan="2" {{!}}'nodeId',<br />'pid',<br />'endpoint'
 
{{!}}
 
{{!}}number requests waiting for processing
 
{{!}}-
 
{{!}}metric="queueDelay"
 
{{!}}ms
 
{{!}}> 10000
 
{{!}}request's waiting for processing time
 
{{!}}-
 
{{!}} rowspan="4" {{!}}ucsx_timings
 
(Gauge)
 
{{!}}metric="cpuTime"
 
{{!}} rowspan="4" {{!}}s<br /><br />
 
{{!}} rowspan="4" {{!}}'nodeId',<br />'pid'<br /><br /><br />
 
{{!}}
 
{{!}}CPU time used by process
 
{{!}} rowspan="4" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}metric="sysTime"
 
{{!}}
 
{{!}}Syetm mode time
 
{{!}}-
 
{{!}}metric="userTime"
 
{{!}}
 
{{!}}User mode time
 
{{!}}-
 
{{!}}metric="upTime"
 
{{!}}
 
{{!}}Process running time
 
{{!}}-
 
{{!}} rowspan="3" {{!}}ucsx_memory
 
(Gauge)
 
{{!}}metric="rss"
 
{{!}}Mb<br /><br />
 
{{!}} rowspan="3" {{!}}'nodeId',<br />'pid',<br /><br /><br />
 
{{!}}> 1024
 
{{!}}Resident Set Size
 
{{!}} rowspan="3" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}metric="heapTotal"
 
{{!}}
 
{{!}}
 
{{!}}
 
{{!}}-
 
{{!}}metric="heapUsed"
 
{{!}}
 
{{!}}
 
{{!}}
 
{{!}}}
 
|Status=No
 
}}
 
|PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e
 
}}
 

Latest revision as of 03:25, December 23, 2021

This is a draft page; the published version of this page can be found at UCS/Current/UCSPEGuide/Metrics.