dolphinscheduler icon indicating copy to clipboard operation
dolphinscheduler copied to clipboard

[Doc][doc] Improve HTTP Task Documentation by Adding Timeout Configuration and Error Handling Details

Open Zhianii opened this issue 7 months ago • 1 comments

Search before asking

  • [x] I had searched in the issues and found no similar feature requirement.

Description

The current HTTP task documentation (http.md) lacks detailed information about timeout configuration and error handling. Although the connectTimeout parameter has been implemented in the code, the documentation does not clearly explain how to configure timeouts and the system's behavior after a timeout occurs. Additionally, the documentation does not describe how different error situations are handled and what log outputs are generated.

Improvement plans:

  • Add a description of the "Connection Timeout" parameter in the HTTP task parameter table, including the unit (milliseconds) and default value

  • Add an "Error Handling" section explaining task behavior under different HTTP status codes and exception scenarios

  • Provide more examples of real-world usage scenarios, especially for error handling and timeout configuration

  • Duplicate of #Maintain consistent content updates in both English and Chinese documentation

Documentation Links

https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/guide/task/http.md https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/zh/guide/task/http.md

Are you willing to submit a PR?

  • [x] Yes I am willing to submit a PR!

Code of Conduct

Zhianii avatar May 26 '25 12:05 Zhianii

Please assign this issue to me. I'm interested and glad to make some contributions.

@Zhianii Hi Zhianii 😊

I just wanted to check in and see if there have been any updates on this issue. If it’s still open and hasn’t moved forward yet, I’d be more than happy to pick it up and see it through to completion.

RooobinYe avatar May 28 '25 13:05 RooobinYe

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Jun 29 '25 00:06 github-actions[bot]

This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.

github-actions[bot] avatar Jul 07 '25 00:07 github-actions[bot]