Difference between revisions of "Draft: UCS/Current/UCSPEGuide/Metrics"
From Genesys Documentation
m |
m |
||
| Line 12: | Line 12: | ||
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. | 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 /> | <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" | ||
| + | {{!}} | ||
| + | {{!}}System mode time | ||
| + | {{!}}- | ||
| + | {{!}}metric="userTime" | ||
| + | {{!}} | ||
| + | {{!}}User mode time | ||
| + | {{!}}- | ||
| + | {{!}}metric="upTime" | ||
| + | {{!}} | ||
| + | {{!}}Process running time | ||
| + | {{!}}- | ||
| + | {{!}} rowspan="3" {{!}}ucsx_memory(Gauge) | ||
| + | {{!}}metric="rss" | ||
| + | {{!}}Mb<br /><br /> | ||
| + | {{!}}'nodeId',<br />'pid',<br /><br /><br /> | ||
| + | {{!}}> 1024 | ||
| + | {{!}}Resident Set Size | ||
| + | {{!}}basic metric,<br />created with starting metrics service,<br />cannot be disabled | ||
| + | {{!}}} | ||
|Status=No | |Status=No | ||
}} | }} | ||
|PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e | |PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e | ||
}} | }} | ||
Revision as of 06:19, June 17, 2021
This is a draft page; the published version of this page can be found at UCS/Current/UCSPEGuide/Metrics.
Contents
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:
UCS-X provides internal monitoring metrics through a Prometheus endpoint on port 10052.
#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.
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" | System 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 |