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

Improve description for rfc and enrichment in "clusterlogforwarder.spec.outputs.syslog"

XMLWordPrintable

    • False
    • None
    • False
    • NEW
    • NEW
    • Before this fix, oc explain was incomplete for clusterlogforwarder.spec.outputs.syslog. After this fix, the supported types for rfc and enchrichment are displayed accordingly.
    • Bug Fix
    • Log Collection - Sprint 268
    • Low

      Description of problem:

      When as a normal user runs the command "oc explain clusterlogforwarder.spec.outputs.syslog", it should be expected to see in the fields:

      rfc: it must match exactly RFC5424 and RFC3164 and it can't be lower case or with a dash in the middle. Then, it should be expected to have explicitly listed the supported and their format or when used a wrong value, it will fail
      enrichment: it indicates that "is an additional modification the log message before forwarding it to the receiver", but it's not explained what fields are populated when this option is enabled

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

       oc get csv |grep -i logging
      cluster-logging.v6.1.2                  Red Hat OpenShift Logging                        6.1.2      cluster-logging.v6.1.1                  Succeeded
      

      How reproducible:

      Always

      Steps to Reproduce:

      1. Install Logging 6.1
      2. Run "oc explain clusterlogforwarder.spec.outputs.syslog" and verify the definition of the fields "enrichment" and "rfc"

      Actual results:

      Not listed the possible values in the "rfc" field
      Not listed the fields that when enabled enrichment will be populated in the syslog message

      Expected results:

      Expected in the "rfc" field to be listed the 2 possible as they should be.
      Expected in the "enrichment" field to be listed what fields are populated inside the syslog message

              rh-ee-calee Calvin Lee
              rhn-support-ocasalsa Oscar Casal Sanchez
              Anping Li Anping Li
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: