|
|
| (3 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 Universal Contact Service (UCS) 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
| |
| − | }}{{Section
| |
| − | |sectionHeading=Database 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
| |
| − | }}{{Section
| |
| − | |sectionHeading=HTTP Request Metrics
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Additional configuration<br />key
| |
| − | !Alarm condition
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="5"{{!}}ucsx_http_request_duration_bucket<br />(Histogram)
| |
| − | {{!}}le="10"
| |
| − | {{!}} rowspan="5"{{!}}ms
| |
| − | {{!}} rowspan="7"{{!}}'nodeId',<br />'pid',<br />'endpoint',<br />'url',<br />'code',<br />'method',<br />'ccId',<br />'ccName'<br />
| |
| − | {{!}} rowspan="10"{{!}}/rest-gws/metrics/enabled = false - to disable
| |
| − | {{!}} rowspan="7"{{!}}> 10000
| |
| − | {{!}}Count HTTP request's of duration less 10ms
| |
| − | {{!}}Metrics of HTTP requests duration
| |
| − | {{!}}-
| |
| − | {{!}}le="50"
| |
| − | {{!}}Count HTTP request's of duration less 50ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}le="200"
| |
| − | {{!}}Count HTTP request's of duration less 200ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}le="1000"
| |
| − | {{!}}Count HTTP request's of duration less 1000ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}le="+Inf"
| |
| − | {{!}}Count all HTTP request's
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_http_request_duration_sum<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}ms
| |
| − | {{!}}Total duration of all HTTP requests
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_http_request_duration_count<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Total number of all HTTP requests
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_http_total_requests_count<br />(Counter)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}'nodeId',<br />'pid',<br />'endpoint'
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Accumulative counter of all HTTP requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_http_active_requests_count<br />(Gauge)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}'nodeId',<br />'pid',<br />'endpoint'
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Counter of all incomplete requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_http_requests_per_second<br />(Gauge)
| |
| − | {{!}}
| |
| − | {{!}}requests/s
| |
| − | {{!}}'nodeId',<br />'pid',<br />'endpoint'
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Performance of processing HTTP requests
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=CometD Metrics
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Additional configuration<br />key
| |
| − | !Alarm condition
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="5"{{!}}ucsx_cometd_request_duration_bucket<br />(Histogram)
| |
| − | {{!}}le="10"
| |
| − | {{!}} rowspan="5"{{!}}ms
| |
| − | {{!}} rowspan="7"{{!}}'nodeId',<br />'pid',<br />'endpoint',<br />'url',<br />'code',<br />'method',<br />'ccId',<br />'ccName'
| |
| − | {{!}} rowspan="9"{{!}}/rest-gws-cometd/metrics/enabled = false - to disable
| |
| − | {{!}} rowspan="7"{{!}}> 10000
| |
| − | {{!}}Count CometD request's of duration less 10ms
| |
| − | {{!}} rowspan="7"{{!}}Metrics of CometD requests duration
| |
| − | {{!}}-
| |
| − | {{!}}le="50"
| |
| − | {{!}}Count CometD request's of duration less 50ms
| |
| − | {{!}}-
| |
| − | {{!}}le="200"
| |
| − | {{!}}Count CometD request's of duration less 200ms
| |
| − | {{!}}-
| |
| − | {{!}}le="1000"
| |
| − | {{!}}Count CometD request's of duration less 1000ms
| |
| − | {{!}}-
| |
| − | {{!}}le="+Inf"
| |
| − | {{!}}Count all CometD request's
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_cometd_request_duration_sum<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}ms
| |
| − | {{!}}Total duration of all HTTP requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_cometd_request_duration_count<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Total number of all HTTP requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_cometd_requests_total<br />(Counter)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}'nodeId',<br />'pid',<br />'endpoint'
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Accumulative counter of all CometD requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_cometd_active_requests_count<br />(Gauge)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}'nodeId',<br />'pid',<br />'endpoint'
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Counter of all incomplete requests
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=Internal Functions Calls Monitoring
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Additional configuration<br />key
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="5"{{!}}ucsx_internal_calls_bucket<br />(Histogram)
| |
| − | {{!}}le="10"
| |
| − | {{!}} rowspan="7"{{!}}ms
| |
| − | {{!}} rowspan="7"{{!}}'nodeId',<br />'pid',<br />'function'
| |
| − | {{!}} rowspan="7"{{!}}/${serviceName}/callMetrics = false - to disable
| |
| − | {{!}}Count internal calls request's of duration less 10ms
| |
| − | {{!}} rowspan="7"{{!}}Metrics of services's methods calls duration
| |
| − | {{!}}-
| |
| − | {{!}}le="50"
| |
| − | {{!}}Count internal calls of duration less 50ms
| |
| − | {{!}}-
| |
| − | {{!}}le="200"
| |
| − | {{!}}Count internal calls of duration less 200ms
| |
| − | {{!}}-
| |
| − | {{!}}le="1000"
| |
| − | {{!}}Count internal calls of duration less 1000ms
| |
| − | {{!}}-
| |
| − | {{!}}le="+Inf"
| |
| − | {{!}}Count all internal calls
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_internal_calls_sum<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}Total duration of all calls of function
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_internal_calls_count<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}Total number of all calls of function
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=SQL Monitoring
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_sql_bucket<br />(Histogram)
| |
| − | {{!}}le="10"
| |
| − | {{!}}ms
| |
| − | {{!}}'nodeId',<br />'pid',<br />'operation',<br />'ccId',<br />'ccName'
| |
| − | {{!}}Count SQL request's of duration less 10ms
| |
| − | {{!}}Metrics of raw SQL request duration.<br />Key 'operation' might have values: 'update','insert','delete','query','rawSql'
| |
| − | {{!}}-
| |
| − | {{!}}
| |
| − | {{!}}le="50"
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Count SQL request's of duration less 50ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}
| |
| − | {{!}}le="200"
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Count SQL request's of duration less 200ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}
| |
| − | {{!}}le="1000"
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Count SQL request's of duration less 1000ms
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}
| |
| − | {{!}}le="+Inf"
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Count all SQL request's
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_sql_sum<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Total duration of all raw SQL requests
| |
| − | {{!}}
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_sql_count<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}
| |
| − | {{!}}Total number of all raw SQL requests
| |
| − | {{!}}
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=Internal Cache Monitoring
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="6"{{!}}ucsx_cache<br />(Counter)
| |
| − | {{!}}method="set"
| |
| − | {{!}} rowspan="6"{{!}}
| |
| − | {{!}} rowspan="6"{{!}}'nodeId',<br />'pid',<br />'key'
| |
| − | {{!}}Count writes to cache
| |
| − | {{!}} rowspan="6"{{!}}Metrics of internal application cache
| |
| − | {{!}}-
| |
| − | {{!}}method="get"
| |
| − | {{!}}Count successful reads from cache
| |
| − | {{!}}-
| |
| − | {{!}}method="delete"
| |
| − | {{!}}Count delete operations from cache
| |
| − | {{!}}-
| |
| − | {{!}}method="expired"
| |
| − | {{!}}Count unsuccessful reads from cache due to data expiration
| |
| − | {{!}}-
| |
| − | {{!}}method="remove"
| |
| − | {{!}}Count remove operation by timer
| |
| − | {{!}}-
| |
| − | {{!}}method="miss"
| |
| − | {{!}}Count unsuccessful reads from cache due to data absence
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=Elasticsearch Monitoring
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional <br />keys
| |
| − | !Alarm condition
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="5"{{!}}ucsx_elastic_search_bucket<br />(Histogram)
| |
| − | {{!}}le="10"
| |
| − | {{!}} rowspan="7"{{!}}ms
| |
| − | {{!}} rowspan="7"{{!}}'nodeId',<br />'pid',<br />'operation',<br />'ccId',<br />'ccName'
| |
| − | {{!}} rowspan="7"{{!}}
| |
| − | {{!}}Count ES request's of duration less 10ms
| |
| − | {{!}} rowspan="7"{{!}}Metrics of ElasticSearch request duration.<br />Key 'operation' can have values: 'read','write'.
| |
| − | {{!}}-
| |
| − | {{!}}le="50"
| |
| − | {{!}}Count ES request's of duration less 50ms
| |
| − | {{!}}-
| |
| − | {{!}}le="200"
| |
| − | {{!}}Count ES request's of duration less 200ms
| |
| − | {{!}}-
| |
| − | {{!}}le="1000"
| |
| − | {{!}}Count ES request's of duration less 1000ms
| |
| − | {{!}}-
| |
| − | {{!}}le="+Inf"
| |
| − | {{!}}Count all ES request's
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_elastic_search_sum<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}Total duration of all ElasticSearch requests
| |
| − | {{!}}-
| |
| − | {{!}}ucsx_elastic_search_count<br />(Histogram)
| |
| − | {{!}}
| |
| − | {{!}}Total number of all ElasticSearch requests
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}{{Section
| |
| − | |sectionHeading=Session Metrics
| |
| − | |alignment=Vertical
| |
| − | |structuredtext={{{!}} class="wikitable"
| |
| − | {{!}}-
| |
| − | !Name (type)
| |
| − | !Key
| |
| − | !Units
| |
| − | !Additional<br />keys
| |
| − | !Description
| |
| − | !Common description
| |
| − | {{!}}-
| |
| − | {{!}} rowspan="3"{{!}}ucsx_sessions<br />(Gauge)
| |
| − | {{!}}state="active"
| |
| − | {{!}} rowspan="3"{{!}}counter
| |
| − | {{!}} rowspan="3"{{!}}'nodeId',<br />'pid',<br />'state',<br />'session'
| |
| − | {{!}}Count of sessions that have had some activity within configured interval of time.
| |
| − | {{!}} rowspan="3"{{!}}Available session types are 'HTTP' and 'cometD'
| |
| − | {{!}}-
| |
| − | {{!}}state="idle"
| |
| − | {{!}}Count of sessions that have not had some activity within configured interval of time but still alive.
| |
| − | {{!}}-
| |
| − | {{!}}state="newPerMinute"
| |
| − | {{!}}Count of new opened sessions per last minute
| |
| − | {{!}}}
| |
| − | |Status=No
| |
| − | }}
| |
| − | |PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e
| |
| − | }}
| |
