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

Added second paragraph to Stack traces option #1403

Merged
merged 4 commits into from
Oct 25, 2022
Merged

Conversation

carolxob
Copy link
Contributor

@carolxob carolxob commented Oct 3, 2022

Signed-off-by: carolxob [email protected]

Description

Added text: "When the config setting http.detailed_errors.enabled: false, the request of error_trace=true will not contain the detailed error message."

Issues Resolved

Fixes #1235

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@carolxob carolxob added the 3 - Tech review PR: Tech review in progress label Oct 3, 2022
@carolxob carolxob requested a review from a team as a code owner October 3, 2022 21:06
@carolxob carolxob self-assigned this Oct 3, 2022
@carolxob carolxob added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 labels Oct 3, 2022
_opensearch/common-parameters.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please correct the parameter name. Thanks.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change to: When the configuration setting http.detailed_errors.enabled. Add the 'h' and remove the ':'

Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per Fanit's comment.

_opensearch/common-parameters.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Naarcha-AWS Naarcha-AWS merged commit f2187da into main Oct 25, 2022
@Naarcha-AWS Naarcha-AWS deleted the update-error-trace branch October 25, 2022 16:34
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)
@@ -14,4 +14,4 @@ Human-readable output | To convert output units to human-readable values (for ex
Pretty result | To get back JSON responses in a readable format, add `?pretty=true` to the request URL. | `GET <index_name>/_search?pretty=true`
Content type | To specify the type of content in the request body, use the `Content-Type` key name in the request header. Most operations support JSON, YAML, and CBOR formats. | `POST _scripts/<template_name> -H 'Content-Type: application/json`
Request body in query string | If the client library does not accept a request body for non-POST requests, use the `source` query string parameter to pass the request body. Also, specify the `source_content_type` parameter with a supported media type such as `application/json`. | `GET _search?source_content_type=application/json&source={"query":{"match_all":{}}}`
Stack traces | To include the error stack trace in the response when an exception is raised, add `error_trace=true` to the request URL. | `GET <index_name>/_search?error_trace=true`
Stack traces | To include the error stack trace in the response when an exception is raised, add `error_trace=true` to the request URL. <br> <br> When the configuration setting `http.detailed_errors.enabled` is set to `false` in opensearch.yml, `error_trace=true` will not contain a detailed error message.| `GET <index_name>/_search?error_trace=true`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note that in that case it'll actually fail with an error telling you that you're not allowed to set error_trace=true

Naarcha-AWS pushed a commit that referenced this pull request Oct 26, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)

Co-authored-by: Caroline <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Oct 26, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)

Co-authored-by: Caroline <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Oct 26, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)

Co-authored-by: Caroline <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Oct 26, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)

Co-authored-by: Caroline <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Oct 26, 2022
* Added second paragraph to Stack traces option

Signed-off-by: carolxob <[email protected]>

* Update _opensearch/common-parameters.md

Co-authored-by: Naarcha-AWS <[email protected]>

* Update _opensearch/common-parameters.md

* Update common-parameters.md

Signed-off-by: carolxob <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit f2187da)

Co-authored-by: Caroline <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Tech review PR: Tech review in progress backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update error_trace URL parameter description
4 participants