Skip to content

Commit a8613e8

Browse files
enjoy-binbinggivo
enjoy-binbin
and
ggivo
authored
Remove extra spaces in words in docs (#3120)
* 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]>
1 parent a254a78 commit a8613e8

File tree

2 files changed

+38
-37
lines changed

2 files changed

+38
-37
lines changed

‎.github/wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,7 @@ xml
254254
RedisJSON
255255
MkDocs
256256
ClientOptions
257+
ClusterClientOptions
257258
TimeoutOptions
258259
timeoutOptions
259260
ClusterCommand

‎docs/advanced-usage.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,8 @@ path.</td>
187187
<td colspan="3">The client can collect latency metrics during while dispatching
188188
commands. Command latency metrics is collected on connection or server
189189
level. Command latency collection is enabled by default and can be
190-
disabled by setting <code>commandLatency CollectorOptions(…)</code> to
191-
<code>DefaultCom mandLatencyCollector Options.disabled()</code>.</td>
190+
disabled by setting <code>commandLatencyCollectorOptions(…)</code> to
191+
<code>DefaultCommandLatencyCollectorOptions.disabled()</code>.</td>
192192
</tr>
193193
<tr>
194194
<td><strong>Latency event publisher options</strong></td>
@@ -296,11 +296,11 @@ instance .</p></td>
296296
</tbody>
297297
</table>
298298

299-
## Client Options
299+
## ClientOptions
300300

301-
Client options allow controlling behavior for some specific features.
301+
ClientOptions allow controlling behavior for some specific features.
302302

303-
Client options are immutable. Connections inherit the current options at
303+
ClientOptions are immutable. Connections inherit the current options at
304304
the moment the connection is created. Changes to options will not affect
305305
existing connections.
306306

@@ -466,7 +466,7 @@ latest available protocol.</p></td>
466466
<tr>
467467
<td>Socket Options</td>
468468
<td><code>socketOptions</code></td>
469-
<td><code>10 seconds Connecti on-Timeout, no keep-a live, no TCP noDelay</code></td>
469+
<td><code>10 seconds Connection-Timeout, no keep-alive, no TCP noDelay</code></td>
470470
</tr>
471471
<tr>
472472
<td colspan="3"><p>Since: 4.3</p>
@@ -476,7 +476,7 @@ kept to Redis servers.</p></td>
476476
<tr>
477477
<td>SSL Options</td>
478478
<td><code>sslOptions</code></td>
479-
<td><code>(non e), use JDK defaults</code></td>
479+
<td><code>(none), use JDK defaults</code></td>
480480
</tr>
481481
<tr>
482482
<td colspan="3"><p>Since: 4.3</p>
@@ -516,10 +516,10 @@ option uses <code>EventExecutorGroup</code> configured through
516516

517517
### Cluster-specific options
518518

519-
Cluster client options extend the regular client options by some cluster
519+
ClusterClientOptions extend the regular ClientOptions by some cluster
520520
specifics.
521521

522-
Cluster client options are immutable. Connections inherit the current
522+
ClusterClientOptions are immutable. Connections inherit the current
523523
options at the moment the connection is created. Changes to options will
524524
not affect existing connections.
525525

@@ -564,7 +564,7 @@ operate on the one cluster topology.</p>
564564
can be set with <code>refreshPeriod</code>. The refresh job starts after
565565
either opening the first connection with the job enabled or by calling
566566
<code>reloadPartitions</code>. The job can be disabled without
567-
discarding the full client by setting new client options.</p></td>
567+
discarding the full client by setting new ClientOptions.</p></td>
568568
</tr>
569569
<tr>
570570
<td>Cluster topology refresh period</td>
@@ -579,7 +579,7 @@ will be ignored.</p></td>
579579
</tr>
580580
<tr>
581581
<td>Adaptive cluster topology refresh</td>
582-
<td><code>enableAda ptiveRefreshTrigger</code></td>
582+
<td><code>enableAdaptiveRefreshTrigger</code></td>
583583
<td><code>(none)</code></td>
584584
</tr>
585585
<tr>
@@ -597,7 +597,7 @@ attempts for the reconnect trigger)</p></td>
597597
</tr>
598598
<tr>
599599
<td>Adaptive refresh triggers timeout</td>
600-
<td><code>adaptiveRef reshTriggersTimeout</code></td>
600+
<td><code>adaptiveRefreshTriggersTimeout</code></td>
601601
<td><code>30 SECONDS</code></td>
602602
</tr>
603603
<tr>
@@ -610,7 +610,7 @@ ignored.</p></td>
610610
</tr>
611611
<tr>
612612
<td>Reconnect attempts (Adaptive topology refresh trigger)</td>
613-
<td><code>refreshTrigge rsReconnectAttempts</code></td>
613+
<td><code>refreshTriggersReconnectAttempts</code></td>
614614
<td><code>5</code></td>
615615
</tr>
616616
<tr>
@@ -623,7 +623,7 @@ attempts. The first reconnect attempt starts with
623623
</tr>
624624
<tr>
625625
<td>Dynamic topology refresh sources</td>
626-
<td><code>dy namicRefreshSources</code></td>
626+
<td><code>dynamicRefreshSources</code></td>
627627
<td><code>true</code></td>
628628
</tr>
629629
<tr>
@@ -641,7 +641,7 @@ typically contains IP addresses.</p></td>
641641
</tr>
642642
<tr>
643643
<td>Close stale connections</td>
644-
<td><code>cl oseStaleConnections</code></td>
644+
<td><code>closeStaleConnections</code></td>
645645
<td><code>true</code></td>
646646
</tr>
647647
<tr>
@@ -686,7 +686,7 @@ trying to connect the node during topology discovery.</p></td>
686686
</tr>
687687
<tr>
688688
<td>Validate cluster node membership</td>
689-
<td><code>validateCl usterNodeMembership</code></td>
689+
<td><code>validateClusterNodeMembership</code></td>
690690
<td><code>true</code></td>
691691
</tr>
692692
<tr>
@@ -771,7 +771,7 @@ logs.
771771

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

1341-
| Name | Method | Default |
1342-
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------|
1343-
| **Disable metrics tracking** | `disable` | `false` |
1344-
| Disables tracking of command latency metrics. | | |
1345-
| **Latency time unit** | `targetUnit` | `MICROSECONDS` |
1346-
| The target unit for command latency values. All values in the `CommandLatencyEvent` and a `CommandMetrics` instance are `long` values scaled to the `targetUnit`. | | |
1347-
| **Latency percentiles** | `targetPercentiles` | `50.0, 90 .0, 95.0, 99.0, 99.9` |
1348-
| 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. | | |
1349-
| **Reset latencies after publish** | `reset LatenciesAfterEvent` | `true` |
1350-
| 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. | | |
1351-
| **Local socket distinction** | `localDistinction` | `false` |
1352-
| 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. | | |
1341+
| Name | Method | Default |
1342+
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|---------------------------------|
1343+
| **Disable metrics tracking** | `disable` | `false` |
1344+
| Disables tracking of command latency metrics. | | |
1345+
| **Latency time unit** | `targetUnit` | `MICROSECONDS` |
1346+
| The target unit for command latency values. All values in the `CommandLatencyEvent` and a `CommandMetrics` instance are `long` values scaled to the `targetUnit`. | | |
1347+
| **Latency percentiles** | `targetPercentiles` | `50.0, 90 .0, 95.0, 99.0, 99.9` |
1348+
| 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. | | |
1349+
| **Reset latencies after publish** | `resetLatenciesAfterEvent` | `true` |
1350+
| 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. | | |
1351+
| **Local socket distinction** | `localDistinction` | `false` |
1352+
| 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. | | |
13531353

13541354
#### EventPublisher Options
13551355

13561356
The following settings are available to configure from
13571357
`DefaultEventPublisherOptions`:
13581358

1359-
| Name | Method | Default |
1360-
|---------------------------------------------------|--------------------------|-----------|
1361-
| **Disable event publisher** | `disable` | `false` |
1362-
| Disables event publishing. | | |
1363-
| **Event publishing time unit** | `ev entEmitIntervalUnit` | `MINUTES` |
1364-
| The `TimeUnit` for the event publishing interval. | | |
1365-
| **Event publishing interval** | `eventEmitInterval` | `10` |
1366-
| The interval for the event publishing. | | |
1359+
| Name | Method | Default |
1360+
|---------------------------------------------------|-------------------------|-----------|
1361+
| **Disable event publisher** | `disable` | `false` |
1362+
| Disables event publishing. | | |
1363+
| **Event publishing time unit** | `eventEmitIntervalUnit` | `MINUTES` |
1364+
| The `TimeUnit` for the event publishing interval. | | |
1365+
| **Event publishing interval** | `eventEmitInterval` | `10` |
1366+
| The interval for the event publishing. | | |
13671367

13681368
### Micrometer
13691369

0 commit comments

Comments
 (0)