techdocsmith commented on a change in pull request #11755:
URL: https://github.com/apache/druid/pull/11755#discussion_r719580831



##########
File path: docs/configuration/index.md
##########
@@ -631,6 +631,48 @@ Store task logs in HDFS. Note that the 
`druid-hdfs-storage` extension must be lo
 |`druid.indexer.logs.kill.initialDelay`| Optional. Number of milliseconds 
after Overlord start when first auto kill is run. |random value less than 
300000 (5 mins)|
 |`druid.indexer.logs.kill.delay`|Optional. Number of milliseconds of delay 
between successive executions of auto kill run. |21600000 (6 hours)|
 
+### API error response
+
+You can configure Druid API error responses to hide internal information like 
the Druid class name, stack trace, thread name, servlet name, code, line/column 
number, host, or IP address.
+
+|Property|Description|Default|
+|--------|-----------|-------|
+|`druid.server.http.showDetailedJettyErrors`|When set to true, any error from 
the Jetty layer / Jetty filter includes `servlet`, `message`, `url`, `status`, 
and `cause`, if it exists, fields in the JSON response. When set to false, the 
JSON response only includes `message`, `url`, and `status`. The field values 
remain unchanged.|true|
+|`druid.server.http.errorResponseTransformStrategy.strategy`|Error response 
transform strategy. The strategy controls how Druid transforms error responses 
from Druid services. When unset or set to `none`, Druid leaves error responses 
unchanged.|`none`|
+
+##### Error response transform strategy
+
+You can use an error response transform strategy to transform error responses 
from within Druid services to hide internal information.
+When you specify an error response transform strategy other than `none`, Druid 
transforms the error responses from Druid services as follows:
+ - For any query API that fails in the Router service, Druid sets the fields 
`errorClass` and `host` to null. Druid applies the transformation strategy to 
the `errorMessage` field.
+ - For Any SQL query API, for example `POST /druid/v2/sql/...` that fails, 
Druid sets the fields `errorClass` and `host` to null. Druid applies the 
transformation strategy to the `errorMessage` field.

Review comment:
       ```suggestion
    - For Any SQL query API that fails, for example `POST /druid/v2/sql/...`, 
Druid sets the fields `errorClass` and `host` to null. Druid applies the 
transformation strategy to the `errorMessage` field.
   ```
   sorry another minor edit




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to