chore(external docs): Add S3 sink categories

Signed-off-by: binarylogic <bjohnson@binarylogic.com>
vectordotdev · Oct 17, 2020 · f262791 · f262791
1 parent 82d4028
commit f262791
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 7 deletions.
diff --git a/docs/reference/components/sinks.cue b/docs/reference/components/sinks.cue
@@ -11,7 +11,7 @@ components: sinks: [Name=string]: {
 		if sinks[Name].features.send != _|_ && sinks[Name].features.send.batch != _|_ {
 			if sinks[Name].features.send.batch.enabled {
 				batch: {
-					common:      false
+					common:      sinks[Name].features.send.batch.common
 					description: "Configures the sink batching behavior."
 					required:    false
 					type: object: {
@@ -63,17 +63,19 @@ components: sinks: [Name=string]: {
 					examples: []
 					options: {
 						max_events: {
-							common:      true
-							description: "The maximum number of [events][docs.data-model] allowed in the buffer."
-							required:    false
+							common:        true
+							description:   "The maximum number of [events][docs.data-model] allowed in the buffer."
+							required:      false
+							relevant_when: "type = \"memory\""
 							type: uint: {
 								default: 500
 								unit:    "events"
 							}
 						}
 						max_size: {
-							description: "The maximum size of the buffer on the disk."
-							required:    true
+							description:   "The maximum size of the buffer on the disk."
+							required:      true
+							relevant_when: "type = \"disk\""
 							type: uint: {
 								examples: [104900000]
 								unit: "bytes"

diff --git a/docs/reference/components/sinks/aws_s3.cue b/docs/reference/components/sinks/aws_s3.cue
@@ -25,7 +25,7 @@ components: sinks: aws_s3: {
 			}
 			compression: {
 				enabled: true
-				default: "none"
+				default: "gzip"
 				algorithms: ["none", "gzip"]
 				levels: ["none", "fast", "default", "best", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 			}
@@ -110,6 +110,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		content_encoding: {
+			category: "Content Type"
 			common:      false
 			description: "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. By default calculated from `compression` value."
 			required:    false
@@ -120,6 +121,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		content_type: {
+			category: "Content Type"
 			common:      false
 			description: "A standard MIME type describing the format of the contents."
 			required:    false
@@ -129,13 +131,15 @@ components: sinks: aws_s3: {
 			}
 		}
 		filename_append_uuid: {
+			category: "File Naming"
 			common:      false
 			description: "Whether or not to append a UUID v4 token to the end of the file. This ensures there are no name collisions high volume use cases."
 			required:    false
 			warnings: []
 			type: bool: default: true
 		}
 		filename_extension: {
+			category: "File Naming"
 			common:      false
 			description: "The filename extension to use in the object name."
 			required:    false
@@ -145,6 +149,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		filename_time_format: {
+			category: "File Naming"
 			common:      false
 			description: "The format of the resulting object file name. [`strftime` specifiers](\(urls.strptime_specifiers)) are supported."
 			required:    false
@@ -154,6 +159,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		grant_full_control: {
+			category: "ACL"
 			common:      false
 			description: "Gives the named [grantee][urls.aws_s3_grantee] READ, READ_ACP, and WRITE_ACP permissions on the created objects."
 			required:    false
@@ -164,6 +170,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		grant_read: {
+			category: "ACL"
 			common:      false
 			description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects and their metadata."
 			required:    false
@@ -174,6 +181,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		grant_read_acp: {
+			category: "ACL"
 			common:      false
 			description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects' ACL."
 			required:    false
@@ -184,6 +192,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		grant_write_acp: {
+			category: "ACL"
 			common:      false
 			description: "Allows the named [grantee][urls.aws_s3_grantee] to write the created objects' ACL."
 			required:    false
@@ -194,6 +203,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		key_prefix: {
+			category: "File Naming"
 			common:      true
 			description: "A prefix to apply to all object key names. This should be used to partition your objects, and it's important to end this value with a `/` if you want this to be the root S3 \"folder\"."
 			required:    false
@@ -204,6 +214,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		server_side_encryption: {
+			category:    "Encryption"
 			common:      false
 			description: "The server-side encryption algorithm used when storing these objects."
 			required:    false
@@ -217,6 +228,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		ssekms_key_id: {
+			category:    "Encryption"
 			common:      false
 			description: "If `server_side_encryption` has the value `\"aws.kms\"`, this specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that will used for the created objects. If not specified, Amazon S3 uses the AWS managed CMK in AWS to protect the data."
 			required:    false
@@ -227,6 +239,7 @@ components: sinks: aws_s3: {
 			}
 		}
 		storage_class: {
+			category: "Storage"
 			common:      false
 			description: "The storage class for the created objects. See [the S3 Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) for more details."
 			required:    false