docs: automate release metrics generation by AR21SM · Pull Request #1151 · etcd-io/website

AR21SM · 2026-04-29T14:13:50Z

What changed

This PR adds a script to update the generated metrics file from the etcd source.

It uses the existing tools/etcd-dump-metrics tool from etcd repo.

I also added make targets for updating and verifying the metrics docs, and updated the release version script so future release updates can also refresh the metrics file.

This PR regenerates the v3.6 metrics file from v3.6.0.

closes #1133

Note

I did not update v3.7 metrics in this PR because v3.7 is still draft and uses git_version_tag: main. I kept the script limited to released etcd tags to avoid committing metrics generated from a moving branch.

If maintainers want draft docs to track metrics from main, I can add that separately.

from txt -> html was already done in this pr #1139

k8s-ci-robot · 2026-04-29T14:13:57Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AR21SM
Once this PR has been reviewed and has the lgtm label, please assign ivanvc for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2026-04-29T14:14:01Z

Hi @AR21SM. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

jberkus · 2026-05-07T18:04:19Z

/ok-to-test

jberkus · 2026-05-14T20:30:52Z

+etcd_disk_wal_write_duration_seconds_bucket{le="0.001"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.002"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.004"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.008"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.016"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.032"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.064"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.128"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.256"}
+etcd_disk_wal_write_duration_seconds_bucket{le="0.512"}
+etcd_disk_wal_write_duration_seconds_bucket{le="1.024"}
+etcd_disk_wal_write_duration_seconds_bucket{le="2.048"}
+etcd_disk_wal_write_duration_seconds_bucket{le="4.096"}
+etcd_disk_wal_write_duration_seconds_bucket{le="8.192"}
+etcd_disk_wal_write_duration_seconds_bucket{le="+Inf"}


Does it actually help users to output all of these bucket thresholds in this format?

no, i dont think so
these bucket lines come from the existing tool tools/etcd-dump-metricsoutput https://github.com/etcd-io/etcd/tree/main/tools/etcd-dump-metrics. this PR was to automating the txt generation.

If the goal is to align more closely with the Kubernetes metrics reference,https://kubernetes.io/docs/reference/instrumentation/metrics/ I think the better fix would be to render one entry per metric with name, description, type, and label names, while hiding histogram/summary internals such as le and quantile.

alt, if u want i can filter those in the current tabular format if that is preferred.

If the goal is to align more closely with the Kubernetes metrics reference,https://kubernetes.io/docs/reference/instrumentation/metrics/ I think the better fix would be to render one entry per metric with name, description, type, and label names, while hiding histogram/summary internals such as le and quantile.

Sounds good to me.

will implement that and update the pr

@ahrtr does it looks good now than previously ??
https://deploy-preview-1151--etcd.netlify.app/docs/v3.6/metrics/etcd-metrics-latest/

https://etcd.io/docs/v3.6/metrics/etcd-metrics-latest/

cc @jberkus

ivanvc · 2026-06-03T18:24:42Z

Code-wise, this looks good, and it's updating the website.

However, please note that it's not updating the page from the PR description. It's updating the .txt generated file. The HTML version may still be out of date.

AR21SM · 2026-06-04T05:35:50Z

Code-wise, this looks good, and it's updating the website.

However, please note that it's not updating the page from the PR description. It's updating the .txt generated file. The HTML version may still be out of date.

HTML: https://deploy-preview-1151--etcd.netlify.app/docs/v3.6/metrics/etcd-metrics-latest/

TXT: https://deploy-preview-1151--etcd.netlify.app/docs/v3.6/metrics/etcd-metrics-latest.txt

it is updating html page too (maybe you can match https://deploy-preview-1151--etcd.netlify.app/docs/v3.6/metrics/etcd-metrics-latest/#:~:text=server_id%3D%227339c4e5e833c029%22), for reference here is the old main one https://etcd.io/docs/v3.6/metrics/etcd-metrics-latest/

old pr ref that does the html part: #1139

AR21SM · 2026-06-04T06:45:07Z

/cc @ahrtr @jberkus @ronaldngounou

ahrtr · 2026-06-04T09:05:17Z

cc @fuweid @serathius

ivanvc · 2026-06-04T23:17:01Z

it is updating html page too (maybe you can match https://deploy-preview-1151--etcd.netlify.app/docs/v3.6/metrics/etcd-metrics-latest/#:~:text=server_id%3D%227339c4e5e833c029%22), for reference here is the old main one https://etcd.io/docs/v3.6/metrics/etcd-metrics-latest/

I may not be following. The automation from this pull request is only updating the text file:

And if we're okay with updating the text file only, then this is correct. I was just confused with the pull request description showing a screenshot of a page which is not being updated by the automation.

AR21SM · 2026-06-05T04:43:49Z

The automation from this pull request is only updating the text file

yes, that's true

I was just confused with the pull request description showing a screenshot of a page which is not being updated by the automation.

oh, i forget to mention in pr description that from txt -> html part was done in this pr #1139 which got merged (so i didn't changed that), just worked on automating the txt generation part.

ivanvc · 2026-06-05T23:22:23Z

oh, i forget to mention in pr description that from txt -> html part was done in this pr #1139 which got merged (so i didn't changed that), just worked on automating the txt generation part.

Oh, ok, now I understand it. I think we'd like to execute that gotemplate when this automation runs, too. We can do that in a follow-up PR :)

Signed-off-by: AR21SM <mahajanashishar21sm@gmail.com>

AR21SM · 2026-06-07T06:52:10Z

I think we'd like to execute that gotemplate when this automation runs, too.

i placed this here is that fine ??
https://github.com/etcd-io/website/pull/1151/changes#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52:~:text=%2B-,npm%20run%20build,-53,
https://github.com/etcd-io/website/pull/1151/changes#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52:~:text=%2B-,npm%20run%20build,-44,

k8s-ci-robot added needs-ok-to-test size/L labels Apr 29, 2026

k8s-ci-robot added ok-to-test and removed needs-ok-to-test labels May 7, 2026

jberkus reviewed May 14, 2026

View reviewed changes

k8s-ci-robot requested review from ahrtr, jberkus and ronaldngounou June 4, 2026 06:45

docs: automate release metrics generation

7d4dce8

Signed-off-by: AR21SM <mahajanashishar21sm@gmail.com>

AR21SM force-pushed the docs/update-metrics-from-etcd branch from 087aee9 to 7d4dce8 Compare June 7, 2026 06:36

Conversation

AR21SM commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Note

Uh oh!

k8s-ci-robot commented Apr 29, 2026

Uh oh!

k8s-ci-robot commented Apr 29, 2026

Uh oh!

jberkus commented May 7, 2026

Uh oh!

jberkus May 14, 2026

Choose a reason for hiding this comment

Uh oh!

AR21SM May 16, 2026

Choose a reason for hiding this comment

Uh oh!

ahrtr Jun 4, 2026

Choose a reason for hiding this comment

Uh oh!

AR21SM Jun 4, 2026

Choose a reason for hiding this comment

Uh oh!

AR21SM Jun 7, 2026

Choose a reason for hiding this comment

Uh oh!

AR21SM Jun 7, 2026

Choose a reason for hiding this comment

Uh oh!

ivanvc commented Jun 3, 2026

Uh oh!

AR21SM commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AR21SM commented Jun 4, 2026

Uh oh!

ahrtr commented Jun 4, 2026

Uh oh!

ivanvc commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AR21SM commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivanvc commented Jun 5, 2026

Uh oh!

AR21SM commented Jun 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AR21SM commented Apr 29, 2026 •

edited

Loading

AR21SM commented Jun 4, 2026 •

edited

Loading

ivanvc commented Jun 4, 2026 •

edited

Loading

AR21SM commented Jun 5, 2026 •

edited

Loading