Change "output" to "forwarder" in fluentd_tuning.md
Change the name of the `clusterloggings.ouput` field to `forwarder`
to reflect final discussions on the subject.
@@ -38,8 +38,8 @@ In future releases:
- new sections may be introduced for new implementations, they may not have equivalent settings to `fluentd`
The `clusterloggings.logging.openshift.io` API will have a new map field
-`spec.output.fluentd`. The `output` field is for tuning parameters for `output`
-plugins.
+`spec.forwarder.fluentd`. The `forwarder` field is for global tuning parameters
+for fluentd output plugins.
## Motivation
@@ -56,23 +56,23 @@ other.
Goals:
* Expose selected fluentd performance optimization parameters in the ClusterLogging API.
-* Apply defaults from output.fluentd to the underlying `fluentd` configuration.
+* Apply defaults from forwarder.fluentd to the underlying `fluentd` configuration.
We will be successful when:
* An administrator is able to set defaults for selected `fluentd` parameters.
### Non-Goals
-* Not implying that logging will always use `fluentd` or use it in the same way. `output.fluentd` applies to the current implementation, it may be ignored in future releases.
+* Not implying that logging will always use `fluentd` or use it in the same way. `forwarder.fluentd` applies to the current implementation, it may be ignored in future releases.
* Not allowing general `fluentd` configuration: we expose only a subset of performance tuning parameters. Users that want full control of `fluentd` need to go unmanaged.
-* Not a generic performance tuning API: we may introduce such APIs in future, or introduce new `output` sections.
+* Not a generic performance tuning API: we may introduce such APIs in future, or introduce new `forwarder` sections.
## Proposal
Field names are based on fluentd 1.0 `<buffer>` configuration section.
See the [fluentd documentation](https://docs.fluentd.org/configuration/buffer-section#buffering-parameters) for details.
-Example below shows just the `output` section of the ClusterLogging CR.
+Example below shows just the `forwarder` section of the ClusterLogging CR.
The field names are copied exactly from `fluentd` 1.0, including the use of "_"
rather than camelCase. This emphasizes that these settings are not a general
@@ -83,7 +83,7 @@ Note: two important fields were renamed by `fluentd` between versions 0.12 and 1
* `num_threads` -> `flush_thread_count`
```yaml
-output:
+forwarder:
fluentd:
buffer:
# Memory use
@@ -113,7 +113,7 @@ The CLO *may* override these settings if they would break functional behavior,
for example settings that are incompatible with a particular output type.
In future the CLO *may* introduce new APIs that can overlap with tuning
-parameters in `output`. How the overlap is resolved will be
+parameters in `forwarder`. How the overlap is resolved will be
decided if/when that happens.
### Implementation Details
