Uploaded image for project: 'OpenShift Logging'
  1. OpenShift Logging
  2. LOG-6483

Elasticsearch Runbook URLs are not correct in the OCP Alerts

XMLWordPrintable

    • False
    • None
    • False
    • NEW
    • NEW
    • Bug Fix
    • Moderate

      Description of problem:

      The links in the `runbook_url` available in the Elasticsearch alerts are broken. For verifying them. Get the `runbook_url` alerts for Elasticsearch:

       $ oc get cm prometheus-k8s-rulefiles-0 -o yaml -n openshift-monitoring |grep -i elasticsearch |grep runbook_url
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Cluster-Health-is-Red
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Cluster-Health-is-Yellow
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Write-Requests-Rejection-Jumps
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-Low-Watermark-Reached
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-High-Watermark-Reached
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-Flood-Watermark-Reached
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-JVM-Heap-Use-is-High
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Process-CPU-is-High
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Disk-Space-is-Running-Low
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-FileDescriptor-Usage-is-high
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-Low-Watermark-Reached
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-High-Watermark-Reached
                runbook_url: https://docs.openshift.com/container-platform/latest/observability/logging/troubleshooting/troubleshooting-logging-alerts.html#Elasticsearch-Node-Disk-Flood-Watermark-Reached
      

      The URLS are failing because of they are pointing to the "latest" version of OpenShift and this url redirects to the OpenShift 4.17 documentation where the Elasticsearch documentation doesn't exist as it was removed from the product.

      If the links are changed from:

       https://docs.openshift.com/container-platform/latest that redirects to https://docs.openshift.com/container-platform/4.17

      To be:

        https://docs.openshift.com/container-platform/4.16/...

      They will work

      Version-Release number of selected component (if applicable):

      $ oc get csv -n openshift-logging|grep -i elasticsearch
      elasticsearch-operator.v5.8.15              OpenShift Elasticsearch Operator                 5.8.15                     elasticsearch-operator.v5.8.14      Succeeded 

      How reproducible:

      Always

      Steps to Reproduce:

      1. Run the command in the description, check the links in the runbook_url for Elasticsearch and trying to open to see the web page receiving a 404 error

      Actual results:

      A 404 error is received

      Expected results:

      Link working guiding to the runbook for troubleshooting the alert

              Unassigned Unassigned
              rhn-support-ocasalsa Oscar Casal Sanchez
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: