This is an automated email from the ASF dual-hosted git repository.
junma pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 5ecf0a94f3c [feat][doc] Sync 2.9.4/2.10.3-specific updates to
2.9.x/2.10.x docs (#350)
5ecf0a94f3c is described below
commit 5ecf0a94f3cc32e16a3b2afca53b78d04139b431
Author: momo-jun <[email protected]>
AuthorDate: Wed Jan 4 12:47:02 2023 +0800
[feat][doc] Sync 2.9.4/2.10.3-specific updates to 2.9.x/2.10.x docs (#350)
* Sync 2.9.4/2.10.3-specific updates to 2.9.x/2.10.x docs
* sync metrics update with master
* updates
* Update reference-metrics.md
---
docs/functions-cli.md | 20 ++++++++++----------
versioned_docs/version-2.10.x/reference-metrics.md | 6 ++++--
versioned_docs/version-2.8.x/reference-metrics.md | 2 +-
versioned_docs/version-2.9.x/concepts-messaging.md | 10 ++++++++++
.../version-2.9.x/reference-configuration.md | 3 ++-
versioned_docs/version-2.9.x/reference-metrics.md | 10 ++++++----
6 files changed, 33 insertions(+), 18 deletions(-)
diff --git a/docs/functions-cli.md b/docs/functions-cli.md
index f99ba32b8b3..b06a599ce80 100644
--- a/docs/functions-cli.md
+++ b/docs/functions-cli.md
@@ -27,12 +27,12 @@ You can configure a function by using a predefined YAML
file. The following tabl
| name | String | `--name`
| The name of a function.|
| className | String | `--classname`
| The class name of a function. |
| functionType | String | `--function-type`
| The built-in function type. |
-| inputs | List`<String>` | `-i`, `--inputs`
| The input topics of a function. Multiple topics can be specified as a
comma-separated list. |
-| customSerdeInputs | Map`<String,String>` |
`--custom-serde-inputs` | The mapping from input topics to SerDe class
names. |
+| inputs | List<String\> | `-i`, `--inputs`
| The input topics of a function. Multiple topics can be specified as a
comma-separated list. |
+| customSerdeInputs | Map<String,String\> | `--custom-serde-inputs`
| The mapping from input topics to SerDe class names. |
| topicsPattern | String | `--topics-pattern`
| The topic pattern to consume from a list of topics under a namespace. <br
/>**Note:** `--input` and `--topic-pattern` are mutually exclusive. For Java
functions, you need to add the SerDe class name for a pattern in
`--custom-serde-inputs`. |
-| customSchemaInputs | Map`<String,String>` |
`--custom-schema-inputs` | The mapping from input topics to schema
properties. |
-| customSchemaOutputs | Map`<String,String>` |
`--custom-schema-outputs` | The mapping from output topics to schema
properties.|
-| inputSpecs | Map`<String,`[ConsumerConfig](#consumerconfig)`>` |
`--input-specs` | The mapping from inputs to custom configurations.|
+| customSchemaInputs | Map<String,String\> |
`--custom-schema-inputs` | The mapping from input topics to schema
properties. |
+| customSchemaOutputs | Map<String,String\> |
`--custom-schema-outputs` | The mapping from output topics to schema
properties.|
+| inputSpecs | Map<String,[ConsumerConfig](#consumerconfig)\> |
`--input-specs` | The mapping from inputs to custom configurations.|
| output | String | `-o`, `--output`
| The output topic of a function. If none is specified, no output is written.
|
| producerConfig | [ProducerConfig](#producerconfig) |
`--producer-config` | The custom configurations for producers. |
| outputSchemaType | String | `-st`, `--schema-type`
| The built-in schema type or custom schema class name used for message
outputs. |
@@ -43,8 +43,8 @@ You can configure a function by using a predefined YAML file.
The following tabl
| retainKeyOrdering | Boolean | `--retain-key-ordering`
| Whether functions consume and process messages in key order or not. |
| batchBuilder | String | `--batch-builder` | Use
`producerConfig.batchBuilder` instead. <br />**Note**: `batchBuilder` will be
deprecated in code soon. |
| forwardSourceMessageProperty | Boolean |
`--forward-source-message-property` | Whether the properties of input messages
are forwarded to output topics or not during processing. When the value is set
to `false`, the forwarding is disabled. |
-| userConfig | Map`<String,Object>` | `--user-config`
| User-defined config key/values. |
-| secrets | Map`<String,Object>` | `--secrets` | The mapping from
secretName to objects that encapsulate how the secret is fetched by the
underlying secrets provider. |
+| userConfig | Map<String,Object\> | `--user-config`
| User-defined config key/values. |
+| secrets | Map<String,Object\> | `--secrets` | The mapping from
secretName to objects that encapsulate how the secret is fetched by the
underlying secrets provider. |
| runtime | String | N/A | The runtime of a
function. Available values: `java`,`python`, `go`. |
| autoAck | Boolean | `--auto-ack` | Whether the framework
acknowledges messages automatically or not. <br /><br />**Note**: This
configuration will be deprecated in future releases. If you specify a delivery
semantic, the framework automatically acknowledges messages. If you do not want
the framework to auto-ack messages, set the `processingGuarantees` to `MANUAL`.
|
| maxMessageRetries | Int | `--max-message-retries` | The number of
retries to process a message before giving up. |
@@ -74,8 +74,8 @@ The following table outlines the nested fields and related
arguments under the `
| schemaType | String | N/A
| N/A |
| serdeClassName | String | N/A
| N/A |
| isRegexPattern | Boolean | N/A
| N/A |
-| schemaProperties | Map`<String,String>` | N/A
| N/A |
-| consumerProperties | Map`<String,String>` | N/A
| N/A |
+| schemaProperties | Map<String,String\> | N/A
| N/A |
+| consumerProperties | Map<String,String\> | N/A
| N/A |
| receiverQueueSize | Int | N/A
| N/A |
| cryptoConfig | [CryptoConfig](#cryptoconfig) | N/A
|Refer to
[code](https://github.com/apache/pulsar/blob/master/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/functions/CryptoConfig.java).
|
| poolMessages | Boolean | N/A
| N/A |
@@ -125,7 +125,7 @@ The following table outlines the nested fields and related
arguments under the `
| Field Name | Type | Related Command
Argument | Description |
|-----------------------------|-----------------------------|--------------------------|---------------|
| cryptoKeyReaderClassName | String | N/A
| Refer to
[code](https://github.com/apache/pulsar/blob/master/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/functions/CryptoConfig.java).
|
-| cryptoKeyReaderConfig | Map`<String, Object>` | N/A
| N/A |
+| cryptoKeyReaderConfig | Map<String, Object\> | N/A
| N/A |
| encryptionKeys | String[] | N/A
| N/A |
| producerCryptoFailureAction | ProducerCryptoFailureAction | N/A
| N/A |
| consumerCryptoFailureAction | ConsumerCryptoFailureAction | N/A
| N/A |
diff --git a/versioned_docs/version-2.10.x/reference-metrics.md
b/versioned_docs/version-2.10.x/reference-metrics.md
index 6739dda3355..9f8a3014a56 100644
--- a/versioned_docs/version-2.10.x/reference-metrics.md
+++ b/versioned_docs/version-2.10.x/reference-metrics.md
@@ -122,7 +122,6 @@ All the namespace metrics are labelled with the following
labels:
| pulsar_storage_write_latency_le_* | Histogram | The entry rate of a
namespace that the storage write latency is smaller with a given threshold.<br
/> Available thresholds: <br /><ul><li>pulsar_storage_write_latency_le_0_5: <=
0.5ms </li><li>pulsar_storage_write_latency_le_1: <=
1ms</li><li>pulsar_storage_write_latency_le_5: <=
5ms</li><li>pulsar_storage_write_latency_le_10: <=
10ms</li><li>pulsar_storage_write_latency_le_20: <=
20ms</li><li>pulsar_storage_write_latency_le_50: <= 50ms</ [...]
| pulsar_entry_size_le_* | Histogram | The entry rate of a namespace that the
entry size is smaller with a given threshold.<br /> Available thresholds: <br
/><ul><li>pulsar_entry_size_le_128: <= 128 bytes
</li><li>pulsar_entry_size_le_512: <= 512
bytes</li><li>pulsar_entry_size_le_1_kb: <= 1
KB</li><li>pulsar_entry_size_le_2_kb: <= 2
KB</li><li>pulsar_entry_size_le_4_kb: <= 4
KB</li><li>pulsar_entry_size_le_16_kb: <= 16
KB</li><li>pulsar_entry_size_le_100_kb: <= 100 KB</li><li>pulsar_ent [...]
-
### Topic metrics
> Topic metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is
> set to `true`.
@@ -203,6 +202,9 @@ All the ManagedLedgerCache metrics are labelled with the
following labels:
| Name | Type | Description |
| --- | --- | --- |
| pulsar_ml_cache_evictions | Gauge | The number of cache evictions during the
last minute. |
+| pulsar_ml_cache_inserted_entries_total | Counter | The number of entries
inserted into the entry cache. |
+| pulsar_ml_cache_evicted_entries_total | Counter | The number of entries
evicted from the entry cache. |
+| pulsar_ml_cache_entries | Gauge | The number of entries in the entry cache. |
| pulsar_ml_cache_hits_rate | Gauge | The number of cache hits per second on
the broker side. |
| pulsar_ml_cache_hits_throughput | Gauge | The amount of data is retrieved
from the cache on the broker side (in byte/s). |
| pulsar_ml_cache_misses_rate | Gauge | The number of cache misses per second
on the broker side. |
@@ -299,7 +301,7 @@ All the bundleUnloading metrics are labelled with the
following labels:
| Name | Type | Description |
| --- | --- | --- |
-| pulsar_lb_bundles_split_count | Counter | bundle split count in this bundle
splitting check interval |
+| pulsar_lb_bundles_split_count | Counter | The total count of bundle split in
this leader broker |
### Bundle metrics
All the bundle metrics are labelled with the following labels:
diff --git a/versioned_docs/version-2.8.x/reference-metrics.md
b/versioned_docs/version-2.8.x/reference-metrics.md
index 4067b1ed193..7730aebc4e7 100644
--- a/versioned_docs/version-2.8.x/reference-metrics.md
+++ b/versioned_docs/version-2.8.x/reference-metrics.md
@@ -267,7 +267,7 @@ All the bundleUnloading metrics are labelled with the
following labels:
| Name | Type | Description |
| --- | --- | --- |
-| pulsar_lb_bundles_split_count | Counter | bundle split count in this bundle
splitting check interval |
+| pulsar_lb_bundles_split_count | Counter | The total count of bundle split in
this leader broker |
### Subscription metrics
diff --git a/versioned_docs/version-2.9.x/concepts-messaging.md
b/versioned_docs/version-2.9.x/concepts-messaging.md
index dbe540c5df8..92cd11c48ff 100644
--- a/versioned_docs/version-2.9.x/concepts-messaging.md
+++ b/versioned_docs/version-2.9.x/concepts-messaging.md
@@ -697,9 +697,19 @@ delayedDeliveryEnabled=true
# Control the ticking time for the retry of delayed message delivery,
# affecting the accuracy of the delivery time compared to the scheduled time.
+# Note that this time is used to configure the HashedWheelTimer's tick time
for the
+# InMemoryDelayedDeliveryTrackerFactory (the default
DelayedDeliverTrackerFactory).
# Default is 1 second.
delayedDeliveryTickTimeMillis=1000
+# When using the InMemoryDelayedDeliveryTrackerFactory (the default
DelayedDeliverTrackerFactory), whether
+# the deliverAt time is strictly followed. When false (default), messages may
be sent to consumers before the deliverAt
+# time by as much as the tickTimeMillis. This can reduce the overhead on the
broker of maintaining the delayed index
+# for a potentially very short time period. When true, messages are not sent
to consumers until the deliverAt time
+# has passed, and they may be as late as the deliverAt time plus the
tickTimeMillis for the topic plus the
+# delayedDeliveryTickTimeMillis.
+isDelayedDeliveryDeliverAtTimeStrict=false
+
```
### Producer
diff --git a/versioned_docs/version-2.9.x/reference-configuration.md
b/versioned_docs/version-2.9.x/reference-configuration.md
index e90124fbe1d..611ce2ca65e 100644
--- a/versioned_docs/version-2.9.x/reference-configuration.md
+++ b/versioned_docs/version-2.9.x/reference-configuration.md
@@ -191,7 +191,8 @@ Pulsar brokers are responsible for handling incoming
messages from producers, di
|brokerServiceCompactionMonitorIntervalInSeconds| Interval between checks to
determine whether topics with compaction policies need compaction. |60|
brokerServiceCompactionThresholdInBytes|If the estimated backlog size is
greater than this threshold, compression is triggered.<br /><br />Set this
threshold to 0 means disabling the compression check.|N/A
|delayedDeliveryEnabled| Whether to enable the delayed delivery for messages.
If disabled, messages will be immediately delivered and there will be no
tracking overhead.|true|
-|delayedDeliveryTickTimeMillis|Control the tick time for retrying on delayed
delivery, which affects the accuracy of the delivery time compared to the
scheduled time. By default, it is 1 second.|1000|
+|delayedDeliveryTickTimeMillis|Control the tick time for retrying on delayed
delivery, which affects the accuracy of the delivery time compared to the
scheduled time. By default, it is 1 second. Note that this time is used to
configure the HashedWheelTimer's tick time for the
`InMemoryDelayedDeliveryTrackerFactory` (the default
`DelayedDeliverTrackerFactory`).|1000|
+|isDelayedDeliveryDeliverAtTimeStrict|Control whether the deliverAt time is
strictly followed when using `InMemoryDelayedDeliveryTrackerFactory` (the
default `DelayedDeliverTrackerFactory`). By default (`false`), messages are
sent to consumers when their deliverAt time is within `tickTimeMillis` from
now, which reduces the overhead on the broker of maintaining the delayed index
for a potentially short time period. When it's set to `true`, messages will
only be delivered when the deliverA [...]
|activeConsumerFailoverDelayTimeMillis| How long to delay rewinding cursor and
dispatching messages when active consumer is changed. |1000|
|clientLibraryVersionCheckEnabled| Enable check for minimum allowed client
library version |false|
|clientLibraryVersionCheckAllowUnversioned| Allow client libraries with no
version information |true|
diff --git a/versioned_docs/version-2.9.x/reference-metrics.md
b/versioned_docs/version-2.9.x/reference-metrics.md
index ce6722da1c9..67d7bcc3f35 100644
--- a/versioned_docs/version-2.9.x/reference-metrics.md
+++ b/versioned_docs/version-2.9.x/reference-metrics.md
@@ -178,8 +178,8 @@ All the replication metrics are also labelled with
`remoteCluster=${pulsar_remot
| pulsar_replication_throughput_in | Gauge | The total throughput of the
namespace replicating from remote cluster (bytes/second). |
| pulsar_replication_throughput_out | Gauge | The total throughput of the
namespace replicating to remote cluster (bytes/second). |
| pulsar_replication_backlog | Gauge | The total backlog of the namespace
replicating to remote cluster (messages). |
-| pulsar_replication_rate_expired | Gauge | Total rate of messages expired
(messages/second). |
-| pulsar_replication_connected_count | Gauge | The count of
replication-subscriber up and running to replicate to remote cluster. |
+| pulsar_replication_rate_expired | Gauge | Total rate of messages expired
(messages/second). |
+| pulsar_replication_connected_count | Gauge | The count of
replication-subscriber up and running to replicate to remote cluster. |
| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time
a message was produced to the time when it is about to be replicated. |
### ManagedLedgerCache metrics
@@ -189,6 +189,9 @@ All the ManagedLedgerCache metrics are labelled with the
following labels:
| Name | Type | Description |
| --- | --- | --- |
| pulsar_ml_cache_evictions | Gauge | The number of cache evictions during the
last minute. |
+| pulsar_ml_cache_inserted_entries_total | Counter | The number of entries
inserted into the entry cache. Note that this metric is only available in
Pulsar 2.9.4 and later versions. |
+| pulsar_ml_cache_evicted_entries_total | Counter | The number of entries
evicted from the entry cache. Note that this metric is only available in Pulsar
2.9.4 and later versions. |
+| pulsar_ml_cache_entries | Gauge | The number of entries in the entry cache.
Note that this metric is only available in Pulsar 2.9.4 and later versions.|
| pulsar_ml_cache_hits_rate | Gauge | The number of cache hits per second. |
| pulsar_ml_cache_hits_throughput | Gauge | The amount of data is retrieved
from the cache in byte/s |
| pulsar_ml_cache_misses_rate | Gauge | The number of cache misses per second |
@@ -285,7 +288,7 @@ All the bundleUnloading metrics are labelled with the
following labels:
| Name | Type | Description |
| --- | --- | --- |
-| pulsar_lb_bundles_split_count | Counter | bundle split count in this bundle
splitting check interval |
+| pulsar_lb_bundles_split_count | Counter | The total count of bundle split in
this leader broker |
### Subscription metrics
@@ -390,7 +393,6 @@ All the connection metrics are labelled with the following
labels:
### Jetty metrics
> For a functions-worker running separately from brokers, its Jetty metrics
> are only exposed when `includeStandardPrometheusMetrics` is set to `true`.
-
All the jetty metrics are labelled with the following labels:
- *cluster*: `cluster=${pulsar_cluster}`. `${pulsar_cluster}` is the cluster
name that you have configured in the `broker.conf` file.
