View source for PEC-REP/Current/GCXIPEGuide/GCXIMetrics

{{ArticlePEServiceMetrics
|IncludedServiceId=4e6a78a6-ecb9-4886-8819-016d7f81b06f
|CRD=ServiceMonitor
|Port=8180
|Endpoint=<source lang="text">selector:
    matchLabels:
      gcxi/deployment-code: gcxi{{ template "deploymentCode" . }}</source>
|MetricsUpdateInterval=15 minutes
|MetricsDefined=Yes
|PEMetric={{PEMetric
|Metric=gcxi__projects__info
|Type=Gauge
|Label=<br />

*'''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

{{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.
}}
Default xxx_active values:

*'''true''' for gcxi
*'''false''' for iwd
|MetricDescription=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.
|SampleValue=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
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi__projects__status
|Type=Gauge
|Label=<br />

*'''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?**

Note that the xxx_tested label is logically related to 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.
}}

While xxx_tested and xxx_active are implemented as separate variables, for purposes of monitoring they can be considered the same.
|MetricDescription=Indicates whether all active projects are healthy.
Values:

*'''0''' = all active projects are ok
*non-zero = 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
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi__projects__gcxi__status
|Type=Guage
|Label=<br />

*'''host''' = hostname of the container
*'''tenant_id''' = tenant id
*'''pattern''' = the text pattern in the test report response we are trying to parse out
*'''project''' = project name
*'''report''' = test report name
*'''tested''' = whether the CX Insights project active / tested. Matches the xxx_tested values in the metric gcxi__projects__status.
|MetricDescription=Indicates whether the CX Insights 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)
|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
}}{{PEMetric
|Metric=gcxi__projects__iwd__status
|Type=Gauge
|Label=<br />

*'''host''' = hostname of the container
*'''tenant_id''' = tenant id
*'''pattern''' = the text pattern in the test report response we are trying 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.
|MetricDescription=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)
|SampleValue=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
|UsedFor=Health check
}}{{PEMetric
|Metric=gcxi__cluster__info
|Type=Guage
|Label=<br />

*'''host''' = hostname of the container
*'''tenant_id''' = tenant id (string)
*'''nodes''' = current members of the cluster (hostnames)
|MetricDescription=The number of nodes in MicroStrategy cluster.
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
|UsedFor=Health check
}}{{PEMetric
|Metric=MicroStrategy Performance Counters
|Type=Counter
|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.
}}
|AlertsDefined=Yes
|PEAlert={{PEAlert
|Alert=gcxi__projects__status
|AlertDescription=If the value of cxi__projects__status is greater than 0, this alarm is set, indicating that reporting is not functioning properly.
|BasedOn=cxi__projects__status
|Threshold=< 0
}}{{PEAlert
|Alert=gcxi__cluster__info
|AlertDescription=This alert indicates problems with the cluster states.  Applicable only if you have two or more nodes in a cluster.
|BasedOn=gcxi__cluster__info
}}
}}