PEC-REP/Current/GCXIPEGuide/RAAMetrics - Revision history

WikiSysop at 19:45, April 7, 2022

2022-04-07T19:45:36Z

Tgilchri: Published

2021-12-22T14:07:14Z

Published

New page

{{ArticlePEServiceMetrics
|IncludedServiceId=5462861b-e347-4eaa-b621-9795838ee431
|CRD=PodMonitor and PrometheusRule
|Port=metrics: 9100, health: 9101
|Endpoint=RAA forms matched labels from raa.statefulset.selector.matchLabels values, specified in values.yaml. The default contains a single raa-app item with raa.serviceName variable as a value. The element raa.serviceName is a concatenation of parameters.
<source lang="bash">
....
statefulset:
## pod selector
selector:
matchLabels:
raa-app: "{{ tpl $.Values.raa.serviceName $ }}"

template:
## a map of pod specific labels to add to common labels
labels:
raa-app: "{{ tpl $.Values.raa.serviceName $ }}"
</source>
|MetricsUpdateInterval=metrics: several seconds, health: up to 3 minutes
|MetricsDefined=Yes
|PEMetric={{PEMetric
|Metric=gcxi_raa_health_level
|Type=Gauge
|MetricDescription=A health status metric extracted using a dedicated port on the monitor container. The metric value is a sum of values from two different health-checks:

*a database-based health-check. Results: '''2''', indicates that RAA is working or in maintenance (have received STOP and waits for START command from Genesys Info Mart), or '''0''', which indicates that RAA is not working according to this check.
*a local health-check. Results: '''1,''' indicates that RAA is processing aggregation requests according to local health files, or '''0''' at other times.
|SampleValue=0
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi_raa_command_count
|Type=Counter
|Label=cmd
|MetricDescription=The number of commands received from Genesys Info mart since the previous scrape. Label reflects name of the command. The supported commands are: START, QUIT, EXIT, UPDATE_CONFIG, REAGGREGATE
|SampleValue=10
|UsedFor=Traffic
}}{{PEMetric
|Metric=gcxi_raa_dispatch_count
|Type=Counter
|MetricDescription=The number of of dispatch (moving aggregation requests from AGR_NOTIFICATION to PENDING_ARG) events since the previous scrape. Dispatch events typically occur every 15 seconds. Such events are used for aggregation health check based on local files.
|SampleValue=100
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi_raa_heartbeat_count
|Type=Counter
|Label=version
|MetricDescription=The number of heartbeats since the previous scrape. Heartbeat is normally performed once every five minutes, and is used for health check based on local files. The label is the current RAA version.
|SampleValue=10
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi_raa_relaunched_count
|Type=Counter
|MetricDescription=The number of times RAA was re-launched since the previous scrape. The aggregation process can exit in the event of an error. Genesys Info Mart sends a START command every 15 minutes during the aggregation period, which causes RAA to relaunch.
|SampleValue=1
|UsedFor=Error
}}{{PEMetric
|Metric=gcxi_raa_launched_count
|Type=Counter
|Label=version
|MetricDescription=The number of times RAA launched since the previous scrape.
|SampleValue=1
|UsedFor=Error
}}{{PEMetric
|Metric=gcxi_raa_error_count
|Type=Counter
|MetricDescription=The number of errors registered since the previous scrape.
|SampleValue=1
|UsedFor=Error
}}{{PEMetric
|Metric=gcxi_raa_notification_count
|Type=Counter
|Label=fact
|MetricDescription=The number of fact change notifications received from Genesys Info Mart since the previous scrape.
|SampleValue=10
|UsedFor=Latency
}}{{PEMetric
|Metric=gcxi_raa_notification_period_ms
|Type=Counter
|Unit=milliseconds
|Label=fact
|MetricDescription=The total amount of time attributed to changed fact periods in notifications received from Genesys Info Mart since the previous scrape.
|UsedFor=Latency
}}{{PEMetric
|Metric=gcxi_raa_notification_delay_ms
|Type=Counter
|Unit=milliseconds
|Label=fact
|MetricDescription=The total amount of time attributed to fact notification delays in notifications received from Genesys Info Mart since the previous scrape. Notification delay is calculated as the difference between the moment of notification and the start of the changed period.
|UsedFor=Latency
}}{{PEMetric
|Metric=gcxi_raa_aggregated_count
|Type=Counter
|Label=hierarchy, level, mediaType
|MetricDescription=The number of aggregations completed by RAA since the previous scrape. The data is grouped by aggregation hierarchy name, materialised level (usually SUBHOUR, HOUR, DAY, MONTH) and media type (Online, Offline).
|UsedFor=Traffic
}}{{PEMetric
|Metric=gcxi_raa_aggregated_period_ms
|Type=Counter
|Unit=milliseconds
|Label=hierarchy, level, mediaType
|MetricDescription=The total number of periods aggregated by RAA since the previous scrape.
|SampleValue=10
|UsedFor=Traffic
}}{{PEMetric
|Metric=gcxi_raa_aggregated_duration_ms
|Type=Counter
|Unit=milliseconds
|Label=hierarchy, level, mediaType
|MetricDescription=The total duration of time periods aggregations completed by RAA since the previous scrape.
|UsedFor=Traffic
}}{{PEMetric
|Metric=gcxi_raa_aggregated_delay_ms
|Type=Counter
|Unit=milliseconds
|Label=hierarchy, level, mediaType
|MetricDescription=The total duration of delays for aggregations completed by RAA since the previous scrape. Aggregation delay is calculated as the difference between the moment aggregation competes, and the start of the aggregation range.
|UsedFor=Latency
}}{{PEMetric
|Metric=gcxi_raa_purged_count
|Type=Counter
|Unit=seconds
|Label=table
|MetricDescription=The number of records purged by RAA since the previous scrape. The data is grouped by purged table name.

 
|UsedFor=Traffic
}}{{PEMetric
|Metric=gcxi_raa_purged_duration_ms
|Type=Counter
|Unit=milliseconds
|Label=table
|MetricDescription=The total amount of time spend on purging since the previous scrape.
|UsedFor=Traffic
}}
|AlertsDefined=Yes
|AlertsIntro=The severity of alerts and some thresholds are specified by various ''raa.prometheusRule.alerts.*'' parameters in the '''values.yaml''' file.
|PEAlert={{PEAlert
|Alert=raa-health
|Severity='''Specified by''': {{#replace:raa.prometheusRule.alerts.labels.severity|.|.}} '''Recommended value:''' severe
|AlertDescription=A zero value for a recent period (several scrape intervals) indicates that RAA is not operating.
|BasedOn=gcxi_raa_health_level
|Threshold=Specified by: {{#replace:raa.prometheusRule.alerts.health.for|.|.}} '''Recommended value''': 30m
}}{{PEAlert
|Alert=raa-errors
|Severity='''Specified by''': {{#replace:raa.prometheusRule.alerts.raa-errors.labels.severity|.|.}} in values.yaml. '''Recommended value''': warning
|AlertDescription=A non-zero value indicates that errors have been logged during the scrape interval.
|BasedOn=gcxi_raa_error_count
|Threshold=>0
}}{{PEAlert
|Alert=raa-long-aggregation
|Severity='''Specified by''': {{#replace:raa.prometheusRule.alerts.longAggregation.labels.severity|.|.}} in values.yaml. '''Recommended value''': warning
|AlertDescription=Indicates that the average duration of aggregation queries specified by the hierarchy, level, and mediaType labels is greater than the deadlock-threshold.
|BasedOn=gcxi_raa_aggregated_duration_ms/ gcxi_raa_aggregated_count
|Threshold=Greater than the value (seconds) of raa.prometheusRule.alerts.longAggregation.thresholdSec in values.yaml. '''Recommended value''': 300
}}
}}

@@ Line 24: / Line 24: @@
 |MetricDescription=A health status metric extracted using a dedicated port on the monitor container. The metric value is a sum of values from two different health-checks:
-*a database-based health-check. Results: '''2''', indicates that RAA is working or in maintenance (have received STOP and waits for START command from Genesys Info Mart), or '''0''', which indicates that RAA is not working according to this check.
+*A database-based health-check. Results:
-*a local health-check. Results: '''1,''' indicates that RAA is processing aggregation requests according to local health files, or '''0''' at other times.
+**A result of '''2''' indicates that RAA is working or in maintenance (has received a STOP command from Genesys Info Mart, and will restart only after receiving the START command).
 |SampleValue=0
 |UsedFor=Health check
@@ Line 32: / Line 36: @@
 |Type=Counter
 |Label=cmd
-|MetricDescription=The number of commands received from Genesys Info mart since the previous scrape. Label reflects name of the command. The supported commands are: START, QUIT, EXIT, UPDATE_CONFIG, REAGGREGATE
+|MetricDescription=The number of commands received from Genesys Info mart since the previous scrape. Label reflects the name of the command. The supported commands are: START, QUIT, EXIT, UPDATE_CONFIG, REAGGREGATE
 |SampleValue=10
 |UsedFor=Traffic
@@ Line 38: / Line 42: @@
 |Metric=gcxi_raa_dispatch_count
 |Type=Counter
-|MetricDescription=The number of of dispatch (moving aggregation requests from AGR_NOTIFICATION to PENDING_ARG) events since the previous scrape. Dispatch events typically occur every 15 seconds. Such events are used for aggregation health check based on local files.
+|MetricDescription=The number of dispatch events (moving aggregation requests from AGR_NOTIFICATION to PENDING_ARG) since the previous scrape. Dispatch events typically occur every 15 seconds. Such events are used for aggregation health check based on local files.
 |SampleValue=100
 |UsedFor=Health check
@@ Line 51: / Line 55: @@
 |Metric=gcxi_raa_relaunched_count
 |Type=Counter
-|MetricDescription=The number of times RAA was re-launched since the previous scrape. The aggregation process can exit in the event of an error. Genesys Info Mart sends a START command every 15 minutes during the aggregation period, which causes RAA to relaunch.
+|MetricDescription=The number of times RAA was relaunched since the previous scrape. The aggregation process can exit when an error occurs. Genesys Info Mart sends a START command every 15 minutes during the aggregation period, which causes RAA to relaunch.
 |SampleValue=1
 |UsedFor=Error
@@ Line 92: / Line 96: @@
 |Type=Counter
 |Label=hierarchy, level, mediaType
-|MetricDescription=The number of aggregations completed by RAA since the previous scrape. The data is grouped by aggregation hierarchy name, materialised level (usually SUBHOUR, HOUR, DAY, MONTH) and media type (Online, Offline).
+|MetricDescription=The number of aggregations completed by RAA since the previous scrape. RAA groups the data by aggregation hierarchy name, materialized level (usually SUBHOUR, HOUR, DAY, MONTH), and media type (Online, Offline).
 |UsedFor=Traffic
 }}{{PEMetric
@@ Line 121: / Line 125: @@
 |Unit=seconds
 |Label=table
-|MetricDescription=The number of records purged by RAA since the previous scrape. The data is grouped by purged table name.
+|MetricDescription=The number of records purged by RAA since the previous scrape. RAA groups the data by purged table name.
 <br />
@@ Line 130: / Line 134: @@
 |Unit=milliseconds
 |Label=table
-|MetricDescription=The total amount of time spend on purging since the previous scrape.
+|MetricDescription=The total amount of time spent on purging since the previous scrape.
 |UsedFor=Traffic
 }}
 |AlertsDefined=Yes
-|AlertsIntro=The severity of alerts and some thresholds are specified by various ''raa.prometheusRule.alerts.*'' parameters in the '''values.yaml''' file.
+|AlertsIntro=Various ''raa.prometheusRule.alerts.*'' parameters in the '''values.yaml''' file specify the severity of alerts and some thresholds.
 |PEAlert={{PEAlert
 |Alert=raa-health
 |Severity='''Specified by''': {{#replace:raa.prometheusRule.alerts.labels.severity|.|.<wbr/>}}<br/>'''Recommended value:''' severe
 |AlertDescription=A zero value for a recent period (several scrape intervals) indicates that RAA is not operating.
@@ Line 142: / Line 146: @@
 |Threshold=Specified by: {{#replace:raa.prometheusRule.alerts.health.for|.|.<wbr/>}}<br/> '''Recommended value''': 30m
 }}{{PEAlert
 |Alert=raa-errors
 |Severity='''Specified by''': {{#replace:raa.prometheusRule.alerts.raa-errors.labels.severity|.|.<wbr/>}} in values.yaml. <br/>'''Recommended value''': warning
-|AlertDescription=A non-zero value indicates that errors have been logged during the scrape interval.
+|AlertDescription=A nonzero value indicates that errors have been logged during the scrape interval.
 |BasedOn=gcxi_raa_error_count
 |Threshold=>0