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

[release-6.2] lokistack.spec.tenants.openshift.otlp doesn't indicate what are the "required attributes"

XMLWordPrintable

    • Future Sustainability
    • 1
    • False
    • Hide

      None

      Show
      None
    • False
    • NEW
    • VERIFIED
    • Updated api documentation for lokistack.spec.tenants.openshift.otlp.disableRecommendedAttributes
    • Bug Fix
    • Low

      Description of problem:

      When it's run the command:

      $ oc explain lokistack.spec.tenants.openshift.otlp 

      It's possible to read:

      [...]
      FIELDS:
        disableRecommendedAttributes	<boolean>
          DisableRecommendedAttributes can be used to reduce the number of attributes
          used as stream labels.
          
          Enabling this setting removes the "recommended attributes" from the
          generated Loki configuration. This will cause
          some stream labels to disappear from the index, potentially making queries
          more expensive and less performant.
          
          Note that there is a set of "required attributes", needed for OpenShift
          Logging to work properly. Those will be added to the configuration, even if this field is set to true.
          
          This option is supposed to be combined with a custom attribute configuration
          listing the stream labels that should continue to exist.
      

      Focusing in the words "Note that there is a set of "required attributes", needed for OpenShift Logging to work properly", they are abstract words for the reader as it's not explained what are the "required attributes, needed for OpenShift" being not possible to infer if the observed when reviewing the logs when observed the attributes are those needed by OpenShift or they are a consequence of something different as a bad configuration.

      Note: I could understand that the "required attributes" are the "stream labels" mentioned in the last paragraph (really, the default stream labels), but it's not clear in the whole context and also, it's not explained what the stream labels they are.

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

      $ oc get csv -n openshift-logging|grep "logging"
      cluster-logging.v6.2.0 Red Hat OpenShift Logging 6.2.0 cluster-logging.v6.1.2 Succeeded
      

      How reproducible:

      Run the command

      $ oc explain lokistack.spec.tenants.openshift.otlp 

      And verify the explanation given for this key.

      Actual results:

      It's indicated that some "required attributes" won't be needed as required for OpenShift

      Expected results:

      To be listed the "required attributes" needed for OpenShift for knowing exactly what attributes is expected to see in a log, even, when it's configured "disableRecommendedAttributes: true"

              jmarcal@redhat.com Joao Marcal
              rhn-support-ocasalsa Oscar Casal Sanchez
              Kabir Bharti Kabir Bharti
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: