chore(config): Update field labels for sinks (#17560)

Author: maycmlee

src/sinks/blackhole/config.rs

@@ -26,6 +26,7 @@ pub struct BlackholeConfig {
     #[derivative(Default(value = "default_print_interval_secs()"))]
     #[serde(default = "default_print_interval_secs")]
     #[serde_as(as = "serde_with::DurationSeconds<u64>")]
+    #[configurable(metadata(docs::human_name = "Print Interval"))]
     #[configurable(metadata(docs::examples = 10))]
     pub print_interval_secs: Duration,
 

src/sinks/file/mod.rs

@@ -61,6 +61,7 @@ pub struct FileSinkConfig {
     #[serde_as(as = "serde_with::DurationSeconds<u64>")]
     #[serde(rename = "idle_timeout_secs")]
     #[configurable(metadata(docs::examples = 600))]
+    #[configurable(metadata(docs::human_name = "Idle Timeout"))]
     pub idle_timeout: Duration,
 
     #[serde(flatten)]

src/sinks/kafka/config.rs

@@ -80,12 +80,14 @@ pub struct KafkaSinkConfig {
     #[serde(default = "default_socket_timeout_ms")]
     #[configurable(metadata(docs::examples = 30000, docs::examples = 60000))]
     #[configurable(metadata(docs::advanced))]
+    #[configurable(metadata(docs::human_name = "Socket Timeout"))]
     pub socket_timeout_ms: Duration,
 
     /// Local message timeout, in milliseconds.
     #[serde_as(as = "serde_with::DurationMilliSeconds<u64>")]
     #[configurable(metadata(docs::examples = 150000, docs::examples = 450000))]
     #[serde(default = "default_message_timeout_ms")]
+    #[configurable(metadata(docs::human_name = "Message Timeout"))]
     #[configurable(metadata(docs::advanced))]
     pub message_timeout_ms: Duration,
 

src/sinks/mezmo.rs

@@ -82,10 +82,12 @@ pub struct MezmoConfig {
 
     /// The MAC address that is attached to each batch of events.
     #[configurable(metadata(docs::examples = "my-mac-address"))]
+    #[configurable(metadata(docs::human_name = "MAC Address"))]
     mac: Option<String>,
 
     /// The IP address that is attached to each batch of events.
     #[configurable(metadata(docs::examples = "0.0.0.0"))]
+    #[configurable(metadata(docs::human_name = "IP Address"))]
     ip: Option<String>,
 
     /// The tags that are attached to each batch of events.

src/sinks/prometheus/exporter.rs

@@ -126,6 +126,7 @@ pub struct PrometheusExporterConfig {
     #[serde(default = "default_flush_period_secs")]
     #[serde_as(as = "serde_with::DurationSeconds<u64>")]
     #[configurable(metadata(docs::advanced))]
+    #[configurable(metadata(docs::human_name = "Flush Interval"))]
     pub flush_period_secs: Duration,
 
     /// Suppresses timestamps on the Prometheus output.

src/sinks/util/batch.rs

@@ -114,6 +114,7 @@ where
     /// The maximum age of a batch before it is flushed.
     #[serde(default = "default_timeout::<D>")]
     #[configurable(metadata(docs::type_unit = "seconds"))]
+    #[configurable(metadata(docs::human_name = "Timeout"))]
     pub timeout_secs: Option<f64>,
 
     #[serde(skip)]

src/sinks/util/service.rs

@@ -102,16 +102,19 @@ pub struct TowerRequestConfig {
     /// create orphaned requests, pile on retries, and result in duplicate data downstream.
     #[configurable(metadata(docs::type_unit = "seconds"))]
     #[serde(default = "default_timeout_secs")]
+    #[configurable(metadata(docs::human_name = "Timeout"))]
     pub timeout_secs: Option<u64>,
 
     /// The time window used for the `rate_limit_num` option.
     #[configurable(metadata(docs::type_unit = "seconds"))]
     #[serde(default = "default_rate_limit_duration_secs")]
+    #[configurable(metadata(docs::human_name = "Rate Limit Duration"))]
     pub rate_limit_duration_secs: Option<u64>,
 
     /// The maximum number of requests allowed within the `rate_limit_duration_secs` time window.
     #[configurable(metadata(docs::type_unit = "requests"))]
     #[serde(default = "default_rate_limit_num")]
+    #[configurable(metadata(docs::human_name = "Rate Limit Number"))]
     pub rate_limit_num: Option<u64>,
 
     /// The maximum number of retries to make for failed requests.
@@ -124,13 +127,15 @@ pub struct TowerRequestConfig {
     /// The maximum amount of time to wait between retries.
     #[configurable(metadata(docs::type_unit = "seconds"))]
     #[serde(default = "default_retry_max_duration_secs")]
+    #[configurable(metadata(docs::human_name = "Max Retry Duration"))]
     pub retry_max_duration_secs: Option<u64>,
 
     /// The amount of time to wait before attempting the first retry for a failed request.
     ///
     /// After the first retry has failed, the fibonacci sequence is used to select future backoffs.
     #[configurable(metadata(docs::type_unit = "seconds"))]
     #[serde(default = "default_retry_initial_backoff_secs")]
+    #[configurable(metadata(docs::human_name = "Retry Initial Backoff"))]
     pub retry_initial_backoff_secs: Option<u64>,
 
     #[configurable(derived)]

src/sinks/util/service/health.rs

@@ -37,11 +37,13 @@ pub struct HealthConfig {
     #[serde(default = "default_retry_initial_backoff_secs")]
     #[configurable(metadata(docs::type_unit = "seconds"))]
     // not using Duration type because the value is only used as a u64.
+    #[configurable(metadata(docs::human_name = "Retry Initial Backoff"))]
     pub retry_initial_backoff_secs: u64,
 
     /// Maximum delay between attempts to reactivate endpoints once they become unhealthy.
     #[serde_as(as = "serde_with::DurationSeconds<u64>")]
     #[serde(default = "default_retry_max_duration_secs")]
+    #[configurable(metadata(docs::human_name = "Max Retry Duration"))]
     pub retry_max_duration_secs: Duration,
 }