Skip to content

Commit

Permalink
Remove extra spaces in words in docs (#3120)
Browse files Browse the repository at this point in the history 
* Remove extra spaces in words

`reset LatenciesAfterEvent` should be `resetLatenciesAfterEvent`.
`ev entEmitIntervalUnit` should be `eventEmitIntervalUnit`.
Other than that, diff is all table formatting.

* more cleanup

* Add ClusterClientOptions to wordlist

---------

Co-authored-by: ggivo <[email protected]>
  • Loading branch information
@enjoy-binbin @ggivo
enjoy-binbin and ggivo authored Jan 8, 2025
1 parent a254a78 commit a8613e8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 37 deletions.
1 change: 1 addition & 0 deletions .github/wordlist.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ xml
RedisJSON
MkDocs
ClientOptions
ClusterClientOptions
TimeoutOptions
timeoutOptions
ClusterCommand
Expand Down
74 changes: 37 additions & 37 deletions docs/advanced-usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ path.</td>
<td colspan="3">The client can collect latency metrics during while dispatching
commands. Command latency metrics is collected on connection or server
level. Command latency collection is enabled by default and can be
disabled by setting <code>commandLatency CollectorOptions(…)</code> to
<code>DefaultCom mandLatencyCollector Options.disabled()</code>.</td>
disabled by setting <code>commandLatencyCollectorOptions(…)</code> to
<code>DefaultCommandLatencyCollectorOptions.disabled()</code>.</td>
</tr>
<tr>
<td><strong>Latency event publisher options</strong></td>
Expand Down Expand Up @@ -296,11 +296,11 @@ instance .</p></td>
</tbody>
</table>

## Client Options
## ClientOptions

Client options allow controlling behavior for some specific features.
ClientOptions allow controlling behavior for some specific features.

Client options are immutable. Connections inherit the current options at
ClientOptions are immutable. Connections inherit the current options at
the moment the connection is created. Changes to options will not affect
existing connections.

Expand Down Expand Up @@ -466,7 +466,7 @@ latest available protocol.</p></td>
<tr>
<td>Socket Options</td>
<td><code>socketOptions</code></td>
<td><code>10 seconds Connecti on-Timeout, no keep-a live, no TCP noDelay</code></td>
<td><code>10 seconds Connection-Timeout, no keep-alive, no TCP noDelay</code></td>
</tr>
<tr>
<td colspan="3"><p>Since: 4.3</p>
Expand All @@ -476,7 +476,7 @@ kept to Redis servers.</p></td>
<tr>
<td>SSL Options</td>
<td><code>sslOptions</code></td>
<td><code>(non e), use JDK defaults</code></td>
<td><code>(none), use JDK defaults</code></td>
</tr>
<tr>
<td colspan="3"><p>Since: 4.3</p>
Expand Down Expand Up @@ -516,10 +516,10 @@ option uses <code>EventExecutorGroup</code> configured through

### Cluster-specific options

Cluster client options extend the regular client options by some cluster
ClusterClientOptions extend the regular ClientOptions by some cluster
specifics.

Cluster client options are immutable. Connections inherit the current
ClusterClientOptions are immutable. Connections inherit the current
options at the moment the connection is created. Changes to options will
not affect existing connections.

Expand Down Expand Up @@ -564,7 +564,7 @@ operate on the one cluster topology.</p>
can be set with <code>refreshPeriod</code>. The refresh job starts after
either opening the first connection with the job enabled or by calling
<code>reloadPartitions</code>. The job can be disabled without
discarding the full client by setting new client options.</p></td>
discarding the full client by setting new ClientOptions.</p></td>
</tr>
<tr>
<td>Cluster topology refresh period</td>
Expand All @@ -579,7 +579,7 @@ will be ignored.</p></td>
</tr>
<tr>
<td>Adaptive cluster topology refresh</td>
<td><code>enableAda ptiveRefreshTrigger</code></td>
<td><code>enableAdaptiveRefreshTrigger</code></td>
<td><code>(none)</code></td>
</tr>
<tr>
Expand All @@ -597,7 +597,7 @@ attempts for the reconnect trigger)</p></td>
</tr>
<tr>
<td>Adaptive refresh triggers timeout</td>
<td><code>adaptiveRef reshTriggersTimeout</code></td>
<td><code>adaptiveRefreshTriggersTimeout</code></td>
<td><code>30 SECONDS</code></td>
</tr>
<tr>
Expand All @@ -610,7 +610,7 @@ ignored.</p></td>
</tr>
<tr>
<td>Reconnect attempts (Adaptive topology refresh trigger)</td>
<td><code>refreshTrigge rsReconnectAttempts</code></td>
<td><code>refreshTriggersReconnectAttempts</code></td>
<td><code>5</code></td>
</tr>
<tr>
Expand All @@ -623,7 +623,7 @@ attempts. The first reconnect attempt starts with
</tr>
<tr>
<td>Dynamic topology refresh sources</td>
<td><code>dy namicRefreshSources</code></td>
<td><code>dynamicRefreshSources</code></td>
<td><code>true</code></td>
</tr>
<tr>
Expand All @@ -641,7 +641,7 @@ typically contains IP addresses.</p></td>
</tr>
<tr>
<td>Close stale connections</td>
<td><code>cl oseStaleConnections</code></td>
<td><code>closeStaleConnections</code></td>
<td><code>true</code></td>
</tr>
<tr>
Expand Down Expand Up @@ -686,7 +686,7 @@ trying to connect the node during topology discovery.</p></td>
</tr>
<tr>
<td>Validate cluster node membership</td>
<td><code>validateCl usterNodeMembership</code></td>
<td><code>validateClusterNodeMembership</code></td>
<td><code>true</code></td>
</tr>
<tr>
Expand Down Expand Up @@ -771,7 +771,7 @@ logs.

Lettuce uses Java defaults for the trust store that is usually `cacerts`
in your `jre/lib/security` directory and comes with customizable SSL
options via [client options](#client-options). If you need to add you
options via [ClientOptions](#ClientOptions). If you need to add you
own root certificate, so you can configure `SslOptions`, import it
either to `cacerts` or you provide an own trust store and set the
necessary system properties:
Expand Down Expand Up @@ -1338,32 +1338,32 @@ RedisClient client = RedisClient.create(res);
The following settings are available to configure from
`DefaultCommandLatencyCollectorOptions`:

| Name | Method | Default |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------|
| **Disable metrics tracking** | `disable` | `false` |
| Disables tracking of command latency metrics. | | |
| **Latency time unit** | `targetUnit` | `MICROSECONDS` |
| The target unit for command latency values. All values in the `CommandLatencyEvent` and a `CommandMetrics` instance are `long` values scaled to the `targetUnit`. | | |
| **Latency percentiles** | `targetPercentiles` | `50.0, 90 .0, 95.0, 99.0, 99.9` |
| A `double`-array of percentiles for latency metrics. The `CommandMetrics` contains a map that holds the percentile value and the latency value according to the percentile. Note that percentiles here must be specified in the range between 0 and 100. | | |
| **Reset latencies after publish** | `reset LatenciesAfterEvent` | `true` |
| Allows controlling whether the latency metrics are reset to zero one they were published. Setting `reset LatenciesAfterEvent` allows accumulating metrics over a long period for long-term analytics. | | |
| **Local socket distinction** | `localDistinction` | `false` |
| Enables per connection metrics tracking instead of per host/port. If `true`, multiple connections to the same host/connection point will be recorded separately which allows to inspection of every connection individually. If `false`, multiple connections to the same host/connection point will be recorded together. This allows a consolidated view on one particular service. | | |
| Name | Method | Default |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|---------------------------------|
| **Disable metrics tracking** | `disable` | `false` |
| Disables tracking of command latency metrics. | | |
| **Latency time unit** | `targetUnit` | `MICROSECONDS` |
| The target unit for command latency values. All values in the `CommandLatencyEvent` and a `CommandMetrics` instance are `long` values scaled to the `targetUnit`. | | |
| **Latency percentiles** | `targetPercentiles` | `50.0, 90 .0, 95.0, 99.0, 99.9` |
| A `double`-array of percentiles for latency metrics. The `CommandMetrics` contains a map that holds the percentile value and the latency value according to the percentile. Note that percentiles here must be specified in the range between 0 and 100. | | |
| **Reset latencies after publish** | `resetLatenciesAfterEvent` | `true` |
| Allows controlling whether the latency metrics are reset to zero one they were published. Setting `resetLatenciesAfterEvent` allows accumulating metrics over a long period for long-term analytics. | | |
| **Local socket distinction** | `localDistinction` | `false` |
| Enables per connection metrics tracking instead of per host/port. If `true`, multiple connections to the same host/connection point will be recorded separately which allows to inspection of every connection individually. If `false`, multiple connections to the same host/connection point will be recorded together. This allows a consolidated view on one particular service. | | |

#### EventPublisher Options

The following settings are available to configure from
`DefaultEventPublisherOptions`:

| Name | Method | Default |
|---------------------------------------------------|--------------------------|-----------|
| **Disable event publisher** | `disable` | `false` |
| Disables event publishing. | | |
| **Event publishing time unit** | `ev entEmitIntervalUnit` | `MINUTES` |
| The `TimeUnit` for the event publishing interval. | | |
| **Event publishing interval** | `eventEmitInterval` | `10` |
| The interval for the event publishing. | | |
| Name | Method | Default |
|---------------------------------------------------|-------------------------|-----------|
| **Disable event publisher** | `disable` | `false` |
| Disables event publishing. | | |
| **Event publishing time unit** | `eventEmitIntervalUnit` | `MINUTES` |
| The `TimeUnit` for the event publishing interval. | | |
| **Event publishing interval** | `eventEmitInterval` | `10` |
| The interval for the event publishing. | | |

### Micrometer

Expand Down

0 comments on commit a8613e8

Please sign in to comment.