-
Notifications
You must be signed in to change notification settings - Fork 314
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4766 from osandamaleesha/master
Add server configurations guidelines to WSO2 IS documentation
- Loading branch information
Showing
4 changed files
with
58 additions
and
2 deletions.
There are no files selected for viewing
48 changes: 48 additions & 0 deletions
48
en/identity-server/next/docs/includes/http-client-connections.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
## Fine tune HTTP Client Connections | ||
|
||
To fine-tune connections initiated by WSO2 Identity Server to external services, you may add the following configurations to the `deployment.toml` file located in the `<IS_HOME>/repository/conf/` directory | ||
|
||
<table> | ||
<thead> | ||
<tr class="header"> | ||
<th>Property</th> | ||
<th>Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr class="odd"> | ||
<td>http_client.read_timeout</td> | ||
<td> | ||
<p>The maximum time (in milliseconds) the server will wait for a response from the external service.</p> | ||
</td> | ||
</tr> | ||
<tr class="even"> | ||
<td>http_client.request_timeout</td> | ||
<td><p>The maximum time (in milliseconds) the server will wait to obtain a connection from the connection pool.</p></td> | ||
</tr> | ||
<tr class="odd"> | ||
<td>http_client.connection_timeout</td> | ||
<td><p>The maximum time (in milliseconds) the server will wait to establish a connection to the external service.</p></td> | ||
</tr> | ||
<tr class="even"> | ||
<td>http_client.connection_pool_size</td> | ||
<td><p>The size of the HTTP connection pool used for outbound requests.</p></td> | ||
</tr> | ||
<tr class="odd"> | ||
<td>http_client.retry_count</td> | ||
<td><p>Number of retry attempts made in case of a failure. Refer to the <a href="{{base_path}}/guides/customize/actions/understanding-actions/#time-out-and-retry">list of http codes</a> that trigger retries.</p></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
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 | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters