Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script processor doc links to update API examples which is confusing #72645

Closed
ppf2 opened this issue May 3, 2021 · 2 comments · Fixed by #72691
Closed

Script processor doc links to update API examples which is confusing #72645

ppf2 opened this issue May 3, 2021 · 2 comments · Fixed by #72691
Assignees
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team

Comments

@ppf2
Copy link
Member

ppf2 commented May 3, 2021

On this page (https://www.elastic.co/guide/en/elasticsearch/reference/master/script-processor.html), we link to the general scripting examples page that is used by the update API.

See How to use scripts to learn more about writing scripts. The Script Processor leverages caching of compiled scripts for improved performance. Since the script specified within the processor is potentially re-compiled per document, it is important to understand how script caching works. To learn more about caching see Script Caching.

This is misleading because the ingest processor context for painless is different from the update API. Users end up trying to get the update API examples working (for example, ctx._source does not work in the ingest node context).

It will be helpful to have an example page linked from script processor that is for ingest node (does not include all the examples for other non-ingest use cases of painless), or provide ingest node script processor examples directly on the script processor page. Thx!

@ppf2 ppf2 added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP labels May 3, 2021
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Data Management Meta label for data/management team labels May 3, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants