Difference between revisions of "PEC-OU/Current/CXCPEGuide/CPLMMetrics"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(Published)
Line 6: Line 6:
 
|Endpoint=/metrics
 
|Endpoint=/metrics
 
|MetricsUpdateInterval=15 seconds
 
|MetricsUpdateInterval=15 seconds
 +
|PEMetric={{PEMetric
 +
|Metric=compliance_api_history_requests_total
 +
|Type=Countera{{ArticlePEServiceMetrics
 +
|IncludedServiceId=7a612438-6296-4db9-b96e-ccb4ffb31ec0
 +
|AltServiceDisplayName=Compliance Manager
 +
|CRD=ServiceMonitor
 +
|Port=3107
 +
|Endpoint=/metrics
 +
|MetricsUpdateInterval=15 seconds
 +
|MetricsDefined=Yes
 
|PEMetric={{PEMetric
 
|PEMetric={{PEMetric
 
|Metric=compliance_api_history_requests_total
 
|Metric=compliance_api_history_requests_total
 
|Type=Counter
 
|Type=Counter
 +
|Label="'type', 'ccid', 'tenant_name'"
 +
|MetricDescription=Total number of history API calls.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_validation_under_processing_total
 +
|Type=Gauge
 +
|Label="'type', 'ccid', 'tenant_name'"
 +
|MetricDescription=Total number validation requests are under processing.
 +
|SampleValue=4.2
 +
}}{{PEMetric
 +
|Metric=compliance_validation_complete_total
 +
|Type=Counter
 +
|Label="'type', 'ccid', 'tenant_name'"
 +
|MetricDescription=Total number of completed validation calls.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_validation_success_total
 +
|Type=Counter
 +
|Label="'type', 'ccid', 'tenant_name'"
 +
|MetricDescription=Number of validated requests with Success status.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_validation_failed_total
 +
|Type=Counter
 +
|Label="'type', 'ccid', 'tenant_name'"
 +
|MetricDescription=Number of validation requests with Failed status.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_validation_success_by_tenant
 +
|Type=Counter
 +
|Label="'type', 'tenant_name'"
 +
|MetricDescription=Number of validation requests by Tenant with Success result.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_validation_failed_by_tenant
 +
|Type=Counter
 +
|Label="'type', 'tenant_name'"
 +
|MetricDescription=Number of validation requests by Tenant with Fail result.
 +
|SampleValue=4.2
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_healthy_instance
 +
|Type=Gauge
 +
|Label=n/a
 +
|MetricDescription=Healthy instance.
 +
|SampleValue=4.2
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_request_latencies_ms
 +
|Type=Histogram
 +
|Label="'method', 'path', 'code'"
 +
|MetricDescription=The latencies of all HTTP requests distributed by method, plus path and HTTP response code.
 +
 +
<br />
 +
|SampleValue=[1, 2, 3]
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_request_count
 +
|Type=Counter
 +
|Label="'method', 'path', 'code'"
 +
|MetricDescription=The number of all HTTP requests distributed by method, plus path and HTTP response code.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_redis_connections_made
 +
|Type=Counter
 +
|Label=n/a
 +
|MetricDescription=Total number of Redis connections made.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_redis_connections_closed
 +
|Type=Counter
 +
|Label=n/a
 +
|MetricDescription=Total number of Redis connections closed. Current can be calculated with the help of compliance_redis_connections_made.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_redis_access_errors
 +
|Type=Counter
 +
|Label=n/a
 +
|MetricDescription=Total number of reported REDIS errors.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=compliance_ocs_calls_placed
 +
|Type=Counter
 +
|Label='GSW_CALL_RESULT'
 +
|MetricDescription=Total number of calls placed by OCS broken by GSW_CALL_RESULT.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_request_out_count
 +
|Type=Counter
 +
|Label="'method', 'path', 'code'"
 +
|MetricDescription=Total Out Requests by verb, destination, and code.
 +
|SampleValue=42
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_request_out_latencies_ms
 +
|Type=Histogram
 +
|Label="'method', 'path', 'code'"
 +
|MetricDescription=Out Request latencies histogram by verb, destination, and code, in milliseconds.
 +
|SampleValue=[1, 2, 3]
 +
}}{{PEMetric
 +
|Metric=cxc_dm_elasticsearch_service_latencies_ms
 +
|Type=Histogram
 +
|Label=n/a
 +
|MetricDescription=Elasticsearch Request latencies histogram by verb, destination, and code, in milliseconds.
 +
|SampleValue=[1, 2. 3]
 +
}}{{PEMetric
 +
|Metric=cxc_compliance_validation_rate_limit_reached
 +
|Type=Counter
 +
|Label="'ccid', 'reason'"
 +
|MetricDescription=Total number of validation requests rejected due to rate limit exceeded, broken by customer (tenant) and a limit reason {device, customerId, overall}.
 +
|SampleValue=42
 +
}}
 +
|AlertsDefined=Yes
 +
|PEAlert={{PEAlert
 +
|Alert=CXC-Compliance-LatencyHigh
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the latency for API responses is beyond the defined threshold.
 +
|Threshold=5000ms for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-CoM-Redis-no-active-connections
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when CX Contact compliance has no active redis connection for 2 minutes
 +
|Threshold=2m
 +
}}{{PEAlert
 +
|Alert=CXC-CPUUsage
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the CPU utilization of a pod is beyond the threshold.
 +
|Threshold=300% for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-MemoryUsage
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the memory utilization of a pod is beyond the threshold.
 +
|Threshold=70% for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-PodNotReadyCount
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the number of pods ready for a CX Contact deployment is less than or equal to the threshold.
 +
|Threshold=1 for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-PodRestartsCount
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the restart count for a pod is beyond the threshold.
 +
|Threshold=1 for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-MemoryUsagePD
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the memory usage of a pod is above the critical threshold.
 +
|Threshold=90% for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-PodRestartsCountPD
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when the restart count is beyond the critical threshold.
 +
|Threshold=5 for 5m
 +
}}{{PEAlert
 +
|Alert=CXC-PodsNotReadyPD
 +
|Severity=HIGH
 +
|AlertDescription=Triggered when there are no pods ready for CX Contact deployment.
 +
|Threshold=0 for 1m
 +
}}
 +
}}
 +
 
|Label="'type', 'ccid', 'tenant_name'"
 
|Label="'type', 'ccid', 'tenant_name'"
 
|MetricDescription=Total number of history API calls.
 
|MetricDescription=Total number of history API calls.

Revision as of 14:19, February 7, 2022

This topic is part of the manual Outbound (CX Contact) Private Edition Guide for version Current of Outbound (CX Contact).

Find the metrics CPLM exposes and the alerts defined for CPLM.

Related documentation:
Service CRD or annotations? Port Endpoint/Selector Metrics update interval
Compliance Manager ServiceMonitor 3107 /metrics 15 seconds

See details about:

Metrics[edit source]

Metric and description Metric details Indicator of
compliance_api_history_requests_total

Total number of history API calls.

Unit:

Type: Countera

Cannot set a new type for this page; its type has already been set to Topic.

Find the metrics CPLM exposes and the alerts defined for CPLM.

Related documentation:
Service CRD or annotations? Port Endpoint/Selector Metrics update interval
Compliance Manager ServiceMonitor 3107 /metrics 15 seconds

See details about:

Metrics[edit source]

Metric and description Metric details Indicator of
compliance_api_history_requests_total

Total number of history API calls.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_under_processing_total

Total number validation requests are under processing.

Unit:

Type: Gauge
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 4.2

compliance_validation_complete_total

Total number of completed validation calls.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_success_total

Number of validated requests with Success status.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_failed_total

Number of validation requests with Failed status.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_success_by_tenant

Number of validation requests by Tenant with Success result.

Unit:

Type: Counter
Label: "'type', 'tenant_name'"
Sample value: 42

compliance_validation_failed_by_tenant

Number of validation requests by Tenant with Fail result.

Unit:

Type: Counter
Label: "'type', 'tenant_name'"
Sample value: 4.2

cxc_compliance_healthy_instance

Healthy instance.

Unit:

Type: Gauge
Label: n/a
Sample value: 4.2

cxc_compliance_request_latencies_ms

The latencies of all HTTP requests distributed by method, plus path and HTTP response code.


Unit:

Type: Histogram
Label: "'method', 'path', 'code'"
Sample value: [1, 2, 3]

cxc_compliance_request_count

The number of all HTTP requests distributed by method, plus path and HTTP response code.

Unit:

Type: Counter
Label: "'method', 'path', 'code'"
Sample value: 42

compliance_redis_connections_made

Total number of Redis connections made.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_redis_connections_closed

Total number of Redis connections closed. Current can be calculated with the help of compliance_redis_connections_made.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_redis_access_errors

Total number of reported REDIS errors.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_ocs_calls_placed

Total number of calls placed by OCS broken by GSW_CALL_RESULT.

Unit:

Type: Counter
Label: 'GSW_CALL_RESULT'
Sample value: 42

cxc_compliance_request_out_count

Total Out Requests by verb, destination, and code.

Unit:

Type: Counter
Label: "'method', 'path', 'code'"
Sample value: 42

cxc_compliance_request_out_latencies_ms

Out Request latencies histogram by verb, destination, and code, in milliseconds.

Unit:

Type: Histogram
Label: "'method', 'path', 'code'"
Sample value: [1, 2, 3]

cxc_dm_elasticsearch_service_latencies_ms

Elasticsearch Request latencies histogram by verb, destination, and code, in milliseconds.

Unit:

Type: Histogram
Label: n/a
Sample value: [1, 2. 3]

cxc_compliance_validation_rate_limit_reached

Total number of validation requests rejected due to rate limit exceeded, broken by customer (tenant) and a limit reason {device, customerId, overall}.

Unit:

Type: Counter
Label: "'ccid', 'reason'"
Sample value: 42

Alerts[edit source]

The following alerts are defined for Compliance Manager.

Alert Severity Description Based on Threshold
CXC-Compliance-LatencyHigh HIGH Triggered when the latency for API responses is beyond the defined threshold. 5000ms for 5m


CXC-CoM-Redis-no-active-connections HIGH Triggered when CX Contact compliance has no active redis connection for 2 minutes 2m


CXC-CPUUsage HIGH Triggered when the CPU utilization of a pod is beyond the threshold. 300% for 5m


CXC-MemoryUsage HIGH Triggered when the memory utilization of a pod is beyond the threshold. 70% for 5m


CXC-PodNotReadyCount HIGH Triggered when the number of pods ready for a CX Contact deployment is less than or equal to the threshold. 1 for 5m


CXC-PodRestartsCount HIGH Triggered when the restart count for a pod is beyond the threshold. 1 for 5m


CXC-MemoryUsagePD HIGH Triggered when the memory usage of a pod is above the critical threshold. 90% for 5m


CXC-PodRestartsCountPD HIGH Triggered when the restart count is beyond the critical threshold. 5 for 5m


CXC-PodsNotReadyPD HIGH Triggered when there are no pods ready for CX Contact deployment. 0 for 1m

Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_under_processing_total

Total number validation requests are under processing.

Unit:

Type: Gauge
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 4.2

compliance_validation_complete_total

Total number of completed validation calls.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_success_total

Number of validated requests with Success status.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_failed_total

Number of validation requests with Failed status.

Unit:

Type: Counter
Label: "'type', 'ccid', 'tenant_name'"
Sample value: 42

compliance_validation_success_by_tenant

Number of validation requests by Tenant with Success result.

Unit:

Type: Counter
Label: "'type', 'tenant_name'"
Sample value: 42

compliance_validation_failed_by_tenant

Number of validation requests by Tenant with Fail result.

Unit:

Type: Counter
Label: "'type', 'tenant_name'"
Sample value: 4.2

cxc_compliance_healthy_instance

Healthy instance.

Unit:

Type: Gauge
Label: n/a
Sample value: 4.2

cxc_compliance_request_latencies_ms

The latencies of all HTTP requests distributed by method, plus path and HTTP response code.


Unit:

Type: Histogram
Label: "'method', 'path', 'code'"
Sample value: [1, 2, 3]

cxc_compliance_request_count

The number of all HTTP requests distributed by method, plus path and HTTP response code.

Unit:

Type: Counter
Label: "'method', 'path', 'code'"
Sample value: 42

compliance_redis_connections_made

Total number of Redis connections made.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_redis_connections_closed

Total number of Redis connections closed. Current can be calculated with the help of compliance_redis_connections_made.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_redis_access_errors

Total number of reported REDIS errors.

Unit:

Type: Counter
Label: n/a
Sample value: 42

compliance_ocs_calls_placed

Total number of calls placed by OCS broken by GSW_CALL_RESULT.

Unit:

Type: Counter
Label: 'GSW_CALL_RESULT'
Sample value: 42

cxc_compliance_request_out_count

Total Out Requests by verb, destination, and code.

Unit:

Type: Counter
Label: "'method', 'path', 'code'"
Sample value: 42

cxc_compliance_request_out_latencies_ms

Out Request latencies histogram by verb, destination, and code, in milliseconds.

Unit:

Type: Histogram
Label: "'method', 'path', 'code'"
Sample value: [1, 2, 3]

cxc_dm_elasticsearch_service_latencies_ms

Elasticsearch Request latencies histogram by verb, destination, and code, in milliseconds.

Unit:

Type: Histogram
Label: n/a
Sample value: [1, 2. 3]

cxc_compliance_validation_rate_limit_reached

Total number of validation requests rejected due to rate limit exceeded, broken by customer (tenant) and a limit reason {device, customerId, overall}.

Unit:

Type: Counter
Label: "'ccid', 'reason'"
Sample value: 42

Alerts[edit source]

No alerts are defined for Compliance Manager.

Retrieved from "https://all.docs.genesys.com/PEC-OU/Current/CXCPEGuide/CPLMMetrics (2025-06-21 07:58:44)"
Comments or questions about this documentation? Contact us for support!