fix(external docs): Document additional encoding fields

Ensure `except_fields`, `only_fields`, and `timestamp_format` appear on all sinks supporting `encoding`. Previously they only appeared on sinks that had healthchecks. Fixes: #6949 Signed-off-by: Jesse Szwedko <[email protected]>
vectordotdev · Apr 14, 2021 · b86802b · b86802b
1 parent 6822c86
commit b86802b
Showing 1 changed file with 22 additions and 23 deletions.
diff --git a/docs/reference/components/sinks.cue b/docs/reference/components/sinks.cue
@@ -161,9 +161,9 @@ components: sinks: [Name=string]: {
 							}
 						}
 
-						if features.healthcheck.enabled {except_fields: {
+						except_fields: {
 							common:      false
-							description: "Prevent the sink from encoding the specified labels."
+							description: "Prevent the sink from encoding the specified fields."
 							required:    false
 							type: array: {
 								default: null
@@ -174,31 +174,30 @@ components: sinks: [Name=string]: {
 							}
 						}
 
-							only_fields: {
-								common:      false
-								description: "Prevent the sink from encoding the specified labels."
-								required:    false
-								type: array: {
-									default: null
-									items: type: string: {
-										examples: ["message", "parent.child"]
-										syntax: "field_path"
-									}
+						only_fields: {
+							common:      false
+							description: "Prevent the sink from encoding the specified fields."
+							required:    false
+							type: array: {
+								default: null
+								items: type: string: {
+									examples: ["message", "parent.child"]
+									syntax: "field_path"
 								}
 							}
+						}
 
-							timestamp_format: {
-								common:      false
-								description: "How to format event timestamps."
-								required:    false
-								type: string: {
-									default: "rfc3339"
-									enum: {
-										rfc3339: "Formats as a RFC3339 string"
-										unix:    "Formats as a unix timestamp"
-									}
-									syntax: "literal"
+						timestamp_format: {
+							common:      false
+							description: "How to format event timestamps."
+							required:    false
+							type: string: {
+								default: "rfc3339"
+								enum: {
+									rfc3339: "Formats as a RFC3339 string"
+									unix:    "Formats as a unix timestamp"
 								}
+								syntax: "literal"
 							}
 						}
 					}