docs(logstash source): use auto-generated config docs (vectordotdev#1…

…6057)
ansel1 · Jan 24, 2023 · 6bcdde7 · 6bcdde7
1 parent c35e50d
commit 6bcdde7
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 29 deletions.
diff --git a/src/sources/logstash.rs b/src/sources/logstash.rs
@@ -39,7 +39,7 @@ use crate::{
 #[configurable_component(source("logstash"))]
 #[derive(Clone, Debug)]
 pub struct LogstashConfig {
-    /// The socket address to listen for connections on.
+    #[configurable(derived)]
     address: SocketListenAddr,
 
     #[configurable(derived)]
@@ -48,12 +48,15 @@ pub struct LogstashConfig {
     #[configurable(derived)]
     tls: Option<TlsSourceConfig>,
 
-    /// The size, in bytes, of the receive buffer used for each connection.
+    /// The size of the receive buffer used for each connection.
     ///
-    /// This should not typically needed to be changed.
+    /// This generally should not need to be changed.
+    #[configurable(metadata(docs::type_unit = "bytes"))]
+    #[configurable(metadata(docs::examples = 65536))]
     receive_buffer_bytes: Option<usize>,
 
     /// The maximum number of TCP connections that will be allowed at any given time.
+    #[configurable(metadata(docs::type_unit = "connections"))]
     connection_limit: Option<u32>,
 
     #[configurable(derived)]

diff --git a/website/cue/reference/components/sources/base/logstash.cue b/website/cue/reference/components/sources/base/logstash.cue
@@ -20,14 +20,19 @@ base: components: sources: logstash: configuration: {
 		}
 	}
 	address: {
-		description: "The socket address to listen for connections on."
-		required:    true
+		description: """
+			The socket address to listen for connections on, or `systemd{#N}` to use the Nth socket passed by
+			systemd socket activation.
+
+			If a socket address is used, it _must_ include a port.
+			"""
+		required: true
 		type: string: examples: ["0.0.0.0:9000", "systemd", "systemd#3"]
 	}
 	connection_limit: {
 		description: "The maximum number of TCP connections that will be allowed at any given time."
 		required:    false
-		type: uint: {}
+		type: uint: unit: "connections"
 	}
 	keepalive: {
 		description: "TCP keepalive settings for socket-based components."
@@ -40,12 +45,17 @@ base: components: sources: logstash: configuration: {
 	}
 	receive_buffer_bytes: {
 		description: """
-			The size, in bytes, of the receive buffer used for each connection.
+			The size of the receive buffer used for each connection.
 
-			This should not typically needed to be changed.
+			This generally should not need to be changed.
 			"""
 		required: false
-		type: uint: {}
+		type: uint: {
+			examples: [
+				65536,
+			]
+			unit: "bytes"
+		}
 	}
 	tls: {
 		description: "TlsEnableableConfig for `sources`, adding metadata from the client certificate"

diff --git a/website/cue/reference/components/sources/logstash.cue b/website/cue/reference/components/sources/logstash.cue
@@ -16,6 +16,7 @@ components: sources: logstash: {
 
 	features: {
 		acknowledgements: true
+		auto_generated:   true
 		receive: {
 			from: {
 				service: services.logstash
@@ -50,26 +51,7 @@ components: sources: logstash: {
 		platform_name: null
 	}
 
-	configuration: {
-		acknowledgements: configuration._source_acknowledgements
-		address: {
-			description: "The address to listen for TCP connections on."
-			required:    true
-			type: string: {
-				examples: ["0.0.0.0:\(_port)"]
-			}
-		}
-		connection_limit: {
-			common:        false
-			description:   "The max number of TCP connections that will be processed."
-			relevant_when: "mode = `tcp`"
-			required:      false
-			type: uint: {
-				default: null
-				unit:    "connections"
-			}
-		}
-	}
+	configuration: base.components.sources.logstash.configuration
 
 	output: logs: line: {
 		description: "A Logstash message"