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

From Genesys Documentation
Jump to: navigation, search
m
m
Line 26: Line 26:
 
!Common description
 
!Common description
 
{{!}}-
 
{{!}}-
−
{{!}} rowspan="2" {{!}}ucsx_performance<br />(Gauge)
+
{{!}} rowspan="2"{{!}}ucsx_performance<br />(Gauge)
 
{{!}}metric="cpuUsage"
 
{{!}}metric="cpuUsage"
 
{{!}}%
 
{{!}}%
−
{{!}} rowspan="2" {{!}}'nodeId',<br />'pid'
+
{{!}} rowspan="2"{{!}}'nodeId',<br />'pid'
 
{{!}}> 95
 
{{!}}> 95
 
{{!}}CPU usage
 
{{!}}CPU usage
−
{{!}} rowspan="4" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
+
{{!}} rowspan="4"{{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}-
 
{{!}}metric="loopDelay"
 
{{!}}metric="loopDelay"
Line 39: Line 39:
 
{{!}}event loop lag
 
{{!}}event loop lag
 
{{!}}-
 
{{!}}-
−
{{!}} rowspan="2" {{!}}ucsx_internal_queue<br />(Gauge)
+
{{!}} rowspan="2"{{!}}ucsx_internal_queue<br />(Gauge)
 
{{!}}metric="queueSize"
 
{{!}}metric="queueSize"
 
{{!}}
 
{{!}}
−
{{!}} rowspan="2" {{!}}'nodeId',<br />'pid',<br />'endpoint'
+
{{!}} rowspan="2"{{!}}'nodeId',<br />'pid',<br />'endpoint'
 
{{!}}
 
{{!}}
 
{{!}}number requests waiting for processing
 
{{!}}number requests waiting for processing
Line 51: Line 51:
 
{{!}}request's waiting for processing time
 
{{!}}request's waiting for processing time
 
{{!}}-
 
{{!}}-
−
{{!}} rowspan="4" {{!}}ucsx_timings
+
{{!}} rowspan="4"{{!}}ucsx_timings
 
(Gauge)
 
(Gauge)
 
{{!}}metric="cpuTime"
 
{{!}}metric="cpuTime"
−
{{!}} rowspan="4" {{!}}s<br /><br />
+
{{!}} rowspan="4"{{!}}s<br /><br />
−
{{!}} rowspan="4" {{!}}'nodeId',<br />'pid'<br /><br /><br />
+
{{!}} rowspan="4"{{!}}'nodeId',<br />'pid'<br /><br /><br />
 
{{!}}
 
{{!}}
 
{{!}}CPU time used by process
 
{{!}}CPU time used by process
−
{{!}} rowspan="4" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
+
{{!}} rowspan="4"{{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}-
 
{{!}}metric="sysTime"
 
{{!}}metric="sysTime"
Line 72: Line 72:
 
{{!}}Process running time
 
{{!}}Process running time
 
{{!}}-
 
{{!}}-
−
{{!}} rowspan="3" {{!}}ucsx_memory
+
{{!}} rowspan="3"{{!}}ucsx_memory
 
(Gauge)
 
(Gauge)
 
{{!}}metric="rss"
 
{{!}}metric="rss"
 
{{!}}Mb<br /><br />
 
{{!}}Mb<br /><br />
−
{{!}} rowspan="3" {{!}}'nodeId',<br />'pid',<br /><br /><br />
+
{{!}} rowspan="3"{{!}}'nodeId',<br />'pid',<br /><br /><br />
 
{{!}}> 1024
 
{{!}}> 1024
 
{{!}}Resident Set Size
 
{{!}}Resident Set Size
−
{{!}} rowspan="3" {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
+
{{!}} rowspan="3"{{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled
 
{{!}}-
 
{{!}}-
 
{{!}}metric="heapTotal"
 
{{!}}metric="heapTotal"
Line 90: Line 90:
 
{{!}}
 
{{!}}
 
{{!}}
 
{{!}}
 +
{{!}}}
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=DB Connection Metrics
 +
|alignment=Vertical
 +
|structuredtext={{{!}} class="wikitable"
 +
{{!}}-
 +
!Name (type)
 +
!Key
 +
!Units
 +
!Additional<br />keys
 +
!Alarm condition
 +
!Description
 +
!Common description
 +
{{!}}-
 +
{{!}} rowspan="4" {{!}}ucsx_dbPool<br />(Gauge)
 +
{{!}}metric="total"
 +
{{!}} rowspan="4" {{!}}
 +
{{!}} rowspan="4" {{!}}'nodeId',<br />'pid',<br />'ccId',<br />'address'
 +
{{!}}
 +
{{!}}Total count of connection to particular database (defined by key 'ccId')
 +
{{!}} rowspan="4" {{!}}basic metric,<br />created with starting call-center-storage service,<br />cannot be disabled,<br />shows usage of connection pool
 +
{{!}}-
 +
{{!}}metric="idle"
 +
{{!}}
 +
{{!}}Total count of idle connection to particular database (defined by key 'ccId')
 +
{{!}}-
 +
{{!}}metric="wait"
 +
{{!}}
 +
{{!}}Total count of connection in 'waiting' state to particular database (defined by key 'ccId')
 +
{{!}}-
 +
{{!}}metric="max"
 +
{{!}}
 +
{{!}}Max available connection for this instance of database
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No

Revision as of 06:27, June 17, 2021

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

Learn which metrics you should monitor for <service_name> and when to sound the alarm.

Include a link to the "suite-level" documentation for monitoring:
#mintydocs_link must be called from a MintyDocs-enabled page (Draft:UCS/Current/UCSPEGuide/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.
UCS-X provides internal monitoring metrics through a Prometheus endpoint on port 10052.


Common Performance Metrics

Name (type) Key Units Additional
keys 		Alarm condition Description Common description
ucsx_performance
(Gauge) 		metric="cpuUsage" % 'nodeId',
'pid' 		> 95 CPU usage basic metric,
created with starting metrics service,
cannot be disabled
metric="loopDelay" ms event loop lag
ucsx_internal_queue
(Gauge) 		metric="queueSize" 'nodeId',
'pid',
'endpoint' 		number requests waiting for processing
metric="queueDelay" ms > 10000 request's waiting for processing time
ucsx_timings

(Gauge)

metric="cpuTime" s

 'nodeId',
'pid'


 CPU time used by process basic metric,
created with starting metrics service,
cannot be disabled
metric="sysTime" Syetm mode time
metric="userTime" User mode time
metric="upTime" Process running time
ucsx_memory

(Gauge)

metric="rss" Mb

 'nodeId',
'pid',


 > 1024 Resident Set Size basic metric,
created with starting metrics service,
cannot be disabled
metric="heapTotal"
metric="heapUsed"

DB Connection Metrics

Name (type) Key Units Additional
keys 		Alarm condition Description Common description
ucsx_dbPool
(Gauge) 		metric="total" 'nodeId',
'pid',
'ccId',
'address' 		Total count of connection to particular database (defined by key 'ccId') basic metric,
created with starting call-center-storage service,
cannot be disabled,
shows usage of connection pool
metric="idle" Total count of idle connection to particular database (defined by key 'ccId')
metric="wait" Total count of connection in 'waiting' state to particular database (defined by key 'ccId')
metric="max" Max available connection for this instance of database
Retrieved from "https://all.docs.genesys.com/Draft:UCS/Current/UCSPEGuide/Metrics (2025-06-20 09:13:53)"