You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "Anonymitaet (via GitHub)" <gi...@apache.org> on 2023/04/04 01:38:23 UTC
[GitHub] [pulsar-site] Anonymitaet opened a new pull request, #502: [feat][doc] Add Observability Guide
Anonymitaet opened a new pull request, #502:
URL: https://github.com/apache/pulsar-site/pull/502
## What issues does this PR solve?
This PR fixes https://github.com/apache/pulsar/issues/19776 and https://github.com/apache/pulsar/issues/20002.
I’ve summarized all issues with the corresponding solutions below.
Issues | Solutions
-- | --
[Metrics](https://pulsar.apache.org/docs/next/reference-metrics/), [Stas](https://pulsar.apache.org/docs/next/administration-stats/), and [Monitoring ](https://pulsar.apache.org/docs/next/deploy-monitoring/) docs are scattered around | Create `Observability` topic and move them there because they are technical relevant and accord with users' searching habits. <br/><br/>P.S. I'll relocate them firstly as a low-hanging fruit and quick win. It's an imperfect plan (because the content in these 3 topics can be improved and consolidated more logically), but we can optimize it later.
Some docs in stats are inaccurate | Correct the descriptions.
## What doc changes does this PR introduce?
### ✅ High-level structure changes
🍊Old structure VS. 🍊New structure
<img width="687" alt="image" src="https://user-images.githubusercontent.com/50226895/229663679-cc392fc9-4c3f-42c8-918d-045281a4ad66.png">
==================================
- [x] `doc`
Ping @D-2-Ed to review. Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#issuecomment-1495475140
@momo-jun sure, that's the doc plan for the next phase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#issuecomment-1495288948
@momo-jun @Huanli-Meng could you please help review? Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet merged pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet merged PR #502:
URL: https://github.com/apache/pulsar-site/pull/502
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on a diff in pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on code in PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#discussion_r1156686768
##########
sidebars.json:
##########
@@ -265,6 +263,15 @@
}
]
},
+ {
+ "type": "category",
+ "label": "Observability",
Review Comment:
For reviewers: an overview for Observability is not in the scope of this PR. It will be added later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Huanli-Meng commented on a diff in pull request #502: [feat][doc] Add Observability Guide
Posted by "Huanli-Meng (via GitHub)" <gi...@apache.org>.
Huanli-Meng commented on code in PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#discussion_r1156746968
##########
docs/administration-stats.md:
##########
@@ -22,15 +22,15 @@ All metrics below are *reset* to 0 upon broker restart, *except* gauges marked a
| msgRateOut | The sum of all local and replication consumers' dispatch rates (message per second). |
| msgThroughputOut | The sum of all local and replication consumers' dispatch rates (byte per second). |
| averageMsgSize | The average size (bytes) of messages published within the last interval. |
-| storageSize | The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic. Not reset upon restart |
-| earliestMsgPublishTimeInBacklogs | The publish time of the earliest message in the backlog (in milliseconds). Not reset upon restart |
+| storageSize* | The sum of the ledgers' storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the `total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
Review Comment:
Do we need to add a code sign for "total storage size of a topic"? Same comment on the next one.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on a diff in pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on code in PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#discussion_r1156834155
##########
docs/administration-stats.md:
##########
@@ -22,15 +22,15 @@ All metrics below are *reset* to 0 upon broker restart, *except* gauges marked a
| msgRateOut | The sum of all local and replication consumers' dispatch rates (message per second). |
| msgThroughputOut | The sum of all local and replication consumers' dispatch rates (byte per second). |
| averageMsgSize | The average size (bytes) of messages published within the last interval. |
-| storageSize | The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic. Not reset upon restart |
-| earliestMsgPublishTimeInBacklogs | The publish time of the earliest message in the backlog (in milliseconds). Not reset upon restart |
+| storageSize* | The sum of the ledgers' storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the `total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
Review Comment:
What does "code sign" refer to? Do you mean adding backslashes?
##########
docs/administration-stats.md:
##########
@@ -22,15 +22,15 @@ All metrics below are *reset* to 0 upon broker restart, *except* gauges marked a
| msgRateOut | The sum of all local and replication consumers' dispatch rates (message per second). |
| msgThroughputOut | The sum of all local and replication consumers' dispatch rates (byte per second). |
| averageMsgSize | The average size (bytes) of messages published within the last interval. |
-| storageSize | The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic. Not reset upon restart |
-| earliestMsgPublishTimeInBacklogs | The publish time of the earliest message in the backlog (in milliseconds). Not reset upon restart |
+| storageSize* | The sum of the ledgers' storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the `total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
Review Comment:
What does "code sign" refer to? Do you mean adding backslashes? (which they already have)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on a diff in pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on code in PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#discussion_r1156626060
##########
docs/administration-stats.md:
##########
@@ -1,7 +1,7 @@
---
id: administration-stats
title: Pulsar stats
-sidebar_label: "Pulsar statistics"
Review Comment:
For reviewers: I'll apply the same changes of `administration-stats.md` to 2.11.x and 2.10.x once they are approved by you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#issuecomment-1495218738
The preview looks good:
<img width="1919" alt="image" src="https://user-images.githubusercontent.com/50226895/229664285-249aa7bf-72bf-462e-a761-70bdd156830d.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] Anonymitaet commented on pull request #502: [feat][doc] Add Observability Guide
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #502:
URL: https://github.com/apache/pulsar-site/pull/502#issuecomment-1495220153
@hangc0276 Could you please review this PR from a technical perspective? Then I'll ask tws to review it from a technical writing side. Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org