Critical URL
Tuning log payloads and delivery
ISSUE 1
The Tuning log payloads and delivery is indicating an invalid example as it's like:
spec:
tuning:
delivery: AtLeastOnce
compression: none
maxWrite: <integer>
minRetryDuration: 1s
maxRetryDuration: 1s
When it should be like:
spec:
outputs:
- name: httpout-app
tuning:
delivery: AtMostOnce
maxRetryDuration: 1
maxWrite: 1M
minRetryDuration: 1
type: http
url: https://test.com:1900
As `clusterlogforwarder.spec.tuning` doesn't exist in the API:
$ oc explain clusterlogforwarder.spec.tuning
GROUP: logging.openshift.io
KIND: ClusterLogForwarder
VERSION: v1error: field "tuning" does not exist
And the API is `clusterlogforwarder.spec.outputs[].tuning`:
$ oc explain clusterlogforwarder.spec.outputs.tuning GROUP: logging.openshift.io KIND: ClusterLogForwarder VERSION: v1FIELD: tuning <Object>DESCRIPTION: Tuning parameters for the output. Specifying these parameters will alter the characteristics of log forwarder which may be different from its behavior without the tuning.
This makes not usable the feature as the definition is wrong.
ISSUE 2
In the example, it's observed some errors in the type of the values. As:
- The maxRetryDuration must be an integer, but, in the example is observed 1s
- The minRetryDuration must be an integer, but, in the example is observed 1s
- The maxWrite is an object, but in the example is observed integer
For verifying these words check the "good example" above and the result when asking to the API:
$ oc explain clusterlogforwarder.spec.outputs.tuning
...
maxRetryDuration <integer>
MaxRetryDuration is the maximum time to wait between retry attempts after a
delivery failure.
maxWrite <Object>
MaxWrite limits the maximum payload in terms of bytes of a single "send" to
the output.
minRetryDuration <integer>
MinRetryDuration is the minimum time to wait between attempts to retry after
delivery a failure.
ISSUE 3
At the same time, it should be good to indicate for the different keys, the default values and the example using them, this means the values for: `compression`, maxWrite, minRetryDuration, maxRetryDuration and delivery?
- links to
