diff --git a/en/includes/guides/customize/actions/setting-up-actions.md b/en/includes/guides/customize/actions/setting-up-actions.md index 509f2452f..bf5e66e40 100644 --- a/en/includes/guides/customize/actions/setting-up-actions.md +++ b/en/includes/guides/customize/actions/setting-up-actions.md @@ -70,3 +70,52 @@ The following are some of the troubleshooting steps that you may take to resolve 1. Ensure that your external service is up and running and that there are no connectivity issues. 2. Confirm that the request and response payloads conform to the expected formats as defined by the REST API contract. + +## Configuring HTTP Client Connections + +You can configure the HTTP connection settings in the deployment.toml file located in `/repository/conf/` to fine-tune connections initiated by WSO2 Identity Server to external services implementing actions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
http_client.read_timeout +

Configures the maximum time (in milliseconds) the server will wait for a response from the external service

+
http_client.request_timeout

Configures the time (in milliseconds) to wait for obtaining a connection from the connection pool

http_client.connection_timeout

Configures the timeout (in milliseconds) for establishing a connection to the external service

http_client.connection_pool_size

Configures the size of the HTTP connection pool used for outbound requests

http_client.retry_count

Determines the number of retry attempts are made in case of connection failures. Explore more for allowed status codes where retries can happen

+ +Sample configuration is as follows: + +```toml +[actions] +http_client.read_timeout = 6000 +http_client.request_timeout = 3000 +http_client.connection_timeout = 3000 +http_client.connection_pool_size = 10 +http_client.retry_count = 1 + +``` diff --git a/en/includes/guides/customize/actions/understanding-actions.md b/en/includes/guides/customize/actions/understanding-actions.md index 7bab512af..a961633c2 100644 --- a/en/includes/guides/customize/actions/understanding-actions.md +++ b/en/includes/guides/customize/actions/understanding-actions.md @@ -119,7 +119,6 @@ The following diagram illustrates the sequence of these steps: requestId

A unique correlation identifier that associates the request received by {{product_name}}.

- actionType

Indicates the execution point within the {{product_name}} runtime where your external service is called. Refer to Explore Action Types for a list of supported trigger points.

@@ -163,7 +162,6 @@ If the error response includes an acceptable payload, it is treated as an error 502

Bad Gateway.

- 503

Service Unavailable.

@@ -175,6 +173,9 @@ If the error response includes an acceptable payload, it is treated as an error +!!! note + Refer to [Configuring HTTP Client Connections]({{base_path}}/guides/customize/actions/setting-up-actions/#configuring-http-client-connections) to adjust timeouts, connection pooling, and retries in deployment.toml for optimal performance. + Requests will not be retried if the external service responds with HTTP status codes 200 (OK), 400 (Bad Request), 401 (Unauthorized), or any other codes not listed above as retry scenarios. ### Troubleshooting