Skip to content

docs: generate page for metrics per version to replace plain .txt file#1139

Merged
jberkus merged 2 commits intoetcd-io:mainfrom
christophsj:docs/replace-plain-txt-metrics
Apr 8, 2026
Merged

docs: generate page for metrics per version to replace plain .txt file#1139
jberkus merged 2 commits intoetcd-io:mainfrom
christophsj:docs/replace-plain-txt-metrics

Conversation

@christophsj
Copy link
Copy Markdown
Contributor

@christophsj christophsj commented Mar 24, 2026

Create pages for displaying a list of metrics per version, instead of linking to a plain .txt file.

This will make it much easier to read and navigate through the metrics.
The page is based on .txt file content, e.g.:

# name: "etcd_network_peer_round_trip_time_seconds"
# description: "Round-Trip-Time histogram between peers"
# type: "histogram"
etcd_network_peer_round_trip_time_seconds_bucket{To="REMOTE_PEER_NODE_ID",le="+Inf"}

will be parsed into a single row in the table with name, description, type.
Also, Labels within the metric (To="REMOTE_PEER_NODE_ID",le="+Inf" in this example) and one example value will be displayed.

metrics.md was renamed/moved to metrics/_index.md to make breadcrumb navigation work.

{{< metrics-list >}} is no longer necessary because the links to child pages will be automatically generated below the content.

Use simple_list: true to remove the separator between the heading Generated list of metrics and links to the versions

Issue #1133

Signed-off-by: Christoph Jandl <cjandl98@gmail.com>
@k8s-ci-robot
Copy link
Copy Markdown

Hi @christophsj. 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.

@k8s-ci-robot
Copy link
Copy Markdown

@ronaldngounou: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test pull-website-lint

Use /test all to run all jobs.

Details

In response to this:

/test

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.

@ronaldngounou
Copy link
Copy Markdown
Member

/ok-to-test

Signed-off-by: Christoph Jandl <cjandl98@gmail.com>
@christophsj christophsj force-pushed the docs/replace-plain-txt-metrics branch from 3315cbc to 5147d2f Compare March 27, 2026 08:56
@k8s-ci-robot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christophsj, jberkus

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@jberkus jberkus merged commit 4caf96f into etcd-io:main Apr 8, 2026
6 checks passed
@jberkus
Copy link
Copy Markdown
Contributor

jberkus commented Apr 8, 2026

Thanks! And let us know if you want to work on the long-term replacement.

@christophsj
Copy link
Copy Markdown
Contributor Author

@jberkus definitely, would be glad to keep working on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants