Corinneh: Published

2022-02-23T20:56:29Z

Published

New page

{{ArticlePEServiceMetrics
|IncludedServiceId=9973e20e-6a5a-427f-a47e-5d8cb006f452
|CRD=Supports both CRD and annotations
|Port=8081
|Endpoint=http://<pod-ipaddress>:8081/metrics
|MetricsUpdateInterval=30 seconds
|MetricsDefined=Yes
|MetricsIntro=You can query Prometheus directly to see all the metrics that the Voice Voicemail Service exposes. The following metrics are likely to be particularly useful. Genesys does not commit to maintain other currently available Voicemail Service metrics not documented on this page.
|PEMetric={{PEMetric
|Metric=voicemail_access_call_rate
|Type=gauge
|MetricDescription=The voicemail access call rate.
|UsedFor=Traffic
}}{{PEMetric
|Metric=voicemail_deposit_call_rate
|Type=gauge
|MetricDescription=The voicemail deposit call rate.
|UsedFor=Traffic
}}{{PEMetric
|Metric=voicemail_gws_request_total
|Type=counter
|Unit=N/A
|MetricDescription=The total number of requests sent to GWS.
|UsedFor=Traffic
}}{{PEMetric
|Metric=voicemail_redis_request_total
|Type=counter
|Unit=N/A
|MetricDescription=The total number of requests sent to Redis.
|UsedFor=Traffic
}}{{PEMetric
|Metric=voicemail_config_request_total
|Type=counter
|Unit=N/A
|MetricDescription=The total number of requests sent to the Config node.
|UsedFor=Traffic
}}{{PEMetric
|Metric=voicemail_config_request_failed_total
|Type=counter
|Unit=N/A
|Label=response code; for example, <tt>Internal Server Error</tt> or <tt>Service Unavailable</tt>
|MetricDescription=The total number of requests sent to the config node that failed.
|UsedFor=Errors
}}{{PEMetric
|Metric=voicemail_redis_request_failed_total
|Type=counter
|Unit=N/A
|MetricDescription=The total number of Message Waiting Indicator (MWI) notification requests sent to the Redis stream that failed.
|UsedFor=Errors
}}{{PEMetric
|Metric=voicemail_gws_request_failed_total
|Type=counter
|Unit=N/A
|Label=response code; for example, <tt>Internal Server Error</tt> or <tt>Service Unavailable</tt>
|MetricDescription=The total number of authentication errors when the Voicemail API is accessing via GWS SSO.
|UsedFor=Errors
}}{{PEMetric
|Metric=voicemail_service_health_check
|Type=gauge
|Unit=N/A
|MetricDescription=Status of the service health check:

2 – The service health check is alive 
1 – The service health check is degraded 
0 – Initializing 
-1 – The service health check has failed

The service health check takes the status of all the dependencies into consideration. The overall Voicemail Service health is updated every two minutes.
|UsedFor=Aggregated health check
}}{{PEMetric
|Metric=voicemail_envoy_proxy_status
|Type=gauge
|Unit=N/A
|MetricDescription=The status of the Envoy proxy:

1 – The Envoy proxy is alive 
0 – The Envoy proxy is down
|UsedFor=Aggregated health check
}}{{PEMetric
|Metric=voicemail_gws_status
|Type=gauge
|Unit=N/A
|MetricDescription=The status of GWS:

1 – GWS is alive 
0 – GWS is down
|UsedFor=Aggregated health check
}}{{PEMetric
|Metric=voicemail_config_node_status
|Type=gauge
|Unit=N/A
|MetricDescription=Config node status:

1 – the Config node is alive 
0 – The Config node is down
|UsedFor=Aggregated health check
}}{{PEMetric
|Metric=voicemail_redis_state
|Type=gauge
|MetricDescription=Indicator of redis_state:

2 – redis_state is ready 
1 – redis_state is degraded 
0 – redis_state is failed
|UsedFor=Aggregated health check
}}
|AlertsDefined=Yes
|PEAlert={{PEAlert
|Alert=voicemail_storage_failed_account
|Severity=Outage
|AlertDescription=The Storage account is down and, as a result, the service will not be able to fetch the data.
|BasedOn=voicemail_storage_failed_account
|Threshold=The Storage account is down.
}}{{PEAlert
|Alert=VoicemailConfigRequestFailureCritical
|Severity=Critical
|AlertDescription=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> unable to connect to Config Node.
|BasedOn=voicemail_config_request_failed_total
|Threshold=At least 6 requests failed per minute for the past 10 minutes.
}}{{PEAlert
|Alert=VoicemailRedisConnectionDown
|Severity=Critical
|AlertDescription=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> unable to connect to the Redis cluster.
|BasedOn=voicemail_redis_connection_failure
|Threshold=At least 6 requests failed per minute for the past 10 minutes.
}}{{PEAlert
|Alert=voicemail_node_memory_usage_80
|Severity=Critical
|AlertDescription=Critical memory usage for pod <nowiki>{{ $labels.pod }}</nowiki>.
|BasedOn=container_memory_working_set_bytes, kube_pod_container_resource_requests_memory_bytes
|Threshold=The Voicemail pod exceeded 80% memory usage for 5 minutes.
}}{{PEAlert
|Alert=voicemail_node_cpu_usage_80
|Severity=Critical
|AlertDescription=Critical CPU load for pod <nowiki>{{ $labels.pod }}</nowiki>.
|BasedOn=container_cpu_usage_seconds_total, kube_pod_container_resource_requests_cpu_cores
|Threshold=The Voicemail pod exceeded 80% CPU usage for 5 minutes.
}}{{PEAlert
|Alert=PodStatusNotReadyfor10mins
|Severity=Critical
|AlertDescription=The Voicemail pod is down.
|BasedOn=kube_pod_status_ready
|Threshold=The Voicemail pod is down for more than 10 minutes.
}}{{PEAlert
|Alert=ContainerRestartedRepeatedly
|Severity=Critical
|AlertDescription=The Voicemail pod restarts repeatedly.
|BasedOn=kube_pod_container_status_restarts_total
|Threshold=Container <nowiki>{{ $labels.container }}</nowiki> was restarted 5 or more times within 15 minutes.
}}{{PEAlert
|Alert=VoicemailEnvoyHealthFailedCritical
|Severity=Critical
|AlertDescription=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> Envoy service is not available.
|BasedOn=voicemail_envoy_proxy_status
|Threshold=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> Envoy service is not available for 10 minutes.
}}{{PEAlert
|Alert=VoicemailConfigHealthFailedCritical
|Severity=Critical
|AlertDescription=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> GWS service is not available.
|BasedOn=voicemail_config_node_status
|Threshold=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> GWS service is not available for 10 minutes.
}}{{PEAlert
|Alert=VoicemailGWSHealthFailedCritical
|Severity=Critical
|AlertDescription=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> GWS service is not available.
|BasedOn=voicemail_gws_status
|Threshold=Voicemail Service <nowiki>{{$labels.pod}}</nowiki> GWS service is not available for 15 minutes.
}}
}}

VM/Current/VMPEGuide/VoiceVoicemailServiceMetrics - Revision history

Corinneh: Published