Difference between revisions of "Draft: UCS/Current/UCSPEGuide/Metrics"
From Genesys Documentation
m |
m |
||
| Line 51: | Line 51: | ||
{{!}}request's waiting for processing time | {{!}}request's waiting for processing time | ||
{{!}}- | {{!}}- | ||
| − | {{!}} rowspan="4" {{!}}ucsx_timings(Gauge) | + | {{!}} rowspan="4" {{!}}ucsx_timings |
| + | (Gauge) | ||
{{!}}metric="cpuTime" | {{!}}metric="cpuTime" | ||
{{!}} rowspan="4" {{!}}s<br /><br /> | {{!}} rowspan="4" {{!}}s<br /><br /> | ||
| Line 61: | Line 62: | ||
{{!}}metric="sysTime" | {{!}}metric="sysTime" | ||
{{!}} | {{!}} | ||
| − | {{!}} | + | {{!}}Syetm mode time |
{{!}}- | {{!}}- | ||
{{!}}metric="userTime" | {{!}}metric="userTime" | ||
| Line 71: | Line 72: | ||
{{!}}Process running time | {{!}}Process running time | ||
{{!}}- | {{!}}- | ||
| − | {{!}} rowspan="3" {{!}}ucsx_memory(Gauge) | + | {{!}} rowspan="3" {{!}}ucsx_memory |
| + | (Gauge) | ||
{{!}}metric="rss" | {{!}}metric="rss" | ||
{{!}}Mb<br /><br /> | {{!}}Mb<br /><br /> | ||
| − | {{!}}'nodeId',<br />'pid',<br /><br /><br /> | + | {{!}} rowspan="3" {{!}}'nodeId',<br />'pid',<br /><br /><br /> |
{{!}}> 1024 | {{!}}> 1024 | ||
{{!}}Resident Set Size | {{!}}Resident Set Size | ||
| − | {{!}}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="heapUsed" | ||
| + | {{!}} | ||
| + | {{!}} | ||
| + | {{!}} | ||
{{!}}} | {{!}}} | ||
|Status=No | |Status=No | ||
Revision as of 06:24, 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" | 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" |