[DOC] Update error_trace URL parameter description #1235
Labels
2 - In progress
Issue/PR: The issue or PR is in progress.
3 - Tech review
PR: Tech review in progress
good first issue
Good for newcomers
v-All
This issue is valid for all versions through 1.3
Milestone
What do you want to do?
Tell us about your request. Provide a summary of the request and all versions that are affected.
Coming from this issue#4255
The description of Stack traces in OpenSearch documentation is not comprehensive and may leading to some misunderstanding.
"To include the error stack trace in the response when an exception is raised, add
error_trace=true
to the request URL." is right.It is better to add the description of Config setting: If there is a setting of
http.detailed_errors.enabled: false
in config file, theerror_trace
url request will be rejected.The detailed logic will be:
When the config setting
http.detailed_errors.enabled: false
, the request oferror_trace=true
will not contain the detailed error message.This code regarding to this setting is from: https://github.com/opensearch-project/OpenSearch/blob/2.2.1/server/src/main/java/org/opensearch/rest/RestController.java#L368-L375
When there is no config setting for
http.detailed_errors.enabled
orhttp.detailed_errors.enabled: true
, the response of URL parameter will contain detailed error message:What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
The text was updated successfully, but these errors were encountered: