elasticsearch data source

blackstork/elastic, v0.4.2

Installation #

To use elasticsearch data source, you must install the plugin blackstork/elastic.

To install the plugin, add the full plugin name to the plugin_versions map in the Fabric global configuration block (see Global configuration for more details), as shown below:

fabric {
  plugin_versions = {
    "blackstork/elastic" = ">= v0.4.2"
  }
}

Note the version constraint set for the plugin.

Configuration #

The data source supports the following configuration arguments:

config data elasticsearch {
  # Optional string.
  # Default value:
  base_url = null

  # Optional string.
  # Default value:
  cloud_id = null

  # Optional string.
  # Default value:
  api_key_str = null

  # Optional list of string.
  # Default value:
  api_key = null

  # Optional string.
  # Default value:
  basic_auth_username = null

  # Optional string.
  # Default value:
  basic_auth_password = null

  # Optional string.
  # Default value:
  bearer_auth = null

  # Optional string.
  # Default value:
  ca_certs = null
}

Usage #

The data source supports the following execution arguments:

data elasticsearch {
  # Required string.
  # For example:
  index = "some string"

  # Optional string.
  # Default value:
  id = null

  # Optional string.
  # Default value:
  query_string = null

  # Optional map of any single type.
  # Default value:
  query = null

  # Optional any type.
  # Default value:
  aggs = null

  # Optional bool.
  # Default value:
  only_hits = null

  # Optional list of string.
  # Default value:
  fields = null

  # Optional number.
  # Default value:
  size = null
}