View source for PEC-OU/Current/CXCPEGuide/APIAMetrics

{{ArticlePEServiceMetrics
|IncludedServiceId=2f979634-6783-45e8-9072-e138c7c9abfa
|AltServiceDisplayName=API Aggregator
|CRD=ServiceMonitor
|Port=9102
|Endpoint=/metrics
|MetricsUpdateInterval=15 seconds
|MetricsDefined=Yes
|MetricsIntro=Here are some of the metrics exposed by API aggregator.
|PEMetric={{PEMetric
|Metric=cxc_api_aggregator_schedules_created_total
|Type=Counter
|MetricDescription=Total schedules created.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_schedules_removed_total
|Type=Counter
|MetricDescription=Total schedules removed.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_campaign_template_created_total
|Type=Counter
|MetricDescription=Total campaign templates created.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_campaign_template_removed_total
|Type=Counter
|MetricDescription=Total campaign templates removed.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_users_logged_in_total
|Type=Gauge
|MetricDescription=Total number of users who are logged in.
|SampleValue=4.2
}}{{PEMetric
|Metric=cxc_api_aggregator_users_logged_out_total
|Type=Gauge
|MetricDescription=Total number of users who are logged out.
|SampleValue=4.2
}}{{PEMetric
|Metric=cxc_api_aggregator_api_requests_total
|Type=Counter
|Label="'ccid', 'tenant_name'"
|MetricDescription=Total count of requests.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_healthy_instance
|Type=Gauge
|Label="'ccid', 'tenant_name'"
|MetricDescription=Healthy instance.
|SampleValue=4.2
}}{{PEMetric
|Metric=cxc_api_aggregator_api_requests_processed_success
|Type=Counter
|Label="'ccid', 'tenant_name'"
|MetricDescription=Total count of success requests.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_top_api_requests
|Type=Counter
|Label="'path', 'method', 'id', 'name', 'ccid', 'tenant_name', 'code'"
|MetricDescription=Top api requests.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_redis_connection_failed
|Type=Gauge
|Label="'ccid', 'tenant_name'"
|MetricDescription=Failed Redis connection.
|SampleValue=4.2
}}{{PEMetric
|Metric=cxc_api_aggregator_request_count
|Type=Counter
|Label="'method', 'path', 'code'"
|MetricDescription=Total requests by verb and code.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_request_latencies_ms
|Type=Histogram
|Label="'method', 'path', 'code'"
|MetricDescription=Request latencies histogram by verb, in milliseconds.
|SampleValue=[1, 2, 3]
}}{{PEMetric
|Metric=cxc_api_aggregator_request_out_count
|Type=Counter
|Label="'method', 'destination', 'code'"
|MetricDescription=Total out requests by verb, destination and code.
|SampleValue=42
}}{{PEMetric
|Metric=cxc_api_aggregator_request_out_latencies_ms
|Type=Histogram
|Label="'method', 'destination', 'code'"
|MetricDescription=Out Request latencies histogram by verb, destination and code, in milliseconds.
|SampleValue=[1, 2, 3]
}}{{PEMetric
|Metric=cxc_api_aggregator_elasticsearch_service_latencies_ms
|Type=Histogram
|Label="'method', 'destination', 'code'"
|MetricDescription=Elasticsearch Request latencies histogram by verb, destination and code, in milliseconds.
|SampleValue=[1, 2, 3]
}}
|AlertsDefined=Yes
|PEAlert={{PEAlert
|Alert=CXC-API-LatencyHigh
|Severity=HIGH
|AlertDescription=Triggered when the latency for API responses is beyond the defined threshold.
|Threshold=2500ms for 5m
}}{{PEAlert
|Alert=CXC-API-Redis-Connection-Failed
|Severity=HIGH
|AlertDescription=Triggered when the connection to redis fails for more than 1 minute.
|Threshold=1m
}}{{PEAlert
|Alert=CXC-EXT-Ingress-Error-Rate
|Severity=HIGH
|AlertDescription=Triggered when the Ingress error rate is above the specified threshold.
|Threshold=20% for 5m
}}{{PEAlert
|Alert=cxc_api_too_many_errors_from_auth
|Severity=HIGH
|AlertDescription=Triggered when there are too many error responses from the auth service for more than the specified time threshold.
|Threshold=1m
}}{{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
}}
}}