Difference between revisions of "Draft: UCS/Current/UCSPEGuide/Metrics"
From Genesys Documentation
m |
m |
||
| Line 93: | Line 93: | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| − | |sectionHeading= | + | |sectionHeading=Database Connection Metrics |
|alignment=Vertical | |alignment=Vertical | ||
|structuredtext={{{!}} class="wikitable" | |structuredtext={{{!}} class="wikitable" | ||
| Line 105: | Line 105: | ||
!Common description | !Common description | ||
{{!}}- | {{!}}- | ||
| − | {{!}} rowspan="4" {{!}}ucsx_dbPool<br />(Gauge) | + | {{!}} rowspan="4"{{!}}ucsx_dbPool<br />(Gauge) |
{{!}}metric="total" | {{!}}metric="total" | ||
| − | {{!}} rowspan="4" {{!}} | + | {{!}} rowspan="4"{{!}} |
| − | {{!}} rowspan="4" {{!}}'nodeId',<br />'pid',<br />'ccId',<br />'address' | + | {{!}} rowspan="4"{{!}}'nodeId',<br />'pid',<br />'ccId',<br />'address' |
{{!}} | {{!}} | ||
{{!}}Total count of connection to particular database (defined by key 'ccId') | {{!}}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 | + | {{!}} rowspan="4"{{!}}basic metric,<br />created with starting call-center-storage service,<br />cannot be disabled,<br />shows usage of connection pool |
{{!}}- | {{!}}- | ||
{{!}}metric="idle" | {{!}}metric="idle" | ||
| Line 125: | Line 125: | ||
{{!}}Max available connection for this instance of database | {{!}}Max available connection for this instance of database | ||
{{!}}} | {{!}}} | ||
| + | |Status=No | ||
| + | }}{{Section | ||
| + | |sectionHeading=HTTP Requests Metrics | ||
| + | |alignment=Vertical | ||
|Status=No | |Status=No | ||
}} | }} | ||
|PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e | |PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e | ||
}} | }} | ||
Revision as of 06:32, 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:
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" |
Database 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 |
HTTP Requests Metrics