diff --git a/lib/codecs/src/encoding/format/avro.rs b/lib/codecs/src/encoding/format/avro.rs index 35bf45890043d..3bfeea5ea1dad 100644 --- a/lib/codecs/src/encoding/format/avro.rs +++ b/lib/codecs/src/encoding/format/avro.rs @@ -47,6 +47,7 @@ pub struct AvroSerializerOptions { #[configurable(metadata( docs::examples = r#"{ "type": "record", "name": "log", "fields": [{ "name": "message", "type": "string" }] }"# ))] + #[configurable(metadata(docs::human_name = "Schema JSON"))] pub schema: String, } diff --git a/lib/vector-config-common/src/human_friendly.rs b/lib/vector-config-common/src/human_friendly.rs index 29c9a290efb93..177e32f428ad7 100644 --- a/lib/vector-config-common/src/human_friendly.rs +++ b/lib/vector-config-common/src/human_friendly.rs @@ -48,7 +48,7 @@ static WELL_KNOWN_ACRONYMS: Lazy> = Lazy::new(|| { "api", "amqp", "aws", "ec2", "ecs", "gcp", "hec", "http", "https", "nats", "nginx", "s3", "sqs", "tls", "ssl", "otel", "gelf", "csv", "json", "rfc3339", "lz4", "us", "eu", "bsd", "vrl", "tcp", "udp", "id", "uuid", "kms", "uri", "url", "acp", "uid", "ip", "pid", - "ndjson", "ewma", "rtt", "cpu", "acl", + "ndjson", "ewma", "rtt", "cpu", "acl", "imds", "acl", "alpn", ]; acronyms.iter().map(|s| s.to_lowercase()).collect() diff --git a/lib/vector-core/src/tls/settings.rs b/lib/vector-core/src/tls/settings.rs index bf049bb86bcb7..4454cfc76026e 100644 --- a/lib/vector-core/src/tls/settings.rs +++ b/lib/vector-core/src/tls/settings.rs @@ -119,6 +119,7 @@ pub struct TlsConfig { /// 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. #[serde(alias = "ca_path")] #[configurable(metadata(docs::examples = "/path/to/certificate_authority.crt"))] + #[configurable(metadata(docs::human_name = "CA File Path"))] pub ca_file: Option, /// Absolute path to a certificate file used to identify this server. @@ -129,6 +130,7 @@ pub struct TlsConfig { /// If this is set, and is not a PKCS#12 archive, `key_file` must also be set. #[serde(alias = "crt_path")] #[configurable(metadata(docs::examples = "/path/to/host_certificate.crt"))] + #[configurable(metadata(docs::human_name = "Certificate File Path"))] pub crt_file: Option, /// Absolute path to a private key file used to identify this server. @@ -136,6 +138,7 @@ pub struct TlsConfig { /// The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format. #[serde(alias = "key_path")] #[configurable(metadata(docs::examples = "/path/to/host_certificate.key"))] + #[configurable(metadata(docs::human_name = "Key File Path"))] pub key_file: Option, /// Passphrase used to unlock the encrypted key file. @@ -143,6 +146,7 @@ pub struct TlsConfig { /// This has no effect unless `key_file` is set. #[configurable(metadata(docs::examples = "${KEY_PASS_ENV_VAR}"))] #[configurable(metadata(docs::examples = "PassWord1"))] + #[configurable(metadata(docs::human_name = "Key File Password"))] pub key_pass: Option, } diff --git a/src/aws/auth.rs b/src/aws/auth.rs index ec73bc97984bf..899ca39087bd9 100644 --- a/src/aws/auth.rs +++ b/src/aws/auth.rs @@ -117,6 +117,7 @@ pub enum AwsAuthentication { /// Relevant when the default credentials chain or `assume_role` is used. #[configurable(metadata(docs::type_unit = "seconds"))] #[configurable(metadata(docs::examples = 30))] + #[configurable(metadata(docs::human_name = "Load Timeout"))] load_timeout_secs: Option, /// Configuration for authenticating with AWS through IMDS. @@ -141,6 +142,7 @@ pub enum AwsAuthentication { /// Relevant when the default credentials chain or `assume_role` is used. #[configurable(metadata(docs::type_unit = "seconds"))] #[configurable(metadata(docs::examples = 30))] + #[configurable(metadata(docs::human_name = "Load Timeout"))] load_timeout_secs: Option, /// Configuration for authenticating with AWS through IMDS. diff --git a/src/sinks/aws_s3/config.rs b/src/sinks/aws_s3/config.rs index 38f22220d293a..27afbcd706d21 100644 --- a/src/sinks/aws_s3/config.rs +++ b/src/sinks/aws_s3/config.rs @@ -83,6 +83,7 @@ pub struct S3SinkConfig { /// This ensures there are no name collisions, and can be useful in high-volume workloads where /// object keys must be unique. #[serde(default = "crate::serde::default_true")] + #[configurable(metadata(docs::human_name = "Append UUID to Filename"))] pub filename_append_uuid: bool, /// The filename extension to use in the object key.