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

Document the value of clusterlogging.spec.visualization.ocpConsole.timeout

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • Logging 5.8, Logging 5.9
    • Logging
    • False
    • Hide

      None

      Show
      None
    • False
    • Important

      URL

      https://docs.openshift.com/container-platform/4.15/logging/cluster-logging-deploying.html

      SECTION

      Configuring the log visualizer

      DESCRIPTION

      In the documentation section Configuring the log visualizer is indicated how to define the Log visualizer. One of the possible keys is referent to the `ocpConsole.timeout`. This is not documented in any place how must be the type of the value (integer,string, etc) then, it could lead to set as an string as it's documented in the API:

      $ oc explain clusterlogging.spec.visualization.ocpConsole.timeout
      GROUP:      logging.openshift.io
      KIND:       ClusterLogging
      VERSION:    v1FIELD: timeout <string>DESCRIPTION:
          Timeout is the max duration before a query timeout

      Leading to the error described in the article: https://access.redhat.com/solutions/7064576

      Then, it should be expected in the Logging documentation to have indicated the possible values/format for `clusterlogging.spec.visualization.ocpConsole.timeout` as it's visible in https://github.com/openshift/cluster-logging-operator/blob/a03b9d0b94b5569922a07f02c832304ad64d7dfa/bundle/manifests/logging.openshift.io_clusterloggings.yaml#L1125 where it indicates:

      pattern: ^([0-9]+)([smhd]{0,1})${code}

       

      NOTE: Also, it should be expected the same description for the field `ocpConsole.logsLimit` where it's expected to be an integer as visible here.

              bdooley@redhat.com Brian Dooley
              rhn-support-ocasalsa Oscar Casal Sanchez
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: