Struct vector::sinks::elasticsearch::ElasticsearchConfig

pub struct ElasticsearchConfig {

    pub endpoint: Option<String>,
    pub endpoints: Vec<String>,
    pub doc_type: String,
    pub api_version: ElasticsearchApiVersion,
    pub suppress_type_name: bool,
    pub request_retry_partial: bool,
    pub id_key: Option<ConfigValuePath>,
    pub pipeline: Option<String>,
    pub mode: ElasticsearchMode,
    pub compression: Compression,
    pub encoding: Transformer,
    pub batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>,
    pub request: RequestConfig,
    pub auth: Option<ElasticsearchAuthConfig>,
    pub query: Option<HashMap<String, String>>,
    pub aws: Option<RegionOrEndpoint>,
    pub opensearch_service_type: OpenSearchServiceType,
    pub tls: Option<TlsConfig>,
    pub endpoint_health: Option<HealthConfig>,
    pub bulk: BulkConfig,
    pub data_stream: Option<DataStreamConfig>,
    pub metrics: Option<MetricToLogConfig>,
    pub acknowledgements: AcknowledgementsConfig,
}

Configuration for the elasticsearch sink.

Fields

endpoint: Option<String>

The Elasticsearch endpoint to send logs to.

The endpoint must contain an HTTP scheme, and may specify a hostname or IP address and port.

endpoints: Vec<String>

A list of Elasticsearch endpoints to send logs to.

The endpoint must contain an HTTP scheme, and may specify a hostname or IP address and port.

doc_type: String

The doc_type for your index data.

This is only relevant for Elasticsearch <= 6.X. If you are using >= 7.0 you do not need to set this option since Elasticsearch has removed it.

api_version: ElasticsearchApiVersion

The API version of Elasticsearch.

Amazon OpenSearch Serverless requires this option to be set to auto (the default).

suppress_type_name: bool

Whether or not to send the type field to Elasticsearch.

The type field was deprecated in Elasticsearch 7.x and removed in Elasticsearch 8.x.

If enabled, the doc_type option is ignored.

request_retry_partial: bool

Whether or not to retry successful requests containing partial failures.

To avoid duplicates in Elasticsearch, please use option id_key.

id_key: Option<ConfigValuePath>

The name of the event key that should map to Elasticsearch’s _id field.

By default, the _id field is not set, which allows Elasticsearch to set this automatically. Setting your own Elasticsearch IDs can hinder performance.

pipeline: Option<String>

The name of the pipeline to apply.

mode: ElasticsearchMode

compression: Compression

encoding: Transformer

batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>

request: RequestConfig

auth: Option<ElasticsearchAuthConfig>

query: Option<HashMap<String, String>>

Custom parameters to add to the query string for each HTTP request sent to Elasticsearch.

aws: Option<RegionOrEndpoint>

opensearch_service_type: OpenSearchServiceType

Amazon OpenSearch service type

tls: Option<TlsConfig>

endpoint_health: Option<HealthConfig>

bulk: BulkConfig

data_stream: Option<DataStreamConfig>

metrics: Option<MetricToLogConfig>

acknowledgements: AcknowledgementsConfig

Implementations

impl ElasticsearchConfig

pub fn common_mode(&self) -> Result<ElasticsearchCommonMode>

Trait Implementations

impl Clone for ElasticsearchConfig

fn clone(&self) -> ElasticsearchConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for ElasticsearchConfig

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 ElasticsearchConfig

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

Formats the value using the given formatter.

impl Default for ElasticsearchConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElasticsearchConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for ElasticsearchConfig

fn generate_config() -> Value

impl NamedComponent for ElasticsearchConfig

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

Gets the name of the component.

impl Serialize for ElasticsearchConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for ElasticsearchConfig

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

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

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

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

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

impl ToValue for ElasticsearchConfig

fn to_value(&self) -> Value

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