Draft:BDS/Current/BDSPEGuide/Metrics - Revision history

WikiSysop: Redirected page to Draft:BDS/Current/BDSPEGuide/BDSMetrics

2022-03-30T13:18:05Z

Redirected page to Draft:BDS/Current/BDSPEGuide/BDSMetrics

Tony.gilchrist@genesys.com at 12:16, June 25, 2021

2021-06-25T12:16:25Z

Tony.gilchrist@genesys.com at 12:31, June 17, 2021

2021-06-17T12:31:19Z

Tony.gilchrist@genesys.com at 12:30, June 17, 2021

2021-06-17T12:30:57Z

Tony.gilchrist@genesys.com at 16:25, June 10, 2021

2021-06-10T16:25:06Z

Tony.gilchrist@genesys.com at 19:13, June 9, 2021

2021-06-09T19:13:25Z

Tony.gilchrist@genesys.com at 13:26, June 7, 2021

2021-06-07T13:26:01Z

Tony.gilchrist@genesys.com at 19:31, June 2, 2021

2021-06-02T19:31:15Z

Julie.munn@genesys.com: Copied manual

2021-06-02T14:17:53Z

Copied manual

New page

{{Article
|Standalone=No
|DisplayName=Metrics
|Context=Learn which metrics you should monitor for <service_name> and when to sound the alarm.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">Include a link to the "suite-level" documentation for monitoring: {{SuiteLevelLink|metrics}}

Describe metrics (compatible with Prometheus endpoints) that customers can use to create their own monitoring dashboard in a tool like Grafana.

Make to identify any metrics that are important to monitor for alarming purposes, and include sample thresholds the customer should alarm on.</div>
|Status=No
}}
|PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e
}}

← Older revision		Revision as of 13:18, March 30, 2022
Line 1:		Line 1:
−	~~{{Article~~	+	#REDIRECT [[Draft:BDS/Current/BDSPEGuide/BDSMetrics]]
−	~~\|Standalone=No~~
−	~~\|DisplayName=Metrics~~
−	~~\|Context=Learn which metrics you should monitor for Billing Data Service (BDS) and when to sound an alarm.~~
−	~~\|ComingSoon=No~~
−	~~\|Section={{Section~~
−	~~\|alignment=Vertical~~
−	\|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the [~~https~~:~~//docs.genesys.com/Documentation/~~BDS/~~9.0.0~~/~~User~~/~~Metrics Billing Data Server User's Guide~~].
−	~~\|Status=No~~
−	~~}}{{Section~~
−	~~\|sectionHeading=Pushgateway and Kubernetes metrics~~
−	~~\|alignment=Vertical~~
−	~~\|structuredtext=Pushgateway:~~
−	~~{{{!}} class="wikitable" role="grid" resolved~~
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Metric: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Metric
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" scope="col" role="columnheader" aria-label="Description: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Description
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" scope="col" role="columnheader" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Alarm suggestion
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}bds_pod_processing_start
−	~~{{!}} class="confluenceTd"{{!}}start time of BDS processing~~
−	~~{{!}} class="confluenceTd"{{!}}If over > 43200 sec ago~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}bds_pod_processing_end
−	~~{{!}} class="confluenceTd"{{!}}end time of BDS processing~~
−	~~{{!}} class="confluenceTd"{{!}}If over bds_pod_processing_start + 43200 sec~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}bds_processing_exit_code
−	~~{{!}} class="confluenceTd"{{!}}processing exit code~~
−	~~{{!}} class="confluenceTd"{{!}}When != 0~~
−	~~{{!}}}~~
−	~~Kubernetes:~~
−	~~{{{!}} class="wikitable" role="grid" resolved~~
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Metric: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Metric
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" scope="col" role="columnheader" aria-label="Description: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Description
−	! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" scope="col" role="columnheader" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Alarm suggestion
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}kube_pod_container_status_terminated_reason
−	~~{{!}} class="confluenceTd"{{!}}shows info about container termination reason~~
−	~~{{!}} class="confluenceTd"{{!}}On Error~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}kube_job_status_start_time
−	~~{{!}} class="confluenceTd"{{!}}can be used to trigger alerts if processing is to long~~
−	~~{{!}} class="confluenceTd"{{!}}> 43200 sec~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}kube_job_status_failed
−	~~{{!}} class="confluenceTd"{{!}}can be used to trigger alerts of failed jobs~~
−	~~{{!}} class="confluenceTd"{{!}}> 0~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}kube_pod_created
−	~~{{!}} class="confluenceTd"{{!}}used to count pod lifetime~~
−	~~{{!}} class="confluenceTd"{{!}}Info~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}kube_job_status_start_time
−	~~{{!}} class="confluenceTd"{{!}}shows started jobs~~
−	~~{{!}} class="confluenceTd"{{!}}Info~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}container_cpu_usage_seconds_total
−	~~{{!}} class="confluenceTd"{{!}}info about used CPU~~
−	~~{{!}} class="confluenceTd"{{!}}Info~~
−	~~{{!}}- role="row"~~
−	{{!}} class="confluenceTd"{{!}}container_memory_usage_bytes
−	~~{{!}} class="confluenceTd"{{!}}info about used MEM~~
−	~~{{!}} class="confluenceTd"{{!}}Info~~
−	~~{{!}}}~~
−	~~\|Status=No~~
−	}}
−	~~\|PEPageType=21ecf3f4-ef12-4276-8872-1e0e3af9561e~~
−	}}

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS  provides for monitoring contact center activity, which are described in There are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the [https://docs.genesys.com/Documentation/BDS/9.0.0/User/Metrics Billing Data Server User's Guide].
+|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS  provides for monitoring contact center activity, which are described in the [https://docs.genesys.com/Documentation/BDS/9.0.0/User/Metrics Billing Data Server User's Guide].
 |Status=No
 }}{{Section

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS  provides for monitoring contact center activity, which are described in There are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the [https://docs.genesys.com/Documentation/BDS/9.0.0/User/Metrics<nowiki> Billing Data Server User's Guide].</nowiki>
+|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS  provides for monitoring contact center activity, which are described in There are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the [https://docs.genesys.com/Documentation/BDS/9.0.0/User/Metrics Billing Data Server User's Guide].
 |Status=No
 }}{{Section

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance, containers, and so on, and are useful for administrator use only. There are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the Billing Data Server User's Guide
+|structuredtext=The metrics described on this page pertain to the internal monitoring of BDS performance and containers, and are intended for administrator use only. These metrics are distinct from the metrics which BDS  provides for monitoring contact center activity, which are described in There are distinct from the metrics which BDS provides for monitoring contact center activity, which are described in the [https://docs.genesys.com/Documentation/BDS/9.0.0/User/Metrics<nowiki> Billing Data Server User's Guide].</nowiki>
 |Status=No
 }}{{Section

@@ Line 2: / Line 2: @@
 |Standalone=No
 |DisplayName=Metrics
-|Context=Learn which metrics you should monitor for <service_name> and when to sound the alarm.
+|Context=Learn which metrics you should monitor for Billing Data Sever (BDS) and when to sound an alarm.
 |ComingSoon=No
 |Section={{Section
@@ Line 8: / Line 8: @@
 |alignment=Vertical
 |structuredtext=Pushgateway:
-{{{!}} class="wikitable" role="grid" resolved=""
+{{{!}} class="wikitable" role="grid" resolved
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Metric: No sort applied, activate to apply an ascending sort" {{!}}Metric
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Metric: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Metric
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Description: No sort applied, activate to apply an ascending sort" {{!}}Description
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" scope="col" role="columnheader" aria-label="Description: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Description
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" {{!}}Alarm suggestion
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" scope="col" role="columnheader" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Alarm suggestion
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*bds_pod_processing_start*
+{{!}} class="confluenceTd"{{!}}*bds_pod_processing_start*
-{{!}} class="confluenceTd" {{!}}start time of BDS processing
+{{!}} class="confluenceTd"{{!}}start time of BDS processing
-{{!}} class="confluenceTd" {{!}}If over > 43200 sec ago
+{{!}} class="confluenceTd"{{!}}If over > 43200 sec ago
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*bds_pod_processing_end*
+{{!}} class="confluenceTd"{{!}}*bds_pod_processing_end*
-{{!}} class="confluenceTd" {{!}}end time of BDS processing
+{{!}} class="confluenceTd"{{!}}end time of BDS processing
-{{!}} class="confluenceTd" {{!}}If over bds_pod_processing_start + 43200 sec
+{{!}} class="confluenceTd"{{!}}If over bds_pod_processing_start + 43200 sec
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*bds_processing_exit_code*
+{{!}} class="confluenceTd"{{!}}*bds_processing_exit_code*
-{{!}} class="confluenceTd" {{!}}processing exit code
+{{!}} class="confluenceTd"{{!}}processing exit code
-{{!}} class="confluenceTd" {{!}}When != 0
+{{!}} class="confluenceTd"{{!}}When != 0
 {{!}}}
 Kubernetes:
-{{{!}} class="wikitable" role="grid" resolved=""
+{{{!}} class="wikitable" role="grid" resolved
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Metric: No sort applied, activate to apply an ascending sort" {{!}}Metric
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Metric: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Metric
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Description: No sort applied, activate to apply an ascending sort" {{!}}Description
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" scope="col" role="columnheader" aria-label="Description: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Description
-! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" tabindex="0" scope="col" role="columnheader" aria-disabled="false" unselectable="on" aria-sort="none" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" {{!}}Alarm suggestion
+! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="2" scope="col" role="columnheader" aria-label="Alarm suggestion: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Alarm suggestion
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*kube_pod_container_status_terminated_reason*
+{{!}} class="confluenceTd"{{!}}*kube_pod_container_status_terminated_reason*
-{{!}} class="confluenceTd" {{!}}shows info about container termination reason
+{{!}} class="confluenceTd"{{!}}shows info about container termination reason
-{{!}} class="confluenceTd" {{!}}On Error
+{{!}} class="confluenceTd"{{!}}On Error
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*kube_job_status_start_time*
+{{!}} class="confluenceTd"{{!}}*kube_job_status_start_time*
-{{!}} class="confluenceTd" {{!}}can be used to trigger alerts if processing is to long
+{{!}} class="confluenceTd"{{!}}can be used to trigger alerts if processing is to long
-{{!}} class="confluenceTd" {{!}}> 43200 sec
+{{!}} class="confluenceTd"{{!}}> 43200 sec
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*kube_job_status_failed*
+{{!}} class="confluenceTd"{{!}}*kube_job_status_failed*
-{{!}} class="confluenceTd" {{!}}can be used to trigger alerts of failed jobs
+{{!}} class="confluenceTd"{{!}}can be used to trigger alerts of failed jobs
-{{!}} class="confluenceTd" {{!}}> 0
+{{!}} class="confluenceTd"{{!}}> 0
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*kube_pod_created*
+{{!}} class="confluenceTd"{{!}}*kube_pod_created*
-{{!}} class="confluenceTd" {{!}}used to count pod lifetime
+{{!}} class="confluenceTd"{{!}}used to count pod lifetime
-{{!}} class="confluenceTd" {{!}}Info
+{{!}} class="confluenceTd"{{!}}Info
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*kube_job_status_start_time*
+{{!}} class="confluenceTd"{{!}}*kube_job_status_start_time*
-{{!}} class="confluenceTd" {{!}}shows started jobs
+{{!}} class="confluenceTd"{{!}}shows started jobs
-{{!}} class="confluenceTd" {{!}}Info
+{{!}} class="confluenceTd"{{!}}Info
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*container_cpu_usage_seconds_total*
+{{!}} class="confluenceTd"{{!}}*container_cpu_usage_seconds_total*
-{{!}} class="confluenceTd" {{!}}info about used CPU
+{{!}} class="confluenceTd"{{!}}info about used CPU
-{{!}} class="confluenceTd" {{!}}Info
+{{!}} class="confluenceTd"{{!}}Info
 {{!}}- role="row"
-{{!}} class="confluenceTd" {{!}}*container_memory_usage_bytes*
+{{!}} class="confluenceTd"{{!}}*container_memory_usage_bytes*
-{{!}} class="confluenceTd" {{!}}info about used MEM
+{{!}} class="confluenceTd"{{!}}info about used MEM
-{{!}} class="confluenceTd" {{!}}Info
+{{!}} class="confluenceTd"{{!}}Info
 {{!}}}
 |Status=No