Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document for bucket delayed message tracker metrics #564

Merged
merged 5 commits into from May 22, 2023

Conversation

coderzc
Copy link
Member

@coderzc coderzc commented May 8, 2023

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Improvements or additions to documentation label May 8, 2023
@Anonymitaet
Copy link
Member

@mattisonchao Could you please review this PR from a technical perspective? Then writers will review it from a technical writing side. Thank you!

Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

  1. Have you previewed your changes and ensured everything goes as expected?

    If not, please preview your changes locally and attach the screenshots to this PR.

    In this way, you can get your PR merged more quickly.

  2. Does this change apply to the master doc?

    If so, please update it.

Thank you! 😊

versioned_docs/version-3.0.x/reference-metrics.md Outdated Show resolved Hide resolved
versioned_docs/version-3.0.x/reference-metrics.md Outdated Show resolved Hide resolved
| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed message index buckets (immutable buckets + LastMutableBucket ) |
| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed message indexes for in the memory. |
| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total size of delayed message index bucket snapshot (in bytes). |
| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of operate delayed message index bucket snapshot. The `state` label can be `succeed`,`failed`,`all` (the `all` means is the total number of all states) and the `type` label can be `create`,`load`,`delete`,`merge`. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed message indexes for in the memory. |
| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total size of delayed message index bucket snapshot (in bytes). |
| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of operate delayed message index bucket snapshot. The `state` label can be `succeed`,`failed`,`all` (the `all` means is the total number of all states) and the `type` label can be `create`,`load`,`delete`,`merge`. |
| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency of delayed message index bucket snapshot operation with a given quantile (threshold). The label`type` label can be `create`,`load`,`delete`,`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between (50ms, 100ms]</li><li>quantile="500" is operation between (100ms, 500ms]</li><li>quantile="1000" is operation latency between (500ms, 1s]</li><li>quantile="5000" is operation latency between (1s, 5s]</li><li>quantile="30000" is operation latency between (5s, 30s]</li><li>quantile="60000" is operation latency between (30s, 60s]</li><li>quantile="overflow" is operation latency > 1m</li></ul> |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

Comment on lines 435 to 436
| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of operate delayed message index bucket snapshot. The `state` label can be `succeed`,`failed`,`all` (the `all` means is the total number of all states) and the `type` label can be `create`,`load`,`delete`,`merge`. |
| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency of delayed message index bucket snapshot operation with a given quantile (threshold). The label`type` label can be `create`,`load`,`delete`,`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between (50ms, 100ms]</li><li>quantile="500" is operation between (100ms, 500ms]</li><li>quantile="1000" is operation latency between (500ms, 1s]</li><li>quantile="5000" is operation latency between (1s, 5s]</li><li>quantile="30000" is operation latency between (5s, 30s]</li><li>quantile="60000" is operation latency between (30s, 60s]</li><li>quantile="overflow" is operation latency > 1m</li></ul> |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@Anonymitaet Anonymitaet added this to the 3.0.0 milestone May 15, 2023
coderzc and others added 4 commits May 22, 2023 10:45
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@coderzc
Copy link
Member Author

coderzc commented May 22, 2023

image

@Anonymitaet This change goes as expected.

@coderzc coderzc requested a review from Anonymitaet May 22, 2023 08:01
@Anonymitaet Anonymitaet merged commit 61f163e into main May 22, 2023
2 checks passed
@tisonkun tisonkun deleted the bucket_delayed_message_mertics branch May 24, 2023 17:28
@Technoboy- Technoboy- mentioned this pull request Aug 9, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
3 participants