Skip to content

Commit c1262cd

Browse files
author
Ari
authored
chore(aws_s3 sink): Update metadata to match the editorial review for the schema. (vectordotdev#17475)
<!-- **Your PR title must conform to the conventional commit spec!** <type>(<scope>)!: <description> * `type` = chore, enhancement, feat, fix, docs * `!` = OPTIONAL: signals a breaking change * `scope` = Optional when `type` is "chore" or "docs", available scopes https://github.com/vectordotdev/vector/blob/master/.github/semantic.yml#L20 * `description` = short description of the change Examples: * enhancement(file source): Add `sort` option to sort discovered files * feat(new source): Initial `statsd` source * fix(file source): Fix a bug discovering new files * chore(external docs): Clarify `batch_size` option -->
1 parent 9f6f6ec commit c1262cd

File tree

5 files changed

+9
-1
lines changed

5 files changed

+9
-1
lines changed

lib/codecs/src/encoding/format/avro.rs

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ pub struct AvroSerializerOptions {
4747
#[configurable(metadata(
4848
docs::examples = r#"{ "type": "record", "name": "log", "fields": [{ "name": "message", "type": "string" }] }"#
4949
))]
50+
#[configurable(metadata(docs::human_name = "Schema JSON"))]
5051
pub schema: String,
5152
}
5253

lib/vector-config-common/src/human_friendly.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ static WELL_KNOWN_ACRONYMS: Lazy<HashSet<String>> = Lazy::new(|| {
4848
"api", "amqp", "aws", "ec2", "ecs", "gcp", "hec", "http", "https", "nats", "nginx", "s3",
4949
"sqs", "tls", "ssl", "otel", "gelf", "csv", "json", "rfc3339", "lz4", "us", "eu", "bsd",
5050
"vrl", "tcp", "udp", "id", "uuid", "kms", "uri", "url", "acp", "uid", "ip", "pid",
51-
"ndjson", "ewma", "rtt", "cpu", "acl",
51+
"ndjson", "ewma", "rtt", "cpu", "acl", "imds", "acl", "alpn",
5252
];
5353

5454
acronyms.iter().map(|s| s.to_lowercase()).collect()

lib/vector-core/src/tls/settings.rs

+4
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ pub struct TlsConfig {
119119
/// 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.
120120
#[serde(alias = "ca_path")]
121121
#[configurable(metadata(docs::examples = "/path/to/certificate_authority.crt"))]
122+
#[configurable(metadata(docs::human_name = "CA File Path"))]
122123
pub ca_file: Option<PathBuf>,
123124

124125
/// Absolute path to a certificate file used to identify this server.
@@ -129,20 +130,23 @@ pub struct TlsConfig {
129130
/// If this is set, and is not a PKCS#12 archive, `key_file` must also be set.
130131
#[serde(alias = "crt_path")]
131132
#[configurable(metadata(docs::examples = "/path/to/host_certificate.crt"))]
133+
#[configurable(metadata(docs::human_name = "Certificate File Path"))]
132134
pub crt_file: Option<PathBuf>,
133135

134136
/// Absolute path to a private key file used to identify this server.
135137
///
136138
/// The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
137139
#[serde(alias = "key_path")]
138140
#[configurable(metadata(docs::examples = "/path/to/host_certificate.key"))]
141+
#[configurable(metadata(docs::human_name = "Key File Path"))]
139142
pub key_file: Option<PathBuf>,
140143

141144
/// Passphrase used to unlock the encrypted key file.
142145
///
143146
/// This has no effect unless `key_file` is set.
144147
#[configurable(metadata(docs::examples = "${KEY_PASS_ENV_VAR}"))]
145148
#[configurable(metadata(docs::examples = "PassWord1"))]
149+
#[configurable(metadata(docs::human_name = "Key File Password"))]
146150
pub key_pass: Option<String>,
147151
}
148152

src/aws/auth.rs

+2
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ pub enum AwsAuthentication {
117117
/// Relevant when the default credentials chain or `assume_role` is used.
118118
#[configurable(metadata(docs::type_unit = "seconds"))]
119119
#[configurable(metadata(docs::examples = 30))]
120+
#[configurable(metadata(docs::human_name = "Load Timeout"))]
120121
load_timeout_secs: Option<u64>,
121122

122123
/// Configuration for authenticating with AWS through IMDS.
@@ -141,6 +142,7 @@ pub enum AwsAuthentication {
141142
/// Relevant when the default credentials chain or `assume_role` is used.
142143
#[configurable(metadata(docs::type_unit = "seconds"))]
143144
#[configurable(metadata(docs::examples = 30))]
145+
#[configurable(metadata(docs::human_name = "Load Timeout"))]
144146
load_timeout_secs: Option<u64>,
145147

146148
/// Configuration for authenticating with AWS through IMDS.

src/sinks/aws_s3/config.rs

+1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ pub struct S3SinkConfig {
8383
/// This ensures there are no name collisions, and can be useful in high-volume workloads where
8484
/// object keys must be unique.
8585
#[serde(default = "crate::serde::default_true")]
86+
#[configurable(metadata(docs::human_name = "Append UUID to Filename"))]
8687
pub filename_append_uuid: bool,
8788

8889
/// The filename extension to use in the object key.

0 commit comments

Comments
 (0)