Difference between revisions of "PEC-REP/Current/GCXIPEGuide/GCXIMetrics"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
 
Line 11: Line 11:
 
|Metric=gcxi__projects__info
 
|Metric=gcxi__projects__info
 
|Type=Gauge
 
|Type=Gauge
−
|Label=<br />
+
|Label=*'''host''' = hostname of the container
−
 
+
*'''tenant_id''' = tenant ID
−
*'''host''' = hostname of the container
 
−
*'''tenant_id''' = tenant id
 
 
*'''gcxi_active''' = is project 'CX Insights' active
 
*'''gcxi_active''' = is project 'CX Insights' active
 
*'''gcxi_version''' = project 'CX Insights' version
 
*'''gcxi_version''' = project 'CX Insights' version
Line 20: Line 18:
 
*'''iwd_version''' = project 'CX Insights for iWD' version
 
*'''iwd_version''' = project 'CX Insights for iWD' version
  
−
{{NoteFormat|Projects are considered active only if deployed and configured such that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and, thus, are not reflected in monitoring results.
+
{{NoteFormat|This metric considers projects to be active only if deployed and configured so that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and this metric does not reflect them in monitoring results.|}}
−
}}
 
 
Default xxx_active values:
 
Default xxx_active values:
  
Line 33: Line 30:
 
|Metric=gcxi__projects__status
 
|Metric=gcxi__projects__status
 
|Type=Gauge
 
|Type=Gauge
−
|Label=<br />
+
|Label=* '''host''' = hostname of the container
−
 
+
* '''tenant_id''' = tenant ID
−
*'''host''' = hostname of the container
 
−
*'''tenant_id''' = tenant id
 
 
*'''gcxi_tested''' = was 'CX Insights' health status accounted in the overall health value?**
 
*'''gcxi_tested''' = was 'CX Insights' health status accounted in the overall health value?**
 
*'''iwd_tested''' = was 'CX Insights for iWD' health status accounted in the overall health value?**
 
*'''iwd_tested''' = was 'CX Insights for iWD' health status accounted in the overall health value?**
  
−
Note that the xxx_tested label is logically related to xxx_active label.
+
The xxx_tested label is logically related to the xxx_active label.
  
−
{{NoteFormat|Projects are considered active only if deployed and configured such that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and, thus, are not reflected in monitoring results.
+
{{NoteFormat|This metric considers projects to be active only if deployed and configured so that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and this metric does not reflect them in monitoring results.|}}
−
}}
 
  
 
While xxx_tested and xxx_active are implemented as separate variables, for purposes of monitoring they can be considered the same.
 
While xxx_tested and xxx_active are implemented as separate variables, for purposes of monitoring they can be considered the same.
Line 49: Line 43:
 
Values:
 
Values:
  
−
*'''0''' = all active projects are ok
+
*'''0''' = all active projects are healthy.
−
*non-zero = at least one active project failed
+
*nonzero = at least one active project failed.
 
|SampleValue=gcxi__projects__status{host="gcxi-1-22-30",tenant_id="22-30",gcxi_tested="true",iwd_tested="false"} 0 1614350887562
 
|SampleValue=gcxi__projects__status{host="gcxi-1-22-30",tenant_id="22-30",gcxi_tested="true",iwd_tested="false"} 0 1614350887562
 
|UsedFor=Health check
 
|UsedFor=Health check
Line 59: Line 53:
  
 
*'''host''' = hostname of the container
 
*'''host''' = hostname of the container
−
*'''tenant_id''' = tenant id
+
*'''tenant_id''' = tenant ID
−
*'''pattern''' = the text pattern in the test report response we are trying to parse out
+
*'''pattern''' = the text pattern in the test report response to parse out
 
*'''project''' = project name
 
*'''project''' = project name
 
*'''report''' = test report name
 
*'''report''' = test report name
−
*'''tested''' = whether the CX Insights project active / tested. Matches the xxx_tested values in the metric gcxi__projects__status.
+
*'''tested''' = whether the CX Insights project is active and tested. This value matches the xxx_tested values in the metric gcxi__projects__status.
 
|MetricDescription=Indicates whether the CX Insights project is healthy.
 
|MetricDescription=Indicates whether the CX Insights project is healthy.
 
Values:
 
Values:
Line 70: Line 64:
 
*'''1''' = url not available
 
*'''1''' = url not available
 
*'''2''' = test login failed
 
*'''2''' = test login failed
−
*'''3''' = test report run failed (unable to parse expected pattern in response)
+
*'''3''' = test run of the report failed (unable to parse expected pattern in response)
 
|SampleValue=gcxi__projects__gcxi__status{host="gcxi-1-22-30",tenant_id="22-30",pattern="Genesys Info Mart",project="CX Insights",report="CX Insights Schema Version",tested="true"} 0 1614350887562
 
|SampleValue=gcxi__projects__gcxi__status{host="gcxi-1-22-30",tenant_id="22-30",pattern="Genesys Info Mart",project="CX Insights",report="CX Insights Schema Version",tested="true"} 0 1614350887562
 
|UsedFor=Health check
 
|UsedFor=Health check
Line 79: Line 73:
  
 
*'''host''' = hostname of the container
 
*'''host''' = hostname of the container
−
*'''tenant_id''' = tenant id
+
*'''tenant_id''' = tenant ID
−
*'''pattern''' = the text pattern in the test report response we are trying to parse out
+
*'''pattern''' = the text pattern in the test report response to parse out
 
*'''project''' = project name
 
*'''project''' = project name
 
*'''report''' = test report name
 
*'''report''' = test report name
Line 96: Line 90:
 
|Metric=gcxi__cluster__info
 
|Metric=gcxi__cluster__info
 
|Type=Guage
 
|Type=Guage
−
|Label=<br />
+
|Label=*'''host''' = hostname of the container
−
 
 
−
*'''host''' = hostname of the container
 
 
*'''tenant_id''' = tenant id (string)
 
*'''tenant_id''' = tenant id (string)
 
*'''nodes''' = current members of the cluster (hostnames)
 
*'''nodes''' = current members of the cluster (hostnames)
−
|MetricDescription=The number of nodes in MicroStrategy cluster.
+
|MetricDescription=The number of nodes in the MicroStrategy cluster.
 
Value: Either '''1''' or '''2''', depending on configuration.
 
Value: Either '''1''' or '''2''', depending on configuration.
 
|SampleValue=gcxi__cluster__info{host="gcxi-1-22-30",tenant_id="22-30",nodes="gcxi-0-22-30,gcxi-1-22-30"} 2 1614350887562
 
|SampleValue=gcxi__cluster__info{host="gcxi-1-22-30",tenant_id="22-30",nodes="gcxi-0-22-30,gcxi-1-22-30"} 2 1614350887562
Line 110: Line 102:
 
|MetricDescription=GCXI exports some MicroStrategy performance metrics (sometimes called Performance Counters). Not served by HTTP endpoint.
 
|MetricDescription=GCXI exports some MicroStrategy performance metrics (sometimes called Performance Counters). Not served by HTTP endpoint.
  
−
Refer to [https://www2.microstrategy.com/producthelp/Current/SystemAdmin/WebHelp/Lang_1033/Content/Configuring_what_is_logged.htm Performance Counters for Specific MicroStrategy Features] in the MicroStrategy documentation for further details.
+
For more information about performance metrics, see [https://www2.microstrategy.com/producthelp/Current/SystemAdmin/WebHelp/Lang_1033/Content/Configuring_what_is_logged.htm Performance Counters for Specific MicroStrategy Features] in the MicroStrategy documentation.
 
}}
 
}}
 
|AlertsDefined=Yes
 
|AlertsDefined=Yes

Latest revision as of 20:00, April 7, 2022

This topic is part of the manual Genesys Customer Experience Insights Private Edition Guide for version Current of Reporting.

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

Related documentation:
Service CRD or annotations? Port Endpoint/Selector Metrics update interval
GCXI ServiceMonitor 8180 
selector:
    matchLabels:
      gcxi/deployment-code: gcxi{{ template "deploymentCode" . }}
 15 minutes

See details about:

Metrics[edit source]

Metric and description Metric details Indicator of
gcxi__projects__info

General information about currently deployed GCXI projects. The labels of this metric provide important information. The metric value itself is always 1, and does not provide any information.

Unit:

Type: Gauge
Label: *host = hostname of the container

  • tenant_id = tenant ID
  • gcxi_active = is project 'CX Insights' active
  • gcxi_version = project 'CX Insights' version
  • iwd_active = is project 'CX Insights for iWD' active
  • iwd_version = project 'CX Insights for iWD' version
Important
This metric considers projects to be active only if deployed and configured so that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and this metric does not reflect them in monitoring results.

Default xxx_active values:

  • true for gcxi
  • false for iwd

Sample value: gcxi__projects__info{host="gcxi-1-22-30",tenant_id="22-30",gcxi_active="true",gcxi_version="9.0.018.00",iwd_active="false",iwd_version="9.0.018.00",version=""} 1 1614350887562

Health check
gcxi__projects__status

Indicates whether all active projects are healthy. Values:

  • 0 = all active projects are healthy.
  • nonzero = at least one active project failed.
 Unit:

Type: Gauge
Label: * host = hostname of the container

  • tenant_id = tenant ID
  • gcxi_tested = was 'CX Insights' health status accounted in the overall health value?**
  • iwd_tested = was 'CX Insights for iWD' health status accounted in the overall health value?**

The xxx_tested label is logically related to the xxx_active label.

Important
This metric considers projects to be active only if deployed and configured so that reports in the project are expected to return data. In scenarios where only the CX Insights project or only the CX Insights for iWD project is deployed, reports in non-active projects are not expected to work and this metric does not reflect them in monitoring results.

While xxx_tested and xxx_active are implemented as separate variables, for purposes of monitoring they can be considered the same.
Sample value: gcxi__projects__status{host="gcxi-1-22-30",tenant_id="22-30",gcxi_tested="true",iwd_tested="false"} 0 1614350887562

Health check
gcxi__projects__gcxi__status

Indicates whether the CX Insights project is healthy. Values:

  • 0 = project ok
  • 1 = url not available
  • 2 = test login failed
  • 3 = test run of the report failed (unable to parse expected pattern in response)
 Unit:

Type: Guage
Label:

  • host = hostname of the container
  • tenant_id = tenant ID
  • pattern = the text pattern in the test report response to parse out
  • project = project name
  • report = test report name
  • tested = whether the CX Insights project is active and tested. This value matches the xxx_tested values in the metric gcxi__projects__status.

Sample value: gcxi__projects__gcxi__status{host="gcxi-1-22-30",tenant_id="22-30",pattern="Genesys Info Mart",project="CX Insights",report="CX Insights Schema Version",tested="true"} 0 1614350887562

Health check
gcxi__projects__iwd__status

Indicates whether the CX Insights for iWD project is healthy. Values:

  • 0 = project ok
  • 1 = url not available
  • 2 = test login failed
  • 3 = test report run failed (unable to parse expected pattern in response)
 Unit:

Type: Gauge
Label:

  • host = hostname of the container
  • tenant_id = tenant ID
  • pattern = the text pattern in the test report response to parse out
  • project = project name
  • report = test report name
  • tested = whether the CX Insights for iWDproject active / tested. Matches the xxx_tested values in the metric gcxi__projects__status.

Sample value: gcxi__projects__iwd__status{host="gcxi-1-22-30",tenant_id="22-30",pattern="com/genesys/iwd/dm/etl",project="CX Insights for iWD",report="iWD DB Schema Report",tested="false"} 0 1614350887562

Health check
gcxi__cluster__info

The number of nodes in the MicroStrategy cluster. Value: Either 1 or 2, depending on configuration.

Unit:

Type: Guage
Label: *host = hostname of the container

  • tenant_id = tenant id (string)
  • nodes = current members of the cluster (hostnames)

Sample value: gcxi__cluster__info{host="gcxi-1-22-30",tenant_id="22-30",nodes="gcxi-0-22-30,gcxi-1-22-30"} 2 1614350887562

Health check
MicroStrategy Performance Counters

GCXI exports some MicroStrategy performance metrics (sometimes called Performance Counters). Not served by HTTP endpoint.

For more information about performance metrics, see Performance Counters for Specific MicroStrategy Features in the MicroStrategy documentation.

Unit:

Type: Counter
Label:
Sample value:

Alerts[edit source]

The following alerts are defined for GCXI.

Alert Severity Description Based on Threshold
gcxi__projects__status If the value of cxi__projects__status is greater than 0, this alarm is set, indicating that reporting is not functioning properly. cxi__projects__status < 0


gcxi__cluster__info This alert indicates problems with the cluster states. Applicable only if you have two or more nodes in a cluster. gcxi__cluster__info
Retrieved from "https://all.docs.genesys.com/PEC-REP/Current/GCXIPEGuide/GCXIMetrics (2025-07-20 13:00:50)"
Comments or questions about this documentation? Contact us for support!