Uploaded image for project: 'Observability and Data Analysis Program'
  1. Observability and Data Analysis Program
  2. OBSDA-424

Provide the same level of explanation for Loki as for EFK to ensure a smooth transition from EFK to Loki

XMLWordPrintable

    • Icon: Feature Feature
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • Logging 5.7
    • Log Storage, PM Logging
    • False
    • None
    • False
    • Not Selected

      Proposed title of this feature request

      • Provide the same level of explanation for Loki as for EFK to ensure a smooth transition from EFK to Loki

      What is the nature and description of the request?

      • The parts of the EFK/Loki that are commonly explained in the EFK/Loki should be clarified as to whether each EFK/Loki is acceptable or not, and should be at the same level with respect to the content of the explanation.
        • Log forwarding (including the config of Vector, and supported forwarding destinations)
          • "Table 2.1. Logging 5.7 outputs"[1]
          • "Chapter 11. Forwarding logs to external third-party logging systems"[2]
          • "5.4.1. Enabling Vector"[3]
        • Chapter 13. Collecting and storing Kubernetes events[4]
        • Functional compatibility between EFK and Loki
          • The Collector is described in "3.6.1. Collector features"[5], but a feature comparison table is needed for OpenShift Logging in general as well.
          • For features that are not available in Loki, alternative methods should also be presented

      [1] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#logging-support-considerations_logging-5-7-architecture-overview     
        [2] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-external
        [3] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-vector-enable_cluster-logging
        [4] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-eventrouter
        [5] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#logging-5-6-collector-ref_logging-5.6-reference

      • If the information is listed in different chapters in EFK/Liki, please make sure that the information listed in EFK is also listed in Loki at the same level so that it can be changed and compared when moving from EFK to Loki.
        • Log store
          • EFK:  explained in "7.3 Configuring the log Store"[7]
          • Loki: Only links to external documents listed in "8.5. Additional Resources"[8]
        • Log collector
          • EFK:  explained in "7.2 Configuring the logging collector"[9]
          • Loki: Only links to external documents listed in "1.29.2 About Vector"[10]
        • Log visualizer
          • EFK:  explained in "7.4 Configuring the log visualizer"[11]
          • Loki: Only links to external documents listed in "8.5. Additional Resources"[8]
        • Metrix information (Cluster Dashboard)
          • EFK:  explained in "10. Viewing Cluster logs by using Kibana"[12]
          • Loki: no documentation
        • How to uninstall   
          • Mixed explanations in "2.5.4. Deleting Operators from a cluster using the web console"[13] and "17 Uninstalling OpenShift Logging"[14]
        • Log Record Field
          • EFK:  explaiend in "18. Log Record Fields" [15]
          • Loki: no documentation
        • Explanations with sample query (LogQL) for querying logs
          • Sample queries should be included along with log search use cases
          • e.g.
            • Query logs coming from a specific application pod
            • Query logs coming from a specific Cluster component
            • Query logs coming from the CoreOS layer
            • Query Kubernetes Event

         [7] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-store
         [8] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#additional-resources
         [9] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-collector
         [10] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-about-vector
         [11] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-visualizer
         [12] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-visualizer-using
         [13] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#olm-deleting-operators-from-a-cluster-using-web-console_logging-5.7-administration
         [14] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-uninstall      
         [15] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/logging/index#cluster-logging-exported-fields

      Why does the customer need this? (List the business requirements)

      • The customer is planning to migrate from EFK to Loki because EFK will no longer be available in the future, but currently, the same level of description is not provided for Loki as is provided for EFK.
        As a result, specific changes and precautions have not been clarified, hindering the transition process.

      List any affected packages or components.

      • Documentation

              jamparke@redhat.com Jamie Parker
              jamparke@redhat.com Jamie Parker
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: