PrivateEdition/Current/PEGuide/ConfigLog - Revision history

WikiSysop at 03:01, March 31, 2023

2023-03-31T03:01:46Z

WikiSysop at 11:00, September 13, 2022

2022-09-13T11:00:49Z

WikiSysop at 06:45, July 1, 2022

2022-07-01T06:45:42Z

Jaba.Amudha.IX: Published

2022-01-07T10:54:58Z

Published

Jaba.Amudha.IX: Published

2022-01-06T07:38:43Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

2021-11-09T20:29:20Z

Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

Uma.jayakumar@genesys.com: Published

2021-06-30T18:50:41Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configuring logging
|Context=Provides an overview of logging architecture in Genesys Engage cloud private edition and related configurations.
|ComingSoon=No
|Section={{Section
|sectionHeading=Logging architecture
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}{{Section
|sectionHeading=Configuration
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}
}}

@@ Line 10: / Line 10: @@
 |structuredtext=This section explains the approaches of logging used by Genesys Multicloud CX services to write log files that contain the important diagnostic information for various issues that may arise. Support of Genesys services rely on access to these application logs.
-===OpenShift logging===
+For more details, refer to {{Link-SomewhereInThisVersion|manual=Operations|topic=Logging_approaches|anchor=OpenshiftClusterLogging|display text=Solution-level logging approaches}}.
-For more details, refer to {{Link-SomewhereInThisVersion|manual=Operations|topic=Logging_approaches|anchor=OpenshiftClusterLogging|display text=Solution-level logging approaches}}.
+===Logging architecture===
 This section explains the logging architecture of Genesys Multicloud CX private edition in detail.
-Let's explore the logging architecture, the components involved, and its functionality through the following diagram.
+Let's explore the logging architecture, the components involved, and its functionality through the following diagram.[[File:OCP Architecture.png|link=https://all.docs.genesys.com/File:OCP_Architecture.png]]
 ====Logging architecture components====
 Elasticsearch cluster deployed on multiple node aggregates the structured logs from Fluentd and indexes them. This includes the logs from services that follow Secondary and Complementary logging methods. You can use a log visualizer tool like Kibana to view, search, or filter the indexed logs from Elasticsearch.
-'''Fluentd / Fluent-bit'''
+===== '''Fluentd / Fluent-bit''' =====
+Fluentd is a log collector commonly used with container platforms. It collects logs from the cluster and forwards them to Elasticsearch or an externally accessible storage such as Rsyslog server or both depending on your configuration. Fluentd /Fluent-bit collects the application logs of Genesys Multicloud CX services from '''/var/log/containers'''. While deploying cluster wide logging each node Fluentd /Fluent-bit will be deployed to each node.
 The unstructured logs are directly written in the RWX shared storage. For services writing unstructured logs, you must mount PVC/PV.  To access logs externally, use a server like NFS or S3.
-===='''Syslog server storage'''====
+====='''Syslog server storage'''=====
 Optionally, you can implement a syslog server to store the structured logs other than the Elasticsearch log store. Syslog server writes the logs in a flat file and enables you to share them externally. Genesys recommends Rsyslog server for this purpose, however you can select any syslog server of your choice. For more information, refer the deployment procedure.
 |Status=No
 }}
 }}

@@ Line 39: / Line 39: @@
 GKE operations suite is backed by Google '''Stack Driver''' which controls logging, monitoring, and alerting within Google Cloud Platform. By default, GKE clusters are natively integrated with Cloud Logging. When you create a GKE cluster, Cloud Logging is enabled by default.
-Refer to [[Draft:PrivateEdition/Current/Operations/Logging approaches#GKE logging|GKE logging]] for more details.
+Refer to {{Link-SomewhereInThisVersion|manual=Operations|topic=Logging_approaches|anchor=GKElogging|display text=GKE Logging}} for more details.
 |Status=No
 }}
 }}

@@ Line 11: / Line 11: @@
 ===OpenShift logging===
-OpenShift logging is backed by Fluentd/Elasticsearch/Kibana which controls scraping, indexing, and UI access to an Openshift cluster. A Fluentd DaemonSet runs on each node in the cluster which scrapes logs from containers that actively write to a stdout stream through '''/var/log/pods'''. Output from Fluentd is piped to an Elasticsearch cluster which collects and indexes all the relevant log data. Kibana provides a UI frontend for searching indexed logs generated within the cluster.
+OpenShift logging is backed by Fluentd/ElasticSearch/Kibana which controls scraping, indexing and UI access to an Openshift cluster. A Fluentd DaemonSet runs on each node in the cluster which scrapes logs from containers that are actively writing to a stdout stream through '''/var/log/pods'''. Output from Fluentd is piped to an Elasticsearch cluster which collects and indexes all relevant log data. Kibana provides a UI frontend for searching indexed logs generated within the cluster.
-Refer to the following sections for more details about OpenShift logging, logging approaches, and configuration:
+For more details, refer to {{Link-SomewhereInThisVersion|manual=Operations|topic=Logging_approaches|anchor=OpenshiftClusterLogging|display text=Solution-level logging approaches}}.
 ====Logging architecture====
 This section explains the logging architecture of Genesys Multicloud CX private edition in detail.
-Let's explore the logging architecture, components involved, and its functionality through the following diagram.
+Let's explore the logging architecture, the components involved, and its functionality through the following diagram.
 [[File:OCP Architecture.png|link=https://all.docs.genesys.com/File:OCP_Architecture.png]]
@@ Line 44: / Line 39: @@
 GKE operations suite is backed by Google '''Stack Driver''' which controls logging, monitoring, and alerting within Google Cloud Platform. By default, GKE clusters are natively integrated with Cloud Logging. When you create a GKE cluster, Cloud Logging is enabled by default.
-Refer to [[PrivateEdition/Current/Operations/Logging approaches#GKE logging|GKE logging]] for more details.
+Refer to [[Draft:PrivateEdition/Current/Operations/Logging approaches#GKE logging|GKE logging]] for more details.
 |Status=No
 }}
 }}

@@ Line 15: / Line 15: @@
 Refer to the following sections for more details about OpenShift logging, logging approaches, and configuration:
-*[[Draft:PrivateEdition/Current/Operations/Logging approaches#OpenShift cluster logging|OpenShift logging]]
+*{{Link-SomewhereInThisVersion|manual=Operations|topic=Logging_approaches}}
-*[[Draft:PrivateEdition/Current/Operations/Structured logging|Kubernetes-supported structured logging]]
+*{{Link-SomewhereInThisVersion|manual=Operations|topic=Structured_logging}}
-*[[Draft:PrivateEdition/Current/Operations/Sidecar logging|Sidecar processed logging]]
+*{{Link-SomewhereInThisVersion|manual=Operations|topic=Sidecar_logging}}
-*[[Draft:PrivateEdition/Current/Operations/RWXlogging|RWX (unstructured) logging]]
+*{{Link-SomewhereInThisVersion|manual=Operations|topic=RWXlogging}}
 ====Logging architecture====
@@ Line 44: / Line 44: @@
 GKE operations suite is backed by Google '''Stack Driver''' which controls logging, monitoring, and alerting within Google Cloud Platform. By default, GKE clusters are natively integrated with Cloud Logging. When you create a GKE cluster, Cloud Logging is enabled by default.
-Refer to [[Draft:PrivateEdition/Current/Operations/Logging approaches#GKE logging|GKE logging]] for more details.
+Refer to [[PrivateEdition/Current/Operations/Logging approaches#GKE logging|GKE logging]] for more details.
 |Status=No
 }}
 }}

@@ Line 2: / Line 2: @@
 |Standalone=No
 |DisplayName=Configuring logging
-|Context=Provides an overview of logging architecture in Genesys Multicloud CX private edition and related configurations.
+|Context=Provides an overview of logging architecture in Genesys Multicloud CX private edition, different types of logging mechanisms, and related configurations.
 |ComingSoon=No
 |Section={{Section
-|sectionHeading=Logging architecture
+|sectionHeading=Logging approaches and configuration
 |alignment=Vertical
-|structuredtext={{Notices|Notice=PEComingSoon}}
+|structuredtext=This section explains the approaches of logging used by Genesys Multicloud CX services to write log files that contain the important diagnostic information for various issues that may arise. Support of Genesys services rely on access to these application logs.
-|Status=No
-}}{{Section
+===OpenShift logging===
-|sectionHeading=Configuration
+OpenShift logging is backed by Fluentd/Elasticsearch/Kibana which controls scraping, indexing, and UI access to an Openshift cluster. A Fluentd DaemonSet runs on each node in the cluster which scrapes logs from containers that actively write to a stdout stream through '''/var/log/pods'''. Output from Fluentd is piped to an Elasticsearch cluster which collects and indexes all the relevant log data. Kibana provides a UI frontend for searching indexed logs generated within the cluster.
-|alignment=Vertical
-|structuredtext={{Notices|Notice=PEComingSoon}}
+Refer to the following sections for more details about OpenShift logging, logging approaches, and configuration:
 |Status=No
 }}
 }}