make generated docs line up

vectordotdev · Apr 17, 2023 · fce04a2 · fce04a2
1 parent 392c4d7
commit fce04a2
Showing 1 changed file with 13 additions and 102 deletions.
diff --git a/website/cue/reference/components/sinks/base/statsd.cue b/website/cue/reference/components/sinks/base/statsd.cue
@@ -31,18 +31,17 @@ base: components: sinks: statsd: configuration: {
 		description: """
 			The address to connect to.
 
-			Both IP address and hostname are accepted formats.
+			Both IP addresses and hostnames/fully-qualified domain names are accepted formats.
 
 			The address _must_ include a port.
 			"""
 		relevant_when: "mode = \"tcp\" or mode = \"udp\""
 		required:      true
-		type: string: examples: ["92.12.333.224:5000", "https://somehost:5000"]
+		type: string: examples: ["92.12.333.224:5000", "somehost:5000"]
 	}
 	batch: {
-		description:   "Event batching behavior."
-		relevant_when: "mode = \"udp\""
-		required:      false
+		description: "Event batching behavior."
+		required:    false
 		type: object: options: {
 			max_bytes: {
 				description: """
@@ -114,115 +113,27 @@ base: components: sinks: statsd: configuration: {
 		required:      true
 		type: string: examples: ["/path/to/socket"]
 	}
-	send_buffer_bytes: {
+	send_buffer_size: {
 		description: """
 			The size of the socket's send buffer.
 
 			If set, the value of the setting is passed via the `SO_SNDBUF` option.
 			"""
-		relevant_when: "mode = \"tcp\" or mode = \"udp\""
-		required:      false
+		required: false
 		type: uint: {
 			examples: [
 				65536,
 			]
 			unit: "bytes"
 		}
 	}
-	tls: {
-		description:   "Configures the TLS options for incoming/outgoing connections."
-		relevant_when: "mode = \"tcp\""
-		required:      false
-		type: object: options: {
-			alpn_protocols: {
-				description: """
-					Sets the list of supported ALPN protocols.
-
-					Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order
-					that they are defined.
-					"""
-				required: false
-				type: array: items: type: string: examples: ["h2"]
-			}
-			ca_file: {
-				description: """
-					Absolute path to an additional CA certificate file.
-
-					The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.
-					"""
-				required: false
-				type: string: examples: ["/path/to/certificate_authority.crt"]
-			}
-			crt_file: {
-				description: """
-					Absolute path to a certificate file used to identify this server.
-
-					The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as
-					an inline string in PEM format.
-
-					If this is set, and is not a PKCS#12 archive, `key_file` must also be set.
-					"""
-				required: false
-				type: string: examples: ["/path/to/host_certificate.crt"]
-			}
-			enabled: {
-				description: """
-					Whether or not to require TLS for incoming or outgoing connections.
-
-					When enabled and used for incoming connections, an identity certificate is also required. See `tls.crt_file` for
-					more information.
-					"""
-				required: false
-				type: bool: {}
-			}
-			key_file: {
-				description: """
-					Absolute path to a private key file used to identify this server.
-
-					The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
-					"""
-				required: false
-				type: string: examples: ["/path/to/host_certificate.key"]
-			}
-			key_pass: {
-				description: """
-					Passphrase used to unlock the encrypted key file.
-
-					This has no effect unless `key_file` is set.
-					"""
-				required: false
-				type: string: examples: ["${KEY_PASS_ENV_VAR}", "PassWord1"]
-			}
-			verify_certificate: {
-				description: """
-					Enables certificate verification.
-
-					If enabled, certificates must not be expired and must be issued by a trusted
-					issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the
-					certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and
-					so on until the verification process reaches a root certificate.
-
-					Relevant for both incoming and outgoing connections.
-
-					Do NOT set this to `false` unless you understand the risks of not verifying the validity of certificates.
-					"""
-				required: false
-				type: bool: {}
-			}
-			verify_hostname: {
-				description: """
-					Enables hostname verification.
-
-					If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by
-					the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.
-
-					Only relevant for outgoing connections.
-
-					Do NOT set this to `false` unless you understand the risks of not verifying the remote hostname.
-					"""
-				required: false
-				type: bool: {}
-			}
+	unix_mode: {
+		description:   "The Unix socket mode to use."
+		relevant_when: "mode = \"unix\""
+		required:      true
+		type: string: enum: {
+			Datagram: "Datagram-oriented (`SOCK_DGRAM`)."
+			Stream:   "Stream-oriented (`SOCK_STREAM`)."
 		}
 	}
 }