Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-134

Restructure "Forwarding logs to external third-party logging systems" section

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Normal
    • None
    • None
    • Logging
    • OBSDOCS (Oct 23 - Nov 13) #244, OBSDOCS (Jan 1 - Jan 22) #247
    • Moderate

    Description

      [URL]

      https://docs.openshift.com/container-platform/4.11/logging/cluster-logging-external.html

      [SECTION]

      Forwarding logs to external third-party logging systems

      [ISSUE]

      The title "Forwarding logs to external third-party logging systems" could be not the best. As a user, reading the title, I could think that it's only for how to configure to send the logs to external outputs, but it's not. Examples:

      • Feature "Forwarding application logs from specific projects" [0]. This could be used only for collecting logs from specific projects and sending them to the internal logStore, not to third-party systems.
      • Feature "Forwarding application logs from specific pods" [1]. This could be used only for collecting logs from specific pods and sending them to the internal logStore, not to third-party systems.
      • Troubleshooting log forwarding [2]. This section should be probably better in "Troubleshooting Logging section"
      • Forwarding JSON logs from containers in the same pod to separate indices. I don't understand exactly this section here when we have a different section call "Enabling JSON logging" and perhaps it could make more sense to write all the related to JSON together.

      From my point of view, more than "Forwarding logs to third party systems", we enable some features or we support some outputs (Elasticsearch, Loki, Kafka), then, there are different things, one is how I need to configure to send to a defined output like Elasticsearch, Loki, Kafka, etc and something different is how I can collect logs only from specific namespaces, or specific pods, or JSON, etc.

      Mixing all below the same name is some much confusing for all.

      [0] https://docs.openshift.com/container-platform/4.11/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-project_cluster-logging-external
      [1] https://docs.openshift.com/container-platform/4.11/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-logs-from-application-pods_cluster-logging-external
      [2] https://docs.openshift.com/container-platform/4.11/logging/cluster-logging-external.html#cluster-logging-troubleshooting-log-forwarding_cluster-logging-external
      [3] https://docs.openshift.com/container-platform/4.11/logging/cluster-logging-external.html#cluster-logging-forwarding-separate-indices_cluster-logging-external
       

      Attachments

        Activity

          People

            abrennan@redhat.com Ashleigh Brennan
            rhn-support-ocasalsa Oscar Casal Sanchez
            Votes:
            1 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: