Skip to main content

Elasticsearch

The Conduit Platform by default supports Elasticsearch as a destination only.

The Elasticsearch destination can connect to and produce records to an index.

Required Configurations

NameDescriptionRequiredDefault
hostThe Elasticsearch host and port. Example: http://127.0.0.1:9200Yes
versionThe version of the Elasticsearch service. Supported versions: 5, 6, 7, 8.Yes
usernameThe username for HTTP Basic Authentication. Supported versions: 5, 6, 7, or 8.Yes, if using HTTP Basic Authentication.
passwordThe password for HTTP Basic Authentication. Supported versions: 5, 6, 7, or 8.Yes, if using HTTP Basic Authentication.
indexThe name of the index to write the data to.Yes
typeThe name of the index's type to write the data to. Supported versions: 5 or 6.Yes, if version 5 or 6. No, if any other version.
bulkSizeThe number of items stored in bulk in the index. The minimum value is 1, maximum value is 10000. Note that values greater than 1000 may require additional service configuration.Yes"1000"
retriesThe maximum number of retries of failed operations. The minimum value is 0 which disabled retry logic. The maximum value is 255. Note that the higher value, the longer it may take to process retries, as a result, ingest next operations.Yes"1000"

Looking for something else? See advanced configurations.

Upsert Behavior

The destination connector waits until the record has Key set, then uses it as a Document ID. Moreover, when the Record has action entry in the Metadata, then action specified there is respected.

  • INSERT When Record.Key is missing, stores a new Document without ID.
  • UPDATE: Stores or updates (upsert) a Document with ID. Default case when action is not set but Record.Key is set.
  • DELETE: Deletes a Document by its Record.Key.

For any other action a warning entry is added to log and Record is skipped.

Advanced Configurations

NameDescriptionRequiredDefault
usernameThe username for HTTP Basic Authentication. Supported versions: 5, 6, 7, or 8.No
cloudIdEndpoint for the Elastic Service (https://elastic.co/cloud). Supported versions: 6, 7, or 8.No
apiKeyBase64-encoded token for authorization; if set, overrides username/password and service token. Supported versions: 6, 7, or 8.No1000012
serviceTokenService token for authorization; if set, overrides username/password. Supported versions: 7 or 8.No
certificateFingerprintSHA256 hex fingerprint given by Elasticsearch on first launch. Supported versions: 7 or 8.No