This is an automated email from the ASF dual-hosted git repository.
urfree 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 2436e3cb8df Docs sync done from apache/pulsar (#67bd947)
2436e3cb8df is described below
commit 2436e3cb8df0ee9cc55209e0a8db71eca37a396b
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Dec 26 06:12:43 2022 +0000
Docs sync done from apache/pulsar (#67bd947)
---
site2/website-next/docs/admin-api-topics.md | 82 +++++++++++++++++++--
.../static/swagger/master/swagger.json | 24 +++----
.../static/swagger/master/v2/swagger.json | 24 +++----
.../version-2.10.x/admin-api-topics.md | 83 +++++++++++++++++++---
.../version-2.8.x/admin-api-topics.md | 81 +++++++++++++++++++--
.../version-2.9.x/admin-api-topics.md | 83 +++++++++++++++++++---
6 files changed, 325 insertions(+), 52 deletions(-)
diff --git a/site2/website-next/docs/admin-api-topics.md
b/site2/website-next/docs/admin-api-topics.md
index 87c16345b32..2f71d897cba 100644
--- a/site2/website-next/docs/admin-api-topics.md
+++ b/site2/website-next/docs/admin-api-topics.md
@@ -1463,6 +1463,77 @@ The following is an example. For the description of
topic stats, see [Pulsar sta
}
```
+### Internal stats
+
+You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
+
+```json
+{
+ "entriesAddedCounter": 20449518,
+ "numberOfEntries": 3233,
+ "totalSize": 331482,
+ "currentLedgerEntries": 3233,
+ "currentLedgerSize": 331482,
+ "lastLedgerCreatedTimestamp": "2016-06-29 03:00:23.825",
+ "lastLedgerCreationFailureTimestamp": null,
+ "waitingCursorsCount": 1,
+ "pendingAddEntriesCount": 0,
+ "lastConfirmedEntry": "324711539:3232",
+ "state": "LedgerOpened",
+ "ledgers": [
+ {
+ "ledgerId": 324711539,
+ "entries": 0,
+ "size": 0
+ }
+ ],
+ "cursors": {
+ "my-subscription": {
+ "markDeletePosition": "324711539:3133",
+ "readPosition": "324711539:3233",
+ "waitingReadOp": true,
+ "pendingReadOps": 0,
+ "messagesConsumedCounter": 20449501,
+ "cursorLedger": 324702104,
+ "cursorLedgerLastEntry": 21,
+ "individuallyDeletedMessages": "[(324711539:3134‥324711539:3136],
(324711539:3137‥324711539:3140], ]",
+ "lastLedgerSwitchTimestamp": "2016-06-29 01:30:19.313",
+ "state": "Open"
+ }
+ }
+}
+```
+
+You can get the internal stats for the partitioned topic in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+pulsar-admin topics stats-internal \
+ persistent://test-tenant/namespace/topic
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getInternalStats(topic);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
## Manage partitioned topics
You can use Pulsar [admin API](admin-api-overview.md) to create, update,
delete and check the status of partitioned topics.
@@ -1711,7 +1782,6 @@ admin.topics().getPartitionedTopicList(namespace);
### Stats
-
You can check the current statistics of a given partitioned topic and its
connected producers and consumers in the following ways.
````mdx-code-block
@@ -1802,7 +1872,7 @@ Note that in the subscription JSON object,
`chuckedMessageRate` is deprecated. P
### Internal stats
-You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
+You can check the detailed statistics of a partitioned topic. The following is
an example. For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
```json
{
@@ -1850,20 +1920,20 @@ You can get the internal stats for the partitioned
topic in the following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics stats-internal \
-persistent://test-tenant/namespace/topic
+pulsar-admin topics partitioned-stats-internal \
+ persistent://test-tenant/namespace/topic
```
</TabItem>
<TabItem value="REST API">
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-internalStats|operation/getPartitionedInternalStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
```java
-admin.topics().getInternalStats(topic);
+admin.topics().getPartitionedInternalStats(topic);
```
</TabItem>
diff --git a/site2/website-next/static/swagger/master/swagger.json
b/site2/website-next/static/swagger/master/swagger.json
index f95857a36c5..9970ae0402c 100644
--- a/site2/website-next/static/swagger/master/swagger.json
+++ b/site2/website-next/static/swagger/master/swagger.json
@@ -18719,9 +18719,6 @@
]
},
"put": {
- "consumes": [
- "application/vnd.partitioned-topic-metadata+json"
- ],
"description": "It needs to be called before creating a
producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -18747,12 +18744,14 @@
"type": "string"
},
{
- "description": "The metadata for the topic",
+ "description": "The number of partitions for the
topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/PartitionedTopicMetadata"
+ "default": 0,
+ "format": "int32",
+ "type": "integer"
}
},
{
@@ -18771,19 +18770,19 @@
"description": "Current broker doesn't serve the
namespace of this topic"
},
"401": {
- "description": "Don't have permission to administrate
resources on this tenant"
+ "description": "Don't have permission to manage
resources on this tenant"
},
"403": {
"description": "Don't have admin permission"
},
"404": {
- "description": "Tenant or namespace doesn't exist"
+ "description": "The tenant/namespace does not exist"
},
"406": {
"description": "The number of partitions should be
more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
},
"409": {
- "description": "Partitioned topic already exist"
+ "description": "Partitioned topic already exists"
},
"412": {
"description": "Failed Reason : Name is invalid or
Namespace does not have any clusters configured"
@@ -28483,6 +28482,9 @@
]
},
"put": {
+ "consumes": [
+ "application/vnd.partitioned-topic-metadata+json"
+ ],
"description": "It needs to be called before creating a
producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -28508,14 +28510,12 @@
"type": "string"
},
{
- "description": "The number of partitions for the
topic",
+ "description": "The metadata for the topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "default": 0,
- "format": "int32",
- "type": "integer"
+ "$ref": "#/definitions/PartitionedTopicMetadata"
}
},
{
diff --git a/site2/website-next/static/swagger/master/v2/swagger.json
b/site2/website-next/static/swagger/master/v2/swagger.json
index f95857a36c5..9970ae0402c 100644
--- a/site2/website-next/static/swagger/master/v2/swagger.json
+++ b/site2/website-next/static/swagger/master/v2/swagger.json
@@ -18719,9 +18719,6 @@
]
},
"put": {
- "consumes": [
- "application/vnd.partitioned-topic-metadata+json"
- ],
"description": "It needs to be called before creating a
producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -18747,12 +18744,14 @@
"type": "string"
},
{
- "description": "The metadata for the topic",
+ "description": "The number of partitions for the
topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/PartitionedTopicMetadata"
+ "default": 0,
+ "format": "int32",
+ "type": "integer"
}
},
{
@@ -18771,19 +18770,19 @@
"description": "Current broker doesn't serve the
namespace of this topic"
},
"401": {
- "description": "Don't have permission to administrate
resources on this tenant"
+ "description": "Don't have permission to manage
resources on this tenant"
},
"403": {
"description": "Don't have admin permission"
},
"404": {
- "description": "Tenant or namespace doesn't exist"
+ "description": "The tenant/namespace does not exist"
},
"406": {
"description": "The number of partitions should be
more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic"
},
"409": {
- "description": "Partitioned topic already exist"
+ "description": "Partitioned topic already exists"
},
"412": {
"description": "Failed Reason : Name is invalid or
Namespace does not have any clusters configured"
@@ -28483,6 +28482,9 @@
]
},
"put": {
+ "consumes": [
+ "application/vnd.partitioned-topic-metadata+json"
+ ],
"description": "It needs to be called before creating a
producer on a partitioned topic.",
"operationId": "createPartitionedTopic",
"parameters": [
@@ -28508,14 +28510,12 @@
"type": "string"
},
{
- "description": "The number of partitions for the
topic",
+ "description": "The metadata for the topic",
"in": "body",
"name": "body",
"required": true,
"schema": {
- "default": 0,
- "format": "int32",
- "type": "integer"
+ "$ref": "#/definitions/PartitionedTopicMetadata"
}
},
{
diff --git
a/site2/website-next/versioned_docs/version-2.10.x/admin-api-topics.md
b/site2/website-next/versioned_docs/version-2.10.x/admin-api-topics.md
index 90baa7a120e..0625d1c58da 100644
--- a/site2/website-next/versioned_docs/version-2.10.x/admin-api-topics.md
+++ b/site2/website-next/versioned_docs/version-2.10.x/admin-api-topics.md
@@ -1829,6 +1829,77 @@ admin.topics().getStats(topic, false /* is precise
backlog */);
</Tabs>
````
+### Internal stats
+
+You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
+
+```json
+{
+ "entriesAddedCounter": 20449518,
+ "numberOfEntries": 3233,
+ "totalSize": 331482,
+ "currentLedgerEntries": 3233,
+ "currentLedgerSize": 331482,
+ "lastLedgerCreatedTimestamp": "2016-06-29 03:00:23.825",
+ "lastLedgerCreationFailureTimestamp": null,
+ "waitingCursorsCount": 1,
+ "pendingAddEntriesCount": 0,
+ "lastConfirmedEntry": "324711539:3232",
+ "state": "LedgerOpened",
+ "ledgers": [
+ {
+ "ledgerId": 324711539,
+ "entries": 0,
+ "size": 0
+ }
+ ],
+ "cursors": {
+ "my-subscription": {
+ "markDeletePosition": "324711539:3133",
+ "readPosition": "324711539:3233",
+ "waitingReadOp": true,
+ "pendingReadOps": 0,
+ "messagesConsumedCounter": 20449501,
+ "cursorLedger": 324702104,
+ "cursorLedgerLastEntry": 21,
+ "individuallyDeletedMessages": "[(324711539:3134‥324711539:3136],
(324711539:3137‥324711539:3140], ]",
+ "lastLedgerSwitchTimestamp": "2016-06-29 01:30:19.313",
+ "state": "Open"
+ }
+ }
+}
+```
+
+You can get the internal stats for the partitioned topic in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+$ pulsar-admin topics stats-internal \
+ persistent://test-tenant/namespace/topic
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getInternalStats(topic);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
## Manage partitioned topics
You can use Pulsar [admin API](admin-api-overview.md) to create, update,
delete and check status of partitioned topics.
@@ -2179,7 +2250,7 @@ admin.topics().getPartitionedStats(topic, true /* per
partition */, false /* is
### Internal stats
-You can check the detailed statistics of a topic. The following is an example.
For description of each stats, refer to [get internal
stats](#get-internal-stats).
+You can check the detailed statistics of a partitioned topic. The following is
an example. For description of each stats, refer to [get internal
stats](#get-internal-stats).
```json
@@ -2229,24 +2300,20 @@ You can get the internal stats for the partitioned
topic in the following ways.
<TabItem value="pulsar-admin">
```shell
-
-$ pulsar-admin topics stats-internal \
+$ pulsar-admin topics partitioned-stats-internal \
persistent://test-tenant/namespace/topic
-
```
</TabItem>
<TabItem value="REST API">
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-internalStats|operation/getPartitionedInternalStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
```java
-
-admin.topics().getInternalStats(topic);
-
+admin.topics().getPartitionedInternalStats(topic);
```
</TabItem>
diff --git
a/site2/website-next/versioned_docs/version-2.8.x/admin-api-topics.md
b/site2/website-next/versioned_docs/version-2.8.x/admin-api-topics.md
index 11553618ffa..cf44c9532e7 100644
--- a/site2/website-next/versioned_docs/version-2.8.x/admin-api-topics.md
+++ b/site2/website-next/versioned_docs/version-2.8.x/admin-api-topics.md
@@ -1546,6 +1546,77 @@ admin.topics().getStats(topic, false /* is precise
backlog */);
</Tabs>
````
+### Internal stats
+
+You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
+
+```json
+{
+ "entriesAddedCounter": 20449518,
+ "numberOfEntries": 3233,
+ "totalSize": 331482,
+ "currentLedgerEntries": 3233,
+ "currentLedgerSize": 331482,
+ "lastLedgerCreatedTimestamp": "2016-06-29 03:00:23.825",
+ "lastLedgerCreationFailureTimestamp": null,
+ "waitingCursorsCount": 1,
+ "pendingAddEntriesCount": 0,
+ "lastConfirmedEntry": "324711539:3232",
+ "state": "LedgerOpened",
+ "ledgers": [
+ {
+ "ledgerId": 324711539,
+ "entries": 0,
+ "size": 0
+ }
+ ],
+ "cursors": {
+ "my-subscription": {
+ "markDeletePosition": "324711539:3133",
+ "readPosition": "324711539:3233",
+ "waitingReadOp": true,
+ "pendingReadOps": 0,
+ "messagesConsumedCounter": 20449501,
+ "cursorLedger": 324702104,
+ "cursorLedgerLastEntry": 21,
+ "individuallyDeletedMessages": "[(324711539:3134‥324711539:3136],
(324711539:3137‥324711539:3140], ]",
+ "lastLedgerSwitchTimestamp": "2016-06-29 01:30:19.313",
+ "state": "Open"
+ }
+ }
+}
+```
+
+You can get the internal stats for the partitioned topic in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+$ pulsar-admin topics stats-internal \
+ persistent://test-tenant/namespace/topic
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getInternalStats(topic);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
## Manage partitioned topics
You can use Pulsar [admin API](admin-api-overview.md) to create, update,
delete and check status of partitioned topics.
@@ -1896,7 +1967,7 @@ admin.topics().getPartitionedStats(topic, true /* per
partition */, false /* is
### Internal stats
-You can check the detailed statistics of a topic. The following is an example.
For description of each stats, refer to [get internal
stats](#get-internal-stats).
+You can check the detailed statistics of a partitioned topic. The following is
an example. For description of each stats, refer to [get internal
stats](#get-internal-stats).
```json
@@ -1946,23 +2017,21 @@ You can get the internal stats for the partitioned
topic in the following ways.
<TabItem value="pulsar-admin">
```shell
-
-$ pulsar-admin topics stats-internal \
+$ pulsar-admin topics partitioned-stats-internal \
persistent://test-tenant/namespace/topic
-
```
</TabItem>
<TabItem value="REST API">
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-internalStats|operation/getPartitionedInternalStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
```java
-admin.topics().getInternalStats(topic);
+admin.topics().getPartitionedInternalStats(topic);
```
diff --git
a/site2/website-next/versioned_docs/version-2.9.x/admin-api-topics.md
b/site2/website-next/versioned_docs/version-2.9.x/admin-api-topics.md
index 7a7316fce8a..8be85ee2d98 100644
--- a/site2/website-next/versioned_docs/version-2.9.x/admin-api-topics.md
+++ b/site2/website-next/versioned_docs/version-2.9.x/admin-api-topics.md
@@ -1775,6 +1775,77 @@ admin.topics().getStats(topic, false /* is precise
backlog */);
</Tabs>
````
+### Internal stats
+
+You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
+
+```json
+{
+ "entriesAddedCounter": 20449518,
+ "numberOfEntries": 3233,
+ "totalSize": 331482,
+ "currentLedgerEntries": 3233,
+ "currentLedgerSize": 331482,
+ "lastLedgerCreatedTimestamp": "2016-06-29 03:00:23.825",
+ "lastLedgerCreationFailureTimestamp": null,
+ "waitingCursorsCount": 1,
+ "pendingAddEntriesCount": 0,
+ "lastConfirmedEntry": "324711539:3232",
+ "state": "LedgerOpened",
+ "ledgers": [
+ {
+ "ledgerId": 324711539,
+ "entries": 0,
+ "size": 0
+ }
+ ],
+ "cursors": {
+ "my-subscription": {
+ "markDeletePosition": "324711539:3133",
+ "readPosition": "324711539:3233",
+ "waitingReadOp": true,
+ "pendingReadOps": 0,
+ "messagesConsumedCounter": 20449501,
+ "cursorLedger": 324702104,
+ "cursorLedgerLastEntry": 21,
+ "individuallyDeletedMessages": "[(324711539:3134‥324711539:3136],
(324711539:3137‥324711539:3140], ]",
+ "lastLedgerSwitchTimestamp": "2016-06-29 01:30:19.313",
+ "state": "Open"
+ }
+ }
+}
+```
+
+You can get the internal stats for the partitioned topic in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+$ pulsar-admin topics stats-internal \
+ persistent://test-tenant/namespace/topic
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getInternalStats(topic);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
## Manage partitioned topics
You can use Pulsar [admin API](admin-api-overview.md) to create, update,
delete and check status of partitioned topics.
@@ -2125,7 +2196,7 @@ admin.topics().getPartitionedStats(topic, true /* per
partition */, false /* is
### Internal stats
-You can check the detailed statistics of a topic. The following is an example.
For description of each stats, refer to [get internal
stats](#get-internal-stats).
+You can check the detailed statistics of a partitioned topic. The following is
an example. For description of each stats, refer to [get internal
stats](#get-internal-stats).
```json
@@ -2175,24 +2246,20 @@ You can get the internal stats for the partitioned
topic in the following ways.
<TabItem value="pulsar-admin">
```shell
-
-$ pulsar-admin topics stats-internal \
+$ pulsar-admin topics partitioned-stats-internal \
persistent://test-tenant/namespace/topic
-
```
</TabItem>
<TabItem value="REST API">
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/internalStats|operation/getInternalStats?version=@pulsar:version_number@}
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-internalStats|operation/getPartitionedInternalStats?version=@pulsar:version_number@}
</TabItem>
<TabItem value="Java">
```java
-
-admin.topics().getInternalStats(topic);
-
+admin.topics().getPartitionedInternalStats(topic);
```
</TabItem>
