Genesys Documentation - User contributions [en]

RN/GVPConfiguration Server/100.0.100.0056

2022-04-06T20:58:14Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=44476ff3-40f8-4640-bd8b-7c0834a1fe55
|JQL=issuekey in (GVP-44633)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=Security improvements.
|Containers=*gvp-configserver-100.0.1000056.tgz
*gvp_confserv:100.0.100.0056
*gvp_configserver_configserverinit:100.0.100.0056
*gvp_configserver_servicehandler:100.0.100.0056
}}
{{Issue
|TicketNumber=GVP-44633
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=This release contains Security remediation for Prisma/BlackDuck security vulnerabilities found/reported by JPMC.
|LocalContent=This release contains Security remediation for Prisma/BlackDuck security vulnerabilities.
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}
{{Issue
|TicketNumber=GVP-44625
|IssueCategoryId=c749afa5-fd21-49e4-83d4-0e6ebd8ed618
|LocalContent=This release includes upgraded base images of Configuration Server containers to address the glibc security issue. The vulnerability is RHSA-2021:4358.
}}

RN/GVPMedia Control Platform/100.0.100.0070

2022-04-06T20:38:51Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=0ed06171-d761-4c0c-855b-af391b57e8a5
|JQL=issuekey in (GVP-44612)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-04-06
|PrivateEditionReleaseDate=2022-04-06
|Highlight=Support Bearer Token for GAuth for future use cases.
|Containers=*gvp-mcp-100.0.1000070.tgz
*gvp_mcp:100.0.100.0070 (updated)
*gvp_mcp_confighandler:100.0.100.0070 (updated)
*gvp_mcp_servicehandler:100.0.100.0070 (updated)
*gvp_snmp:100.0.100.0027 (updated)
*recording-provider:100.0.100.1610 (no change)
*fluent/fluent-bit:1.8.2 (no change)
}}
{{Issue
|TicketNumber=GVP-44612
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=Support Bearer Token for GAuth for future use cases.
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/InteractionServer/100.0.005.1205

2022-03-31T20:08:54Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=a9b31423-d59d-4402-b7cd-c18316cd517e
|JQL=issuekey in (CPE-2836)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-03-31
|PrivateEditionReleaseDate=2022-03-31
|HighlightBoilerplateId=f1dd5bf5-71af-4f28-94cc-185d57841e95
}}
{{Issue
|TicketNumber=CPE-2836
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|NFBoilerplateId=f2aefbc5-e54b-480a-918f-debc77229718
|SupportingDocumentation={{Link-AnywhereElse|product=IXN|version=Current|manual=IXNPEGuide}}
}}

RN/GVPResource Manager/100.0.100.0152

2022-03-23T15:42:00Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=35daaa1d-708e-48b8-af6c-cf258cbd4e0a
|JQL=issuekey in (GVP-44483)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=*Security improvement.
*Support for SIP TLS and SRTP.
|Containers=*gvp-rm-100.0.1000152.tgz
*gvp_rm:100.0.100.0152
*gvp_rm_cfghandler:100.0.100.0152
*gvp_snmp:100.0.100.0012
*fluent/fluent-bit:1.8.2
}}
{{Issue
|TicketNumber=GVP-44483
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=Added support for SIP TLS and SRTP
|LocalContent=Added support for SIP TLS and Secure Real-time Transport Protocol (SRTP).
}}
{{Issue
|TicketNumber=GVP-44593
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=This release contains Security remediation for the following security vulnerabilities reported:

*io.netty_netty-all (CVE-2021-37137, CVE-2021-37136, CVE-2021-43797)
*com.fasterxml.jackson.core_jackson-databind (PRISMA-2021-0213)
*org.eclipse.jetty_jetty-server (PRISMA-2021-0182)
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/GVPService Discovery/100.0.100.0055

2022-03-23T15:40:48Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=38f7f170-d83e-483b-a2ca-4dd424a28fde
|JQL=issuekey in (GVP-44483)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-03-23
|PrivateEditionReleaseDate=2022-03-23
|Highlight=Support for SIP TLS and SRTP.
|Containers=* gvp-sd-100.0.1000055.tgz
* gvp_sd:100.0.100.0055

 
}}
{{Issue
|TicketNumber=GVP-44483
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=Added support for SIP TLS and SRTP
|LocalContent=Added support for SIP TLS and Secure Real-time Transport Protocol (SRTP).
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/GVPMedia Control Platform/100.0.100.0068

2022-03-23T15:37:09Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=0ed06171-d761-4c0c-855b-af391b57e8a5
|JQL=issuekey in (GVP-44483)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-03-23
|PrivateEditionReleaseDate=2022-03-23
|Highlight=Support for SIP TLS and SRTP.
|Containers=*gvp-mcp-100.0.1000046.tgz
*gvp_mcp:100.0.100.0068 (updated)
*gvp_mcp_confighandler:100.0.100.0068 (updated)
*gvp_mcp_servicehandler:100.0.100.0068 (updated)
*gvp_snmp:100.0.100.0012 (no change)
*recording-provider:100.0.100.1610 (no change)
*fluent/fluent-bit:1.8.2 (no change)
}}
{{Issue
|TicketNumber=GVP-44483
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=Added support for SIP TLS and SRTP
|LocalContent=Added support for SIP TLS and Secure Real-time Transport Protocol (SRTP).
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

IXN

2022-03-03T10:08:07Z

Karl.Abraham: Published

{{MintyDocsProduct
|displayname=Interaction Server
|contentarea=Genesys Multicloud CX
|landingpage=No
|definition=Interaction Server controls interaction processing according to workflows as configured by Interaction Routing Designer.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Release Notes
|Description=Find out about changes in each release.
|Links=*{{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=InteractionServer|display text=Interaction Server Release Notes}}
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Private Edition
|Description=Find detailed information about how to deploy this service in your environment.
|Links=* {{Link-AnywhereElse|product=IXN|version=Current|manual=IXNPEGuide|display text=Interaction Server Private Edition Guide}}
|Columns=No
}}
|workspace_id=IXN
}}

Draft:IXN

2022-03-03T10:07:50Z

Karl.Abraham: Added description for Private Edition Guide.

IXN

2022-03-03T09:58:27Z

Karl.Abraham: Published

{{MintyDocsProduct
|displayname=Interaction Server
|contentarea=Genesys Multicloud CX
|landingpage=No
|definition=Interaction Server controls interaction processing according to workflows as configured by Interaction Routing Designer.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Release Notes
|Description=Find out about changes in each release.
|Links=*{{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=InteractionServer|display text=Interaction Server Release Notes}}
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Private Edition
|Description=*{{Link-AnywhereElse|product=IXN|version=Current|manual=IXNPEGuide|display text=Interaction Server Private Edition Guide}}
|Columns=No
}}
|workspace_id=IXN
}}

Draft:IXN

2022-03-03T09:57:41Z

Karl.Abraham: Updated the landing page with links

{{MintyDocsProduct
|displayname=Interaction Server
|contentarea=Genesys Multicloud CX
|landingpage=No
|definition=Interaction Server controls interaction processing according to workflows as configured by Interaction Routing Designer.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Release Notes
|Description=Find out about changes in each release.
|Links=*{{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=InteractionServer|display text=Interaction Server Release Notes}}
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Private Edition
|Description=*{{Link-AnywhereElse|product=IXN|version=Current|manual=IXNPEGuide|display text=Interaction Server Private Edition Guide}}
|Columns=No
}}
|workspace_id=IXN
}}

RN/GVPService Discovery/100.0.100.0046

2022-02-22T18:04:35Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=38f7f170-d83e-483b-a2ca-4dd424a28fde
|JQL=issuekey in (GVP-44559)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=Important security improvements.
|Containers=* gvp-sd-100.0.1000046.tgz
* gvp_sd:100.0.100.0046
}}
{{Issue
|TicketNumber=GVP-44559
|IssueCategoryId=c749afa5-fd21-49e4-83d4-0e6ebd8ed618
|Content=This release includes important security fixes related to the Apache Log4j 2 vulnerability (CVE-2021-44228). In particular, the Log4j library included with GVP Service Discovery has been upgraded to version 2.17.1.
|LocalContent=This release includes important security fixes related to the Apache Log4j 2 vulnerability (CVE-2021-44228). In particular, the Log4j library included with GVP Service Discovery has been upgraded to version 2.17.1.
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/GVPConfiguration Server/100.0.100.0056

2022-02-22T18:04:25Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=44476ff3-40f8-4640-bd8b-7c0834a1fe55
|JQL=issuekey in (GVP-44633)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=Security improvements.
|Containers=*gvp-configserver-100.0.1000056.tgz
*gvp_confserv:100.0.100.0056
*gvp_configserver_configserverinit:100.0.100.0056
*gvp_configserver_servicehandler:100.0.100.0056
}}
{{Issue
|TicketNumber=GVP-44633
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=This release contains Security remediation for Prisma/BlackDuck security vulnerabilities found/reported by JPMC.
|LocalContent=This release contains Security remediation for Prisma/BlackDuck security vulnerabilities reported by JPMC.
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}
{{Issue
|TicketNumber=GVP-44625
|IssueCategoryId=c749afa5-fd21-49e4-83d4-0e6ebd8ed618
|LocalContent=This release includes upgraded base images of Configuration Server containers to address the glibc security issue. The vulnerability is RHSA-2021:4358.
}}

RN/GVPResource Manager/100.0.100.0152

2022-02-22T18:04:13Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=35daaa1d-708e-48b8-af6c-cf258cbd4e0a
|JQL=issuekey in (GVP-44593)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=Security improvements.
|Containers=*gvp-rm-100.0.1000152.tgz
*gvp_rm:100.0.100.0152
*gvp_rm_cfghandler:100.0.100.0152
*gvp_snmp:100.0.100.0012
*fluent/fluent-bit:1.8.2
}}
{{Issue
|TicketNumber=GVP-44593
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=
|LocalContent=This release contains Security remediation for the following security vulnerabilities reported:

*io.netty_netty-all (CVE-2021-37137, CVE-2021-37136, CVE-2021-43797)
*com.fasterxml.jackson.core_jackson-databind (PRISMA-2021-0213)
 
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/GVPReporting Server/100.0.100.0133

2022-02-22T18:04:00Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=aacab4b7-c79e-4748-8b7e-51563628566a
|JQL=issuekey in (GVP-44593)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-22
|PrivateEditionReleaseDate=2022-02-22
|Highlight=Security improvements.
|Containers=*gvp-rs-100.0.1000133.tgz
*gvp_rs_init:100.0.100.0133
*gvp_rs:100.0.100.0133
*gvp_snmp:100.0.100.0012
}}
{{Issue
|TicketNumber=GVP-44593
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|Content=
|LocalContent=This release contains Security remediation for the following security vulnerabilities reported:

* io.netty_netty-all (CVE-2021-37137, CVE-2021-37136, CVE-2021-43797)
* com.fasterxml.jackson.core_jackson-databind (PRISMA-2021-0213)
* org.eclipse.jetty_jetty-server (PRISMA-2021-0182)
|SupportingDocumentation={{Link-AnywhereElse|product=GVP|version=Current|manual=GVPPEGuide}}
}}

RN/InteractionServer/100.0.005.1200

2022-02-16T04:13:34Z

Karl.Abraham: Published

{{ComponentRN
|ComponentId=a9b31423-d59d-4402-b7cd-c18316cd517e
|JQL=issuekey in (CPE-2336)
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-11
|PrivateEditionReleaseDate=2022-02-11
|Highlight=IXN Node and IXN VQ Node use latest NodeJS v.16. 
|Containers=*ixn-100.0.003+16.tgz
*interaction_server:100.0.005.1200
*ixn_vq_node:100.0.005.0504
*ixn_node:100.0.005.1101
}}
{{Issue
|TicketNumber=IXN-6744
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=IXN Node and IXN VQ Node use latest NodeJS v.16.
|SupportingDocumentation={{Link-AnywhereElse|product=IXN|version=Current|manual=IXNPEGuide}}
}}

IXN/Current/IXNPEGuide

2022-01-24T07:42:07Z

Karl.Abraham: Published

{{MintyDocsManual
|version=Current
|manual=Deployment
|defaultform=Form:Article
|alternateforms=Form:ArticlePEServiceMetrics, Form:ArticlePEServiceObservability, Form:ArticleUnstructured, Form:TaskSummary
|displayname={{MINTYDOCSPRODUCT}} Private Edition Guide
|topicslist=* -Overview
** Overview
** Architecture
** HADR
* -Configure and deploy
** Planning
** Configure
** Provision
** Deploy
** Upgrade
* -Observability
** Observability
** Interaction Server metrics
** Logging
|Auto=Crafted summary table
|DisplayName=Test
|Context=Find links to all the topics in this guide.
|Description=Interaction Server is a service available with the Genesys Multicloud CX private edition offering.
|TSSection={{TSSection
|sectionheading=Overview
|description=Learn more about Interaction Server, its architecture, and how to support high availability and disaster recovery.
|relatedarticles=*{{Link-SomewhereInThisVersion|topic=Overview}}
*{{Link-SomewhereInThisVersion|topic=Architecture}}
*{{Link-SomewhereInThisVersion|topic=HADR}}
}}{{TSSection
|sectionheading=Configure and deploy
|description=Find out how to configure and deploy Interaction Server.
|relatedarticles=*{{Link-SomewhereInThisVersion|topic=Planning}}
*{{Link-SomewhereInThisVersion|topic=Configure}}
*{{Link-SomewhereInThisVersion|topic=Provision}}
*{{Link-SomewhereInThisVersion|topic=Deploy}}
*{{Link-SomewhereInThisVersion|topic=Upgrade}}
}}{{TSSection
|sectionheading=Observability
|description=Learn how to monitor Interaction Server with metrics and logging.
|relatedarticles=*{{Link-SomewhereInThisVersion|manual=IXNPEGuide|topic=Observability}}
*{{Link-SomewhereInThisVersion|topic=Logging}}
}}
|product=Draft:PrivateEdition
|inherit=no
|pagination=no
|ServiceId=5b93c36d-cbc2-49e6-97d9-b0ed4b69aff4
|Notice=EAP
}}

IXN/Current/IXNPEGuide/Interaction Server metrics

2022-01-24T07:38:39Z

Karl.Abraham: Published

{{ArticlePEServiceMetrics
|IncludedServiceId=ed7ae447-cc86-42d1-a856-92a802e32dd5
|CRD=PodMonitor
|Port=13131,

13133,

13139
|Endpoint=option '''ixnServer.ports.health''' - default port 13131 - Endpoint: “/health/prometheus/all”

option '''ixnNode.ports.default''' - default port 13133 - Endpoint: “/metrics”

option '''ixnVQNode.ports.health''' - default port 13139 - Endpoint: “/metrics”

'''Note''': The above options are references to ports that match endpoints. Use these options to perform the associated query.
|MetricsUpdateInterval=Default
|MetricsDefined=Yes
|MetricsIntro=This table includes IXN Server metrics and IXN Node metrics. IXN Node metrics begin with the prefix ''ixnnode''.

'''Note''': There are more metrics than the ones listed in the table. However, only the metrics listed in the table are supported.
|PEMetric={{PEMetric
|Metric=ixn_health_info_current_clients
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of clients that are connected to IXN at the moment.
|SampleValue=5
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_current_routers
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of 'connected to' IXN routers.
|SampleValue=1
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_client_count { client_type_name="Agent application" }
|Type=Gauge
|Unit=Amount
|Label=client_type_name. See the metric description for more details.
|MetricDescription=Indicates the number of clients with specified type, connected to IXN.

'''Label descriptions''':

*client_type_name - type of connected clients. Possible values are:
**Unknown
**Proxy
**Agent application
**Media server
**Reporting engine
**Routing engine
**Universal router
**Third party client.

 
|SampleValue=101
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_total_submitted { router_name="URServer" }
|Type=Counter
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the total number of interactions that have been submitted to the router.

'''Label descriptions''':

router_name - the name of the router into which the interactions have been submitted.
|SampleValue=33
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_load_count { router_name="URServer", strategy_name="AAAstarterStrategy", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of strategies with specified name loaded into a specified router.

'''Label descriptions''':

*router_name - the name of the router into which the interactions are loaded
*strategy_name - name of strategy
*strategy_tenant - tenant number

 
|SampleValue=1
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_current_capacity { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the current capacity of a specified router - the number of interactions, not including those already submitted, that can be submitted into the router.

'''Label descriptions''':

router_name - name of router.
|SampleValue=987
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_currently_submitted { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that are in a specified router.

'''Label descriptions''':

router_name - name of router.
|SampleValue=13
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_strategies
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates number of strategies which are associated with active submitters.
|SampleValue=11
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_max_submitted { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the maximum capacity of specified router - the number of interactions, that can be submitted into the router.

'''Label descriptions''':

*router_name - name of router.

''ixn_health_info_router_max_submitted = ixn_health_info_router_currently_submitted + ixn_health_info_router_current_capacity''

 
|SampleValue=1000
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_database_requests
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current database requests queue length.
|SampleValue=0
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_total_database_requests
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of processed database requests from IXN application start till current moment.
|SampleValue=75
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_database_connections
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current number of DB connections.
|SampleValue=5
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_total_database_deadlocks
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of database queries that end up with a deadlock for all the time since IXN started.
|SampleValue=0
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_last_submitted_at { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Unix timestamp
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the Unix timestamp when last interaction has been submitted to router for specified strategy.

'''Label descriptions''':

*router_name - name of router;
*strategy_name - name of strategy;
*strategy_tenant - tenant number.

 
|SampleValue=1618322383
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_waiting_processing { queue_name="AAAstarterQueue", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the current number of interactions with specified media type that are waiting for processing in a specified queue.

'''Label descriptions''':

*queue_name - name of queue;
*queue_tenant - tenant number;
*media_name - media type.

Note: This value is provided in Pulse as well.
|SampleValue=0
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_agent_logged_in_count { agent_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=agent_tenant. See the metric description for more details.
|MetricDescription=Indicates the current number of logged in agents.

'''Label descriptions''':

agent_tenant - tenant number.
|SampleValue=565
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_queue_media_in_router { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of the interactions with specified media type from a specified queue being routed.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type
|SampleValue=10
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_on_agent { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of the interactions with specified media type from specified queue being handled by agents.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type
|SampleValue=5
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_current_length { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of interactions with specified media type that are waiting processing in specified queue and were never delivered to agent.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type

'''Note''': This value is provided in Pulse as well.
|SampleValue=2
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_in_processing { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the sum of the interactions with specified media type from specified queue being routed by routers and being handled by agents.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type

''ixn_health_info_queue_media_in_processing = ixn_health_info_queue_media_in_router + ixn_health_info_queue_media_on_agent''

'''Note''': This value is provided in Pulse as well.
|SampleValue=15
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_currently_submitted { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions which are submitted to specified router by specified strategy at the moment.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=3
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_current_capacity { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that can be submitted more to specified router by specified strategy.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=197
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_total_submitted { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Counter
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that were submitted to specified router by specified strategy since IXN app start till now.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=9
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_interactions_pulled_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of the interactions pulled for the specific strategy.

'''Label descriptions''':

strategy - The name of the strategy for which interactions are pulled.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_routing_sessions_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current number of the routing sessions in routing.
|UsedFor=Workload
}}{{PEMetric
|Metric=ixnnode_all_instructions_received_total
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of instructions (of any type) received from ORS service. 
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_routing_instructions_received_total
|Type=Counter
|Unit=Amount
|Label=strategy, type. See the metric description for more details.
|MetricDescription=Indicates the total number of received routing instructions.

'''Label descriptions''':

*strategy - The name of the strategy for which routing instructions is received.
*type - The type of the instruction. It takes values "terminal" and "non-terminal". Terminal instructions are RequestDeliver, RequestPlaceInQueue, RequestPlaceInWorkbin, RequestStopProcessing.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_status
|Type=Gauge
|Unit=Status
|Label=redis_client. See the metric description for more details. er".
|MetricDescription=Indicates the status of Redis client.

'''Label descriptions''':

redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".

Value:

0 - Not Ready

1 - Ready
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_errors_total
|Type=Counter
|Unit=Amount
|Label=redis_client. See the metric description for more details.
|MetricDescription=Indicates the total number of errors occurred on Redis client.

'''Label descriptions''':

redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_redis_client_node_status
|Type=Gauge
|Unit=Status
|Label=redis_client, node. See the metric description for more details.
|MetricDescription=Indicates the status of connection to individual nodes of Redis server (in singleton mode matches to ixnnode_redis_client_status).

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*node - The node of Redis server for which the metric is present as "host:port".

Value:

0 - Ready

1 - Not Ready

2 - Wait (so far there have been no connection attempts)
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_node_errors_total
|Type=Counter
|Unit=Amount
|Label=redis_client, node. See the metric description for more details.
|MetricDescription=Indicates the total number of errors occurred on individual nodes of Redis client (in singleton mode matches to ixnnode_redis_client_errors_total).

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*node - The node of Redis server for which the metric is present as "host:port".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_redis_commands_completed_total
|Type=Counter
|Unit=Amount
|Label=redis_client, command. See the metric description for more details.
|MetricDescription=Indicates the total number of successfully completed redis commands.

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*command - The Redis command for which the metric is present. It takes values "xadd", "xread", "xdel".
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_redis_commands_failed_total
|Type=Counter
|Unit=Amount
|Label=redis_client, command. See the metric description for more details.
|MetricDescription=Indicates the total number of failed redis commands.

'''Label desriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*command - The Redis command for which the metric is present. It takes values "xadd", "xread", "xdel".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_rq_client_status
|Type=Gauge
|Unit=Status
|Label=rq_node. See the metric description for more details.
|MetricDescription=Indicates the status of connection to RQ Service nodes.

'''Label descriptions''':

rq_node - RQ Service node for which the metric is present.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_rq_requests_failed_total
|Type=Counter
|Unit=Amount
|Label=type. See the metric description for more details.
|MetricDescription=Indicates the total number of failed requests to RQ Service.

'''Label descriptions''':

type - The type of the failed requests. It takes values "isp_event" - interaction protocol evnts and "ixn_ping" - health check messages.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_instructions_processing_queue_concurrency_limit
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the maximum number of routing instructions that can be processed in parallel.
|UsedFor=n/a
}}{{PEMetric
|Metric=ixnnode_instructions_processing_queue_size
|Type=Gauge
|Unit=Amount
|Label=type. See the metric description for more details.
|MetricDescription=Indicates the number of instructions received from ORS currently being processed.

'''Label descriptions''':

type - The type of the instruction. It takes values "isp_request" - routing instruction and "ixn_ping" - reply to health check message.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_pull_request_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of RequestPull requests successfully completed by InteractionServer.

'''Label descriptions''':

strategy - The strategy for which interactions are pulled.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_route_request_sent_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of route requests successfully sent to ORS.

'''Label descriptions''':

strategy - The strategy to which requests are sent.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_route_request_failed_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of route requests failed to send to ORS.

'''Label descriptions''':

strategy - The strategy to which requests are sent.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_instructions_processed_by_ixn_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of routing instructions currently being processed by IXN Server.
|UsedFor=Workload
}}{{PEMetric
|Metric=ixnnode_interactions_placed_back_total
|Type=Counter
|Unit=Amount
|Label=reason, strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of times an interaction was placed back in queue.

'''Label descriptions''':

*reason - The reason of placing back in queue. It takes values: "StrategyOldQueueRequest" - Strategy explicitly requested to place to valid queue with name (not "BACK") matching the name of queue interaction was pulled from. Set by ORS. "StrategyBackRequest" - Strategy requested placing interaction "BACK" explicitly. Set by ORS. "Implicit" - Strategy did nothing and ORS places interaction back cause there are no instructions for it. Set by ORS. "Error" - ORS places interaction back into queue due to some error regardless of the error source be it strategy itself or any other reason. Set by ORS. "SubmitError" - IXN Node failed to send interaction to ORS and places it back into queue. "Unknown" - The reason was not specified by ORS.
*strategy - The strategy which routed interactions.
|UsedFor=Workload, Error, ORS Error
}}{{PEMetric
|Metric=ixnnode_running_strategies_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of the strategies for which interactions currently are being pulled.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_configured_strategies_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of the strategies read from configuration for which interactions should be pulled.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_configuration_fetch_errors_total
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of error occurred while fetching configuration from Configuration Service.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_last_fetched_configuration_timestamp
|Type=Gauge
|Unit=Timestamp
|Label=None
|MetricDescription=Indicates the last time the configuration was successfully fetched from Configuration Service as the number of seconds since January 1 1970 UTC.
|UsedFor=Operability
}}
|AlertsDefined=No
|PEAlert={{PEAlert}}
}}

IXN/Current/IXNPEGuide/Observability

2022-01-24T07:38:15Z

Karl.Abraham: Published

{{ArticlePEServiceObservability
|EnableMonitoring=Monitoring is not enabled by default. To enable monitoring, modify the Helm chart by setting the following values in the values.yaml file

* ixnService.prometheus.podMonitor.enabled: <code>true</code>

* ixnVQNode.prometheus.podMonitor.enabled: <code>true</code>

For more information about modifying the Helm chart, see [[Draft:IXN/Current/IXNPEGuide/Configure|Configure Interaction Server]].
|ConfigureMetrics=The metrics that are exposed by the Interaction Server service are available by default. No further configuration is required in order to define or expose these metrics. You cannot define your own custom metrics.
|AlertsDefined=No
|ExtConfigAlertsBoilerplate=Yes
}}

GVP/Current/GVPPEGuide/Observability

2022-01-24T07:28:56Z

Karl.Abraham: Published

{{ArticlePEServiceObservability
|ConfigureMetrics=The metrics that are exposed by Genesys Voice Platform services are available by default. No further configuration is required in order to define or expose these metrics. You cannot define your own custom metrics.
|AlertsDefined=Yes
|ExtConfigAlertsBoilerplate=Yes
}}