Skip to content

Commit 6405472

Browse files
liran2000liran2000
committed
add Configuration section to readme
Signed-off-by: liran2000 <[email protected]>
1 parent 59ffacb commit 6405472

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

‎tools/flagd-http-connector/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,26 @@ FlagdOptions options =
7979

8080
FlagdProvider flagdProvider = new FlagdProvider(options);
8181
```
82+
83+
### Configuration
84+
The Http Connector can be configured using the following properties in the `HttpConnectorOptions` class.:
85+
86+
| Property Name | Type | Description |
87+
|-------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
88+
| url | String | The URL to poll for updates. This is a required field. |
89+
| pollIntervalSeconds | Integer | The interval in seconds at which the connector will poll the URL for updates. Default is 60 seconds. |
90+
| connectTimeoutSeconds | Integer | The timeout in seconds for establishing a connection to the URL. Default is 10 seconds. |
91+
| requestTimeoutSeconds | Integer | The timeout in seconds for the request to complete. Default is 10 seconds. |
92+
| linkedBlockingQueueCapacity | Integer | The capacity of the linked blocking queue used for processing requests. Default is 100. |
93+
| scheduledThreadPoolSize | Integer | The size of the scheduled thread pool used for processing requests. Default is 2. |
94+
| headers | Map<String, String> | A map of headers to be included in the request. Default is an empty map. |
95+
| httpClientExecutor | ExecutorService | The executor service used for making HTTP requests. Default is a fixed thread pool with 1 thread. |
96+
| proxyHost | String | The host of the proxy server to use for requests. Default is null. |
97+
| proxyPort | Integer | The port of the proxy server to use for requests. Default is null. |
98+
| payloadCacheOptions | PayloadCacheOptions | Options for configuring the payload cache. Default is null. |
99+
| payloadCache | PayloadCache | The payload cache to use for caching responses. Default is null. |
100+
| useHttpCache | Boolean | Whether to use HTTP caching for the requests. Default is false. |
101+
| PayloadCacheOptions.updateIntervalSeconds | Integer | The interval, in seconds, at which the cache is updated. By default, this is set to 30 minutes. The goal is to avoid overloading fallback cache writes, since the cache serves only as a fallback mechanism. Typically, this value can be tuned to be shorter than the cache's TTL, balancing the need to minimize unnecessary updates while still handling edge cases effectively. |
102+
103+
104+

0 commit comments

Comments
 (0)