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

Flow control for inputs and outputs missing from Documentation

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • logging 6.4
    • Logging
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • Important

      In Logging v5 existed the documentation section  "Flow control mechanisms" [0]  that it's missing entirely from Logging v6.

      The examples from Logging v5 are not longer valid in Logging v6 as they are set in a different way.

      It's missing from Inputs the definition of these two options ("maxMessageSize" is new in Logging 6.4) :

      $ oc explain obsclf.spec.inputs.application.tuning
      GROUP:      observability.openshift.io
      KIND:       ClusterLogForwarder
      VERSION:    v1
      
      FIELD: tuning <Object>
      
      DESCRIPTION:
          Tuning is the container input tuning spec for this container sources
          
      FIELDS:
        maxMessageSize	<Object>
          MaxMessageSize  The maximum message length in bytes that a single log event
          can be when all
          partial log lines are merged.  Messages exceeding this limit are dropped.
      
        rateLimitPerContainer	<Object>
          RateLimitPerContainer is the limit applied to each container
          by this input. This limit is applied per collector deployment.
      

       It's missing from Outpus the definition of these two options (maxMessageSize is new in Logging 6.4) :

      $ oc explain obsclf.spec.outputs.rateLimit
      GROUP:      observability.openshift.io
      KIND:       ClusterLogForwarder
      VERSION:    v1
      
      FIELD: rateLimit <Object>
      
      DESCRIPTION:
          Limit imposes a limit in records-per-second on the total aggregate rate of
          logs forwarded
          to this output from any given collector container. The total log flow from
          an individual collector
          container to this output cannot exceed the limit.  Generally, one collector
          is deployed per cluster node
          Logs may be dropped to enforce the limit. Missing or 0 means no rate limit.
          
      FIELDS:
        maxRecordsPerSecond	<integer> -required-
          MaxRecordsPerSecond is the maximum number of log records
          allowed per input/output in a pipeline
      

       [0] https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/logging/performance-and-reliability-tuning

              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: