vector/sinks/http/
config.rs

1//! Configuration for the `http` sink.
2
3#[cfg(feature = "aws-core")]
4use aws_config::meta::region::ProvideRegion;
5#[cfg(feature = "aws-core")]
6use aws_types::region::Region;
7use http::{header::AUTHORIZATION, HeaderName, HeaderValue, Method, Request, StatusCode};
8use hyper::Body;
9use std::collections::BTreeMap;
10use std::path::PathBuf;
11use vector_lib::codecs::{
12    encoding::{Framer, Serializer},
13    CharacterDelimitedEncoder,
14};
15#[cfg(feature = "aws-core")]
16use vector_lib::config::proxy::ProxyConfig;
17
18use super::{
19    encoder::HttpEncoder, request_builder::HttpRequestBuilder, service::HttpSinkRequestBuilder,
20    sink::HttpSink,
21};
22#[cfg(feature = "aws-core")]
23use crate::aws::AwsAuthentication;
24#[cfg(feature = "aws-core")]
25use crate::sinks::util::http::SigV4Config;
26use crate::{
27    codecs::{EncodingConfigWithFraming, SinkType},
28    http::{Auth, HttpClient, MaybeAuth},
29    sinks::{
30        prelude::*,
31        util::{
32            http::{http_response_retry_logic, HttpService, OrderedHeaderName, RequestConfig},
33            RealtimeSizeBasedDefaultBatchSettings, UriSerde,
34        },
35    },
36};
37
38const CONTENT_TYPE_TEXT: &str = "text/plain";
39const CONTENT_TYPE_NDJSON: &str = "application/x-ndjson";
40const CONTENT_TYPE_JSON: &str = "application/json";
41
42/// Configuration for the `http` sink.
43#[configurable_component(sink("http", "Deliver observability event data to an HTTP server."))]
44#[derive(Clone, Debug)]
45#[serde(deny_unknown_fields)]
46pub struct HttpSinkConfig {
47    /// The full URI to make HTTP requests to.
48    ///
49    /// This should include the protocol and host, but can also include the port, path, and any other valid part of a URI.
50    #[configurable(metadata(docs::examples = "https://10.22.212.22:9000/endpoint"))]
51    pub uri: Template,
52
53    /// The HTTP method to use when making the request.
54    #[serde(default)]
55    pub method: HttpMethod,
56
57    #[configurable(derived)]
58    pub auth: Option<Auth>,
59
60    /// A list of custom headers to add to each request.
61    #[configurable(deprecated = "This option has been deprecated, use `request.headers` instead.")]
62    #[configurable(metadata(
63        docs::additional_props_description = "An HTTP request header and it's value."
64    ))]
65    pub headers: Option<BTreeMap<String, String>>,
66
67    #[configurable(derived)]
68    #[serde(default)]
69    pub compression: Compression,
70
71    #[serde(flatten)]
72    pub encoding: EncodingConfigWithFraming,
73
74    /// A string to prefix the payload with.
75    ///
76    /// This option is ignored if the encoding is not character delimited JSON.
77    ///
78    /// If specified, the `payload_suffix` must also be specified and together they must produce a valid JSON object.
79    #[configurable(metadata(docs::examples = "{\"data\":"))]
80    #[serde(default)]
81    pub payload_prefix: String,
82
83    /// A string to suffix the payload with.
84    ///
85    /// This option is ignored if the encoding is not character delimited JSON.
86    ///
87    /// If specified, the `payload_prefix` must also be specified and together they must produce a valid JSON object.
88    #[configurable(metadata(docs::examples = "}"))]
89    #[serde(default)]
90    pub payload_suffix: String,
91
92    #[configurable(derived)]
93    #[serde(default)]
94    pub batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>,
95
96    #[configurable(derived)]
97    #[serde(default)]
98    pub request: RequestConfig,
99
100    #[configurable(derived)]
101    pub tls: Option<TlsConfig>,
102
103    #[configurable(derived)]
104    #[serde(
105        default,
106        deserialize_with = "crate::serde::bool_or_struct",
107        skip_serializing_if = "crate::serde::is_default"
108    )]
109    pub acknowledgements: AcknowledgementsConfig,
110}
111
112/// HTTP method.
113///
114/// A subset of the HTTP methods described in [RFC 9110, section 9.1][rfc9110] are supported.
115///
116/// [rfc9110]: https://datatracker.ietf.org/doc/html/rfc9110#section-9.1
117#[configurable_component]
118#[derive(Clone, Copy, Debug, Derivative, Eq, PartialEq)]
119#[serde(rename_all = "snake_case")]
120#[derivative(Default)]
121pub enum HttpMethod {
122    /// GET.
123    Get,
124
125    /// HEAD.
126    Head,
127
128    /// POST.
129    #[derivative(Default)]
130    Post,
131
132    /// PUT.
133    Put,
134
135    /// DELETE.
136    Delete,
137
138    /// OPTIONS.
139    Options,
140
141    /// TRACE.
142    Trace,
143
144    /// PATCH.
145    Patch,
146}
147
148impl From<HttpMethod> for Method {
149    fn from(http_method: HttpMethod) -> Self {
150        match http_method {
151            HttpMethod::Head => Self::HEAD,
152            HttpMethod::Get => Self::GET,
153            HttpMethod::Post => Self::POST,
154            HttpMethod::Put => Self::PUT,
155            HttpMethod::Patch => Self::PATCH,
156            HttpMethod::Delete => Self::DELETE,
157            HttpMethod::Options => Self::OPTIONS,
158            HttpMethod::Trace => Self::TRACE,
159        }
160    }
161}
162
163impl HttpSinkConfig {
164    fn build_http_client(&self, cx: &SinkContext) -> crate::Result<HttpClient> {
165        let tls = TlsSettings::from_options(self.tls.as_ref())?;
166        Ok(HttpClient::new(tls, cx.proxy())?)
167    }
168
169    pub(super) fn build_encoder(&self) -> crate::Result<Encoder<Framer>> {
170        let (framer, serializer) = self.encoding.build(SinkType::MessageBased)?;
171        Ok(Encoder::<Framer>::new(framer, serializer))
172    }
173}
174
175impl GenerateConfig for HttpSinkConfig {
176    fn generate_config() -> toml::Value {
177        toml::from_str(
178            r#"uri = "https://10.22.212.22:9000/endpoint"
179            encoding.codec = "json""#,
180        )
181        .unwrap()
182    }
183}
184
185async fn healthcheck(uri: UriSerde, auth: Option<Auth>, client: HttpClient) -> crate::Result<()> {
186    let auth = auth.choose_one(&uri.auth)?;
187    let uri = uri.with_default_parts();
188    let mut request = Request::head(&uri.uri).body(Body::empty()).unwrap();
189
190    if let Some(auth) = auth {
191        auth.apply(&mut request);
192    }
193
194    let response = client.send(request).await?;
195
196    match response.status() {
197        StatusCode::OK => Ok(()),
198        status => Err(HealthcheckError::UnexpectedStatus { status }.into()),
199    }
200}
201
202pub(super) fn validate_headers(
203    headers: &BTreeMap<String, String>,
204    configures_auth: bool,
205) -> crate::Result<BTreeMap<OrderedHeaderName, HeaderValue>> {
206    let headers = crate::sinks::util::http::validate_headers(headers)?;
207
208    for name in headers.keys() {
209        if configures_auth && name.inner() == AUTHORIZATION {
210            return Err("Authorization header can not be used with defined auth options".into());
211        }
212    }
213
214    Ok(headers)
215}
216
217pub(super) fn validate_payload_wrapper(
218    payload_prefix: &str,
219    payload_suffix: &str,
220    encoder: &Encoder<Framer>,
221) -> crate::Result<(String, String)> {
222    let payload = [payload_prefix, "{}", payload_suffix].join("");
223    match (
224        encoder.serializer(),
225        encoder.framer(),
226        serde_json::from_str::<serde_json::Value>(&payload),
227    ) {
228        (
229            Serializer::Json(_),
230            Framer::CharacterDelimited(CharacterDelimitedEncoder { delimiter: b',' }),
231            Err(_),
232        ) => Err("Payload prefix and suffix wrapper must produce a valid JSON object.".into()),
233        _ => Ok((payload_prefix.to_owned(), payload_suffix.to_owned())),
234    }
235}
236
237#[async_trait]
238#[typetag::serde(name = "http")]
239impl SinkConfig for HttpSinkConfig {
240    async fn build(&self, cx: SinkContext) -> crate::Result<(VectorSink, Healthcheck)> {
241        let batch_settings = self.batch.validate()?.into_batcher_settings()?;
242
243        let encoder = self.build_encoder()?;
244        let transformer = self.encoding.transformer();
245
246        let mut request = self.request.clone();
247        request.add_old_option(self.headers.clone());
248
249        validate_headers(&request.headers, self.auth.is_some())?;
250        let (static_headers, template_headers) = request.split_headers();
251
252        let (payload_prefix, payload_suffix) =
253            validate_payload_wrapper(&self.payload_prefix, &self.payload_suffix, &encoder)?;
254
255        let client = self.build_http_client(&cx)?;
256
257        let healthcheck = match cx.healthcheck.uri {
258            Some(healthcheck_uri) => {
259                healthcheck(healthcheck_uri, self.auth.clone(), client.clone()).boxed()
260            }
261            None => future::ok(()).boxed(),
262        };
263
264        let content_type = {
265            use Framer::*;
266            use Serializer::*;
267            match (encoder.serializer(), encoder.framer()) {
268                (RawMessage(_) | Text(_), _) => Some(CONTENT_TYPE_TEXT.to_owned()),
269                (Json(_), NewlineDelimited(_)) => Some(CONTENT_TYPE_NDJSON.to_owned()),
270                (Json(_), CharacterDelimited(CharacterDelimitedEncoder { delimiter: b',' })) => {
271                    Some(CONTENT_TYPE_JSON.to_owned())
272                }
273                _ => None,
274            }
275        };
276
277        let request_builder = HttpRequestBuilder {
278            encoder: HttpEncoder::new(encoder, transformer, payload_prefix, payload_suffix),
279            compression: self.compression,
280        };
281
282        let content_encoding = self.compression.is_compressed().then(|| {
283            self.compression
284                .content_encoding()
285                .expect("Encoding should be specified for compression.")
286                .to_string()
287        });
288
289        let converted_static_headers = static_headers
290            .into_iter()
291            .map(|(name, value)| -> crate::Result<_> {
292                let header_name =
293                    HeaderName::from_bytes(name.as_bytes()).map(OrderedHeaderName::from)?;
294                let header_value = HeaderValue::try_from(value)?;
295                Ok((header_name, header_value))
296            })
297            .collect::<Result<BTreeMap<_, _>, _>>()?;
298
299        let http_sink_request_builder = HttpSinkRequestBuilder::new(
300            self.method,
301            self.auth.clone(),
302            converted_static_headers,
303            content_type,
304            content_encoding,
305        );
306
307        let service = match &self.auth {
308            #[cfg(feature = "aws-core")]
309            Some(Auth::Aws { auth, service }) => {
310                let default_region = crate::aws::region_provider(&ProxyConfig::default(), None)?
311                    .region()
312                    .await;
313                let region = (match &auth {
314                    AwsAuthentication::AccessKey { region, .. } => region.clone(),
315                    AwsAuthentication::File { .. } => None,
316                    AwsAuthentication::Role { region, .. } => region.clone(),
317                    AwsAuthentication::Default { region, .. } => region.clone(),
318                })
319                .map_or(default_region, |r| Some(Region::new(r.to_string())))
320                .expect("Region must be specified");
321
322                HttpService::new_with_sig_v4(
323                    client,
324                    http_sink_request_builder,
325                    SigV4Config {
326                        shared_credentials_provider: auth
327                            .credentials_provider(region.clone(), &ProxyConfig::default(), None)
328                            .await?,
329                        region: region.clone(),
330                        service: service.clone(),
331                    },
332                )
333            }
334            _ => HttpService::new(client, http_sink_request_builder),
335        };
336
337        let request_limits = self.request.tower.into_settings();
338
339        let service = ServiceBuilder::new()
340            .settings(request_limits, http_response_retry_logic())
341            .service(service);
342
343        let sink = HttpSink::new(
344            service,
345            self.uri.clone(),
346            template_headers,
347            batch_settings,
348            request_builder,
349        );
350
351        Ok((VectorSink::from_event_streamsink(sink), healthcheck))
352    }
353
354    fn input(&self) -> Input {
355        Input::new(self.encoding.config().1.input_type())
356    }
357
358    fn files_to_watch(&self) -> Vec<&PathBuf> {
359        let mut files = Vec::new();
360        if let Some(tls) = &self.tls {
361            if let Some(crt_file) = &tls.crt_file {
362                files.push(crt_file)
363            }
364            if let Some(key_file) = &tls.key_file {
365                files.push(key_file)
366            }
367        };
368        files
369    }
370
371    fn acknowledgements(&self) -> &AcknowledgementsConfig {
372        &self.acknowledgements
373    }
374}
375
376#[cfg(test)]
377mod tests {
378    use vector_lib::codecs::encoding::format::JsonSerializerOptions;
379
380    use super::*;
381    use crate::components::validation::prelude::*;
382
383    impl ValidatableComponent for HttpSinkConfig {
384        fn validation_configuration() -> ValidationConfiguration {
385            use std::str::FromStr;
386            use vector_lib::codecs::{JsonSerializerConfig, MetricTagValues};
387            use vector_lib::config::LogNamespace;
388
389            let endpoint = "http://127.0.0.1:9000/endpoint";
390            let uri = UriSerde::from_str(endpoint).expect("should never fail to parse");
391
392            let config = HttpSinkConfig {
393                uri: Template::try_from(endpoint).expect("should never fail to parse"),
394                method: HttpMethod::Post,
395                encoding: EncodingConfigWithFraming::new(
396                    None,
397                    JsonSerializerConfig::new(
398                        MetricTagValues::Full,
399                        JsonSerializerOptions::default(),
400                    )
401                    .into(),
402                    Transformer::default(),
403                ),
404                auth: None,
405                headers: None,
406                compression: Compression::default(),
407                batch: BatchConfig::default(),
408                request: RequestConfig::default(),
409                tls: None,
410                acknowledgements: AcknowledgementsConfig::default(),
411                payload_prefix: String::new(),
412                payload_suffix: String::new(),
413            };
414
415            let external_resource = ExternalResource::new(
416                ResourceDirection::Push,
417                HttpResourceConfig::from_parts(uri.uri, Some(config.method.into())),
418                config.encoding.clone(),
419            );
420
421            ValidationConfiguration::from_sink(
422                Self::NAME,
423                LogNamespace::Legacy,
424                vec![ComponentTestCaseConfig::from_sink(
425                    config,
426                    None,
427                    Some(external_resource),
428                )],
429            )
430        }
431    }
432
433    register_validatable_component!(HttpSinkConfig);
434}
vector/sinks/http/config.rs

vector/sinks/http/
config.rs
