This is an automated email from the ASF dual-hosted git repository.
lhotari 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 c6b0da30a318 [feat][doc] PIP-264: Add replication metrics reference
(#926)
c6b0da30a318 is described below
commit c6b0da30a3187ccd2f0bd2b45a24ffd3005c54ef
Author: Dragos Misca <[email protected]>
AuthorDate: Tue Oct 29 04:01:41 2024 -0700
[feat][doc] PIP-264: Add replication metrics reference (#926)
* [feat][doc] PIP-264: Add replication metrics reference
* Apply changes to 4.0.x
---------
Co-authored-by: Lari Hotari <[email protected]>
---
docs/reference-metrics-opentelemetry.md | 114 +++++++++++++++++++++
.../reference-metrics-opentelemetry.md | 114 +++++++++++++++++++++
2 files changed, 228 insertions(+)
diff --git a/docs/reference-metrics-opentelemetry.md
b/docs/reference-metrics-opentelemetry.md
index 4d21357bf5e5..3594dc57ce61 100644
--- a/docs/reference-metrics-opentelemetry.md
+++ b/docs/reference-metrics-opentelemetry.md
@@ -795,6 +795,120 @@ The current usage of threads in the pulsar-web executor
pool.
* `current` - Indicates the total number of threads currently associated
with the pool.
* `idle` - Indicates the number of threads available to serve requests.
+### Replicator metrics
+
+#### pulsar.broker.replication.message.incoming.count
+The total number of messages received from the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.outgoing.count
+The total number of messages sent to the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.incoming.size
+The total number of messages bytes received from the remote cluster through
this replicator.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.outgoing.size
+The total number of messages bytes sent to the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.backlog.count
+The total number of messages in the backlog for this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.backlog.age
+The age of the oldest message in the replicator backlog.
+* Type: Gauge
+* Unit: `s`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.expired.count
+The total number of messages that expired for this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.dropped.count
+The total number of messages dropped by this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
### Schema Registry Metrics
#### pulsar.broker.request.schema_registry.duration
diff --git a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
index 4d21357bf5e5..3594dc57ce61 100644
--- a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
+++ b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
@@ -795,6 +795,120 @@ The current usage of threads in the pulsar-web executor
pool.
* `current` - Indicates the total number of threads currently associated
with the pool.
* `idle` - Indicates the number of threads available to serve requests.
+### Replicator metrics
+
+#### pulsar.broker.replication.message.incoming.count
+The total number of messages received from the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.outgoing.count
+The total number of messages sent to the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.incoming.size
+The total number of messages bytes received from the remote cluster through
this replicator.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.outgoing.size
+The total number of messages bytes sent to the remote cluster through this
replicator.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.backlog.count
+The total number of messages in the backlog for this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.backlog.age
+The age of the oldest message in the replicator backlog.
+* Type: Gauge
+* Unit: `s`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.expired.count
+The total number of messages that expired for this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
+#### pulsar.broker.replication.message.dropped.count
+The total number of messages dropped by this replicator.
+* Type: Counter
+* Unit: `{message}`
+* Attributes:
+ * `pulsar.domain` - The domain of the topic. Can be one of:
+ * `persistent`
+ * `non-persistent`
+ * `pulsar.tenant` - The topic tenant.
+ * `pulsar.namespace` - The topic namespace.
+ * `pulsar.topic` - The topic name.
+ * `pulsar.partition.index` - The partition index of the topic. Present only
if the topic is partitioned.
+ * `pulsar.replication.remote.cluster.name` - The name of the remote cluster.
+
### Schema Registry Metrics
#### pulsar.broker.request.schema_registry.duration
