Add Enterprise Search user settingsedit

Change how Enterprise Search runs by providing your own user settings. User settings are appended to the ent-search.yml configuration file for your instance and provide custom configuration options.

Some settings that could break your cluster if set incorrectly are blacklisted. Review the list of settings that are generally safe in cloud environments. For detailed information about Enterprise Search settings, see the Enterprise Search documentation.

To add user settings:

  1. Log in to the Elasticsearch Service Console.
  2. Select your deployment on the home page in the Elasticsearch Service card or go to the deployments page.

    Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.

  3. From your deployment menu, go to the Edit page.
  4. At the bottom of the Enterprise Search section, expand the User settings overrides caret.
  5. Update the user settings.
  6. Click Save changes.

If a setting is not supported by Elasticsearch Service, an error message displays when you try to save your settings.

Supported Enterprise Search settingsedit

Elasticsearch Service supports the following Enterprise Search settings.

For version 7.11 and later:

crawler.user_agent
Custom User-Agent header value to be used by the crawler.
crawl.per_crawl.max_duration.limit
Maximum duration (in seconds) of a crawl before the crawler will shut down automatically.
crawl.per_crawl.max_crawl_depth.limit
How many sequential links should the crawler follow into the site before stopping new link discovery.

crawl.per_crawl.max_url_length.limit: Maximum length of a URL (in characters) the crawler is allowed to follow.

crawl.per_crawl.max_url_segments.limit: Maximum number of path segments in a URL allowed to be followed by the crawler (for example, /a/b/c/d has 4).

crawl.per_crawl.max_url_params.limit
Maximum number of query parameters in a URL allowed to be followed by the crawler (for example, /a?b=c&d=e has 2).
crawl.per_crawl.max_unique_url_count.limit
Maximum number of unique URLs the crawler is allowed to index before it stops looking for new content and finishes the crawl automatically.

For version 7.10 and later:

workplace_search.content_source.sync.max_errors
If an indexing job encounters more total errors than this value, the job will fail.
workplace_search.content_source.sync.max_consecutive_errors
If an indexing job encounters more errors in a row than this value, the job will fail.
workplace_search.content_source.sync.max_error_ratio
If an indexing job encounters an error ratio greater than this value in a given window, or overall at the end of the job, the job will fail.
workplace_search.content_source.sync.error_ratio_window_size
Configure how large of a window to consider when calculating an error ratio (see workplace_search.content_source.sync.max_error_ratio).

For version 7.9 and later:

ent_search.auth.<auth_name>.source
(7.9.2+) The origin of authenticated Enterprise Search users. <auth_name> is the name of the SAML realm as defined in Elasticsearch. Set this to elasticsearch-saml if you are adding your own custom SAML realm. Otherwise, leave this unset.
ent_search.auth.<auth_name>.order
(7.9.2+) The order in which to display this provider on the login screen. <auth_name> is the name of the SAML realm as defined in Elasticsearch. Required when ent_search.auth.<auth_name>.source is set.
ent_search.auth.<auth_name>.description
(7.9.2+) The name to be displayed on the login screen associated with this provider. <auth_name> is the name of the SAML realm as defined in Elasticsearch. Required when ent_search.auth.<auth_name>.source is set.
ent_search.auth.<auth_name>.icon
(7.9.2+) The URL to an icon to be displayed on the login screen associated with this provider. <auth_name> is the name of the SAML realm as defined in Elasticsearch. Required when ent_search.auth.<auth_name>.source is set.
ent_search.auth.<auth_name>.hidden
(7.9.2+) Boolean value to determine whether or not to display this login option on the login screen. <auth_name> is the name of the SAML realm as defined in Elasticsearch. Optional when ent_search.auth.<auth_name>.source is set.
ent_search.login_assistance_message
Adds a message to the login screen. This field supports Markdown.

For version 7.7 and later:

ent_search.auth.source
(7.7-7.9.1) The origin of authenticated Enterprise Search users. Set this to elasticsearch-saml if you are adding your own custom SAML realm. Otherwise, leave this unset.
ent_search.auth.name
(7.7-7.9.1) The name of your SAML authentication realm as defined in Elasticsearch. Required when ent_search.auth.source is set.
workplace_search.custom_api_source.document_size.limit
Maximum allowed document size for Custom API Sources (in bytes).
workplace_search.custom_api_source.total_fields.limit
Number of fields a Custom API Source can have.
app_search.engine.document_size.limit
Maximum allowed document size in App Search engines (in bytes).
app_search.engine.total_fields.limit
Number of fields an App Search engine can have.
app_search.engine.source_engines_per_meta_engine.limit
Number of source engines a meta engine can have.
app_search.engine.total_facet_values_returned.limit
Number of facet values that can be returned by a search.
app_search.engine.query.limit
Size of full-text queries that are allowed.
app_search.engine.synonyms.sets.limit
Total number of synonym sets an engine can have.
app_search.engine.synonyms.terms_per_set.limit
Total number of terms a synonym set can have.
app_search.engine.analytics.total_tags.limit
Number of analytics tags that can be associated with a single query or clickthrough.
log_level
Minimum log level. One of debug, info, warn, error, fatal or unknown. Defaults to info.

To change log level you must first enable deployment logging.