Skip to content

Commit

Permalink
Fix some typos in documentation and code comments (apache#12179)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeljmarshall authored Sep 27, 2021
1 parent 85c1189 commit 0460472
Show file tree
Hide file tree
Showing 36 changed files with 70 additions and 70 deletions.
2 changes: 1 addition & 1 deletion conf/broker.conf
Original file line number Diff line number Diff line change
Expand Up @@ -1011,7 +1011,7 @@ loadBalancerSheddingEnabled=true
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=1

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to allocate max number of topics to broker
Expand Down
2 changes: 1 addition & 1 deletion conf/standalone.conf
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ loadBalancerHostUsageCheckIntervalMinutes=1
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=1

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to allocate max number of topics to broker
Expand Down
2 changes: 1 addition & 1 deletion deployment/terraform-ansible/templates/broker.conf
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ loadBalancerSheddingEnabled=true
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=1

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to allocate max number of topics to broker
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1680,7 +1680,7 @@ public class ServiceConfiguration implements PulsarConfiguration {
private int loadBalancerSheddingIntervalMinutes = 1;
@FieldContext(
category = CATEGORY_LOAD_BALANCER,
doc = "Prevent the same topics to be shed and moved to other broker more that"
doc = "Prevent the same topics to be shed and moved to other broker more than"
+ " once within this timeframe"
)
private long loadBalancerSheddingGracePeriodMinutes = 30;
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client-cpp/test-conf/standalone-ssl.conf
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ loadBalancerHostUsageCheckIntervalMinutes=1
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=30

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to determine a broker as under-loaded
Expand All @@ -236,7 +236,7 @@ loadBalancerBrokerUnderloadedThresholdPercentage=1
# Usage threshold to determine a broker as over-loaded
loadBalancerBrokerOverloadedThresholdPercentage=85

# Interval to update namespace bundle resource quotat
# Interval to update namespace bundle resource quota
loadBalancerResourceQuotaUpdateIntervalMinutes=15

# Usage threshold to determine a broker is having just right level of load
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client-cpp/test-conf/standalone.conf
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ loadBalancerHostUsageCheckIntervalMinutes=1
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=30

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to determine a broker as under-loaded
Expand All @@ -224,7 +224,7 @@ loadBalancerBrokerUnderloadedThresholdPercentage=1
# Usage threshold to determine a broker as over-loaded
loadBalancerBrokerOverloadedThresholdPercentage=85

# Interval to update namespace bundle resource quotat
# Interval to update namespace bundle resource quota
loadBalancerResourceQuotaUpdateIntervalMinutes=15

# Usage threshold to determine a broker is having just right level of load
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client-cpp/tests/authentication.conf
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ loadBalancerHostUsageCheckIntervalMinutes=1
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=30

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to determine a broker as under-loaded
Expand All @@ -230,7 +230,7 @@ loadBalancerBrokerUnderloadedThresholdPercentage=1
# Usage threshold to determine a broker as over-loaded
loadBalancerBrokerOverloadedThresholdPercentage=85

# Interval to update namespace bundle resource quotat
# Interval to update namespace bundle resource quota
loadBalancerResourceQuotaUpdateIntervalMinutes=15

# Usage threshold to determine a broker is having just right level of load
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client-cpp/tests/standalone.conf
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ loadBalancerHostUsageCheckIntervalMinutes=1
# some over-loaded broker to other under-loaded brokers
loadBalancerSheddingIntervalMinutes=30

# Prevent the same topics to be shed and moved to other broker more that once within this timeframe
# Prevent the same topics to be shed and moved to other broker more than once within this timeframe
loadBalancerSheddingGracePeriodMinutes=30

# Usage threshold to determine a broker as under-loaded
Expand All @@ -222,7 +222,7 @@ loadBalancerBrokerUnderloadedThresholdPercentage=1
# Usage threshold to determine a broker as over-loaded
loadBalancerBrokerOverloadedThresholdPercentage=85

# Interval to update namespace bundle resource quotat
# Interval to update namespace bundle resource quota
loadBalancerResourceQuotaUpdateIntervalMinutes=15

# Usage threshold to determine a broker is having just right level of load
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,19 @@ public class ClientConfigurationData implements Serializable, Cloneable {

@ApiModelProperty(
name = "operationTimeoutMs",
value = "Client operation timeout (in millisecond)."
value = "Client operation timeout (in milliseconds)."
)
private long operationTimeoutMs = 30000;

@ApiModelProperty(
name = "lookupTimeoutMs",
value = "Client lookup timeout (in millisecond)."
value = "Client lookup timeout (in milliseconds)."
)
private long lookupTimeoutMs = -1;

@ApiModelProperty(
name = "statsIntervalSeconds",
value = " Interval to print client stats (in second)."
value = "Interval to print client stats (in seconds)."
)
private long statsIntervalSeconds = 60;

Expand All @@ -122,7 +122,7 @@ public class ClientConfigurationData implements Serializable, Cloneable {
@ApiModelProperty(
name = "connectionsPerBroker",
value = "Number of connections established between the client and each Broker."
+ "A value of 0 means to disable connection pooling."
+ " A value of 0 means to disable connection pooling."
)
private int connectionsPerBroker = 1;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public class WebSocketProxyConfiguration implements PulsarConfiguration {
@FieldContext(doc = "Number of connections per broker in Pulsar client used in WebSocket proxy")
private int webSocketConnectionsPerBroker = Runtime.getRuntime().availableProcessors();

@FieldContext(doc = "Timeout of idling WebSocket session (in millisecond)")
@FieldContext(doc = "Timeout of idling WebSocket session (in milliseconds)")
private int webSocketSessionIdleTimeoutMillis = 300000;

@FieldContext(doc = "When this parameter is not empty, unauthenticated users perform as anonymousUserRole")
Expand Down Expand Up @@ -157,7 +157,7 @@ public class WebSocketProxyConfiguration implements PulsarConfiguration {
+ "TLS rejecting the connection if the client certificate is not trusted")
private boolean tlsRequireTrustedClientCertOnConnect = false;

@FieldContext(doc = "TLS cert refresh duration (in second). 0 means checking every new connection.")
@FieldContext(doc = "TLS cert refresh duration (in seconds). 0 means checking every new connection.")
private long tlsCertRefreshCheckDurationSec = 300;

@FieldContext(doc = "Key-value properties. Types are all String")
Expand Down
4 changes: 2 additions & 2 deletions site2/docs/reference-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,11 +288,11 @@ brokerServiceCompactionThresholdInBytes|If the estimated backlog size is greater
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,11 +182,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,11 +182,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,11 +182,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,11 +188,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,11 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
|loadBalancerReportUpdateMaxIntervalMinutes| maximum interval to update load report |15|
|loadBalancerHostUsageCheckIntervalMinutes| Frequency of report to collect |1|
|loadBalancerSheddingIntervalMinutes| Load shedding interval. Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more that once within this timeframe |30|
|loadBalancerSheddingGracePeriodMinutes| Prevent the same topics to be shed and moved to other broker more than once within this timeframe |30|
|loadBalancerBrokerMaxTopics| Usage threshold to allocate max number of topics to broker |50000|
|loadBalancerBrokerUnderloadedThresholdPercentage| Usage threshold to determine a broker as under-loaded |1|
|loadBalancerBrokerOverloadedThresholdPercentage| Usage threshold to determine a broker as over-loaded |85|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quotat |15|
|loadBalancerResourceQuotaUpdateIntervalMinutes| Interval to update namespace bundle resource quota |15|
|loadBalancerBrokerComfortLoadLevelPercentage| Usage threshold to determine a broker is having just right level of load |65|
|loadBalancerAutoBundleSplitEnabled| enable/disable namespace bundle auto split |false|
|loadBalancerNamespaceBundleMaxTopics| maximum topics in a bundle, otherwise bundle split will be triggered |1000|
Expand Down
Loading

0 comments on commit 0460472

Please sign in to comment.