Struct vector::sources::http_client::client::HttpClientConfig

pub struct HttpClientConfig {
    pub endpoint: String,
    pub interval: Duration,
    pub timeout: Duration,
    pub query: HashMap<String, Vec<String>>,
    pub decoding: DeserializerConfig,
    pub framing: FramingConfig,
    pub headers: HashMap<String, Vec<String>>,
    pub method: HttpMethod,
    pub tls: Option<TlsConfig>,
    pub auth: Option<Auth>,
    pub log_namespace: Option<bool>,
}

Configuration for the http_client source.

Fields

endpoint: String

The HTTP endpoint to collect events from.

The full path must be specified.

interval: Duration

The interval between scrapes. Requests are run concurrently so if a scrape takes longer than the interval a new scrape will be started. This can take extra resources, set the timeout to a value lower than the scrape interval to prevent this from happening.

timeout: Duration

The timeout for each scrape request.

query: HashMap<String, Vec<String>>

Custom parameters for the HTTP request query string.

One or more values for the same parameter key can be provided.

The parameters provided in this option are appended to any parameters manually provided in the endpoint option.

decoding: DeserializerConfig

Decoder to use on the HTTP responses.

framing: FramingConfig

Framing to use in the decoding.

headers: HashMap<String, Vec<String>>

Headers to apply to the HTTP requests.

One or more values for the same header can be provided.

method: HttpMethod

Specifies the method of the HTTP request.

tls: Option<TlsConfig>

TLS configuration.

auth: Option<Auth>

HTTP Authentication.

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

Implementations

impl HttpClientConfig

pub fn get_decoding_config( &self, log_namespace: Option<LogNamespace>, ) -> DecodingConfig

Trait Implementations

impl Clone for HttpClientConfig

fn clone(&self) -> HttpClientConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for HttpClientConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for HttpClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for HttpClientConfig

fn generate_config() -> Value

impl NamedComponent for HttpClientConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for HttpClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for HttpClientConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

impl ToValue for HttpClientConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.