elasticsearch/docs/reference
Christoph Büscher 8067f01d48
Runtime fields to optionally ignore script errors (#92380)
Currently Elasticsearch always returns a shard failure once a runtime error arises from using a runtime field, the exception being script-less runtime fields. This also means that execution of the query for that shard stops, which is okay for development and exploration. In a production scenario, however, it is often desirable to ignore runtime errors and continue with the query execution.

This change adds a new a new on_script_error parameter to runtime field definitions similar to the already existing
parameter for index-time scripted fields. When `on_script_error` is set to `continue`, errors from script execution are effectively ignored. This means affected documents don't show up in query results, but also don't prevent other matches from the same shard. Runtime fields accessed through the fields API don't return values on errors, aggregations will ignore documents that throw errors.

Note that this change affects scripted runtime fields only, while leaving default behaviour untouched. Also, ignored errors are not reported back to users for now.

Relates to #72143
2022-12-23 09:29:12 +01:00
..
aggregations [ML] add the ability to include and exclude values in Frequent items (#92414) 2022-12-21 12:24:10 +01:00
analysis [DOCS] Fix typo (#92481) 2022-12-21 10:17:49 +01:00
autoscaling [DOCS] Updates ML decider docs by mentioning CPU as scaling criterion (#92018) 2022-11-30 13:37:20 +01:00
cat Redefine section on sizing data nodes (#90274) 2022-09-30 12:37:21 +03:00
ccr [DOCS] Add CCR limitation (#87348) 2022-10-17 16:05:29 -04:00
cluster Update get-settings.asciidoc (#91538) 2022-12-22 15:54:26 +01:00
commands Document jvm options for cli tools (#92510) 2022-12-22 15:32:07 -08:00
data-management [DOC] auto migrate only for default template (#82043) 2022-05-10 11:35:19 -04:00
data-streams Remove tech preview disclaimer from TSDS ingest docs (#91519) 2022-11-22 09:23:40 -05:00
docs [DOCS] Add missing privilege to bulk prerequisites (#92237) 2022-12-12 16:06:16 +01:00
eql Update docs about EQL CCS (#91542) 2022-11-15 14:07:26 +01:00
features/apis Fix typo (#91894) 2022-11-24 14:40:43 +01:00
fleet Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00
graph [DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
health GA the health API (#92420) 2022-12-20 10:26:53 +00:00
high-availability Weaken language about "low-latency" networks (#89198) 2022-08-09 13:15:37 +01:00
how-to [DOCS] Typo in Search speed (#91934) 2022-11-28 13:55:47 +01:00
ilm Update ilm-index-lifecycle.asciidoc (#91782) 2022-12-07 09:23:04 +01:00
images Disk indicator troubleshooting guides (#90504) 2022-10-14 15:24:21 +02:00
index-modules Introduce max headroom for disk watermark stages (#88639) 2022-09-19 14:59:18 +03:00
indices Mark simulate index API non-experimental in documentation (#92331) 2022-12-13 11:34:32 -07:00
ingest Adding more detail about ingest.geoip.downloader.endpoint (#91182) 2022-11-09 09:17:33 -06:00
licensing [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
mapping Runtime fields to optionally ignore script errors (#92380) 2022-12-23 09:29:12 +01:00
migration Bump to version 8.7.0 2022-11-16 16:32:19 +02:00
ml [ML] Increase the default timeout for start trained model deployment (#92328) 2022-12-14 13:32:23 +00:00
modules Fix format for cluster.discovery_configuration_check.interval (#90452) 2022-12-22 16:11:33 +01:00
monitoring Metricbeat monitoring collection suggest to enable local exporters (#77409) 2022-11-23 12:41:41 +01:00
query-dsl Wrapper query docs refer to transport client and HLRC #89263 (#91149) 2022-12-15 13:44:58 +00:00
release-notes [ML] Adding a known issue for the ML datafeed auth header problem (#92274) 2022-12-13 09:22:49 +00:00
repositories-metering-api [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
rest-api [DOCS] Adds bullet points to the statuses of the health object in transform stats API docs (#91790) 2022-11-22 15:18:08 +01:00
rollup [DOCS] Add downsampling reference to rollup docs (#91295) 2022-11-08 10:02:17 -05:00
scripting [Docs] Fix runtime grok script example (#87851) 2022-07-05 10:53:24 -04:00
search Fixes typo in knn search page (#91898) 2022-11-24 16:35:44 +01:00
searchable-snapshots Update language around eliminating replicate shards (#90375) 2022-09-26 14:49:12 -04:00
settings JWT Realm - documentation update (#92409) 2022-12-19 12:22:24 +00:00
setup Use default text for preview warning with tcp readiness port (#92508) 2022-12-21 13:49:15 -08:00
shutdown/apis [doc] Explicitly mention about node shutdown remove for cluster shrink (#86173) 2022-05-09 10:24:54 +02:00
slm/apis [DOCS] Remove soft limit for snapshot repositories (#80745) 2021-11-16 12:24:18 -05:00
snapshot-restore Clarify use of S3 lifecycle policies (#92427) 2022-12-19 09:04:29 +00:00
sql SQL: Implement DATE_FORMAT function (#88388) 2022-09-12 09:33:34 +02:00
tab-widgets [HealthAPI] Add support for the FEATURE_STATE affected resource (#92296) 2022-12-20 13:39:41 +00:00
text-structure/apis [ML] Unmute text-structure docs test (#92224) 2022-12-08 09:19:41 +00:00
transform [DOCS] Adds example of better index resolve to transforms at scale (#92234) 2022-12-12 15:18:49 +01:00
troubleshooting Update circuit-breaker-errors.asciidoc (#92070) 2022-12-05 10:53:06 +01:00
upgrade Docs for snapshots as simple archives (#86261) 2022-05-30 13:23:53 +02:00
vectors [DOCS] Warn about calling vector functions repeatedly (#91864) 2022-12-12 09:43:46 +01:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc [DOCS] Fix default for is_write_index (#77006) (#77362) 2021-09-07 11:34:53 -04:00
analysis.asciidoc Update Lucene analysis base url (#84094) 2022-02-17 12:44:12 +01:00
api-conventions.asciidoc Fix a typo in api-conventions example (#88056) 2022-06-27 13:58:51 -04:00
cat.asciidoc [DOCS] Remove unneeded escapes 2021-04-26 12:14:45 -04:00
cluster.asciidoc Prevalidate node removal API (pt. 1) (#88952) 2022-11-16 13:44:00 +01:00
data-management.asciidoc reorder and merge data management and ILM doc pages (#84679) 2022-03-07 18:33:28 -05:00
data-rollup-transform.asciidoc [DOCS] Remove ifdefs for rollup refactor 2021-08-05 09:08:04 -04:00
datatiers.asciidoc [DOCS] Fix duplicate anchor (#85424) 2022-03-28 15:16:08 -07:00
dependencies-versions.asciidoc [DOCS] Replace dependencies list with a link. Closes #84863 (#90694) 2022-11-09 14:37:55 -08:00
docs.asciidoc [DOCS] Update single index APIs reference (#73103) 2021-05-14 11:53:34 -04:00
gs-index.asciidoc
high-availability.asciidoc [DOCS] Overhaul snapshot and restore docs (#79081) 2021-11-15 12:45:07 -05:00
how-to.asciidoc Add guide for tuning kNN search (#89782) 2022-10-12 14:53:53 -07:00
index-custom-title-page.html Move 'Explore by use case' block down (#92231) 2022-12-14 18:44:20 +01:00
index-modules.asciidoc [DOCS] Revert changes for ES_JAVA_OPTS (#89931) 2022-09-08 13:37:39 -04:00
index.asciidoc [DOCS] Remove ES quickstart. (#87939) 2022-06-23 14:25:48 -07:00
index.x.asciidoc
indices.asciidoc [DOCS] Add Downsampling docs (#88571) 2022-10-12 12:10:16 -04:00
ingest.asciidoc [DOCS] Add reference for ingest pipelines in Enterprise Search (#91357) 2022-11-08 09:22:01 +01:00
intro.asciidoc [DOCS] Update ES intro for stretched clusters (#77651) 2021-09-13 16:50:08 -04:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc Allow doc-values only search on geo_point fields (#83395) 2022-02-02 11:56:19 +01:00
redirects.asciidoc [DOCS] Add minimal security steps back to docs (#88393) 2022-07-19 10:01:34 -04:00
release-notes.asciidoc [DOCS] Forward-port doc changes after the 8.5.3 release (#92257) 2022-12-09 14:45:22 +01:00
scripting.asciidoc [DOCS] Add documentation for Painless field API (#83388) 2022-02-03 15:15:38 -05:00
search.asciidoc [DOCS] Semantic search endpoint (#91210) 2022-11-01 09:01:55 -07:00
setup.asciidoc [DOCS] Add simple dev setup instructions back to the README (#89714) 2022-09-01 16:49:05 -07:00
troubleshooting.asciidoc Disk indicator troubleshooting guides (#90504) 2022-10-14 15:24:21 +02:00
upgrade.asciidoc Reinstate prerelease upgrade warning (#90093) 2022-09-16 00:06:08 +09:30