Skip to content

Add documentation for feature metrics #36579

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Dec 17, 2024
Merged

Add documentation for feature metrics #36579

merged 2 commits into from
Dec 17, 2024

Conversation

aanm
Copy link
Member

@aanm aanm commented Dec 13, 2024 •
edited
Loading

Add documentation for feature metrics introduced in #35852

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Dec 13, 2024
@aanm aanm force-pushed the pr/add-feature-metric-docs branch 5 times, most recently from 55e1cd6 to 89f0f12 Compare December 13, 2024 13:12
@aanm aanm changed the title Pr/add feature metric docs Add documentation for feature metrics Dec 13, 2024
@aanm aanm force-pushed the pr/add-feature-metric-docs branch from 62c10ac to c0722c3 Compare December 13, 2024 13:32
@aanm
Copy link
Member Author

aanm commented Dec 13, 2024

/test

@aanm aanm marked this pull request as ready for review December 13, 2024 13:32
@aanm aanm requested review from a team as code owners December 13, 2024 13:32
@aanm aanm enabled auto-merge December 13, 2024 13:32
@aanm aanm added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/misc Impacts miscellaneous areas of the code not otherwise owned by another area. area/metrics Impacts statistics / metrics gathering, eg via Prometheus. release-note/misc This PR makes changes that have no direct user impact. labels Dec 13, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Dec 13, 2024
qmonnet
qmonnet requested changes Dec 13, 2024
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

This is not only a doc change. Would you mind providing a brief description and motivation for the feature-helm-generator and related CI steps that you introduce in your commit title+description, please?

@aanm aanm requested a review from qmonnet December 16, 2024 09:28
@aanm aanm force-pushed the pr/add-feature-metric-docs branch from c0722c3 to f8ef408 Compare December 16, 2024 09:28
@aanm
Copy link
Member Author

aanm commented Dec 16, 2024

/test

@aanm aanm mentioned this pull request Dec 16, 2024
Merged
qmonnet
qmonnet approved these changes Dec 16, 2024
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thank you!

aanm added 2 commits December 17, 2024 08:49
@aanm
docs: document feature metrics and add rst generator
895dcd5 
Add documentation for the feature metrics available on the agent and
operator.

Introduce the feature-helm-generator to generate .rst files with tables
documenting feature metrics. Combined with the CI step, this ensures
that the documentation remains in sync when new feature-related metrics
are added, preventing outdated or incomplete documentation.

Signed-off-by: André Martins <andre@cilium.io>
@aanm
prom: do not lint operator metrics
a0a62cc 
The linter will fail with the current metrics. Until those metrics are
fixed we should not run it.

Signed-off-by: André Martins <andre@cilium.io>
@aanm aanm force-pushed the pr/add-feature-metric-docs branch from f8ef408 to a0a62cc Compare December 17, 2024 07:49
@aanm
Copy link
Member Author

aanm commented Dec 17, 2024

/test

1 similar comment
@aanm
Copy link
Member Author

aanm commented Dec 17, 2024

/test

@aanm aanm added this pull request to the merge queue Dec 17, 2024
Merged via the queue into main with commit f312a9e Dec 17, 2024
287 of 288 checks passed
@aanm aanm deleted the pr/add-feature-metric-docs branch December 17, 2024 16:13
@maintainer-s-little-helper maintainer-s-little-helper bot added ready-to-merge This PR has passed all tests and received consensus from code owners to merge. labels Dec 17, 2024
@cilium-release-bot cilium-release-bot bot mentioned this pull request Dec 18, 2024
Merged
@aanm aanm mentioned this pull request Jan 15, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qmonnet qmonnet qmonnet approved these changes

@viktor-kurchenko viktor-kurchenko viktor-kurchenko approved these changes

+1 more reviewer

@doniacld doniacld doniacld approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/metrics Impacts statistics / metrics gathering, eg via Prometheus. area/misc Impacts miscellaneous areas of the code not otherwise owned by another area. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aanm @qmonnet @doniacld @viktor-kurchenko