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.

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

Update documentation related to metrics; fix incorrect FQDN metrics reference #22300

Merged
merged 2 commits into from
Nov 22, 2022
Merged

Update documentation related to metrics; fix incorrect FQDN metrics reference #22300

merged 2 commits into from
Nov 22, 2022

Conversation

christarazi
Copy link
Member

@christarazi christarazi commented Nov 21, 2022 •
edited
Loading

  • docs: Update API rate limiter metrics to match style of other metrics
  • docs: Fix incorrect FQDN metrics which are disabled by default

Second commit fixes #20255.

@christarazi christarazi added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. sig/policy Impacts whether traffic is allowed or denied based on user-defined policies. release-note/misc This PR makes changes that have no direct user impact. labels Nov 21, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Nov 21, 2022
@christarazi christarazi changed the title pr/christarazi/fix metrics default docs Update documentation related to metrics; fix incorrect FQDN metrics reference Nov 21, 2022
@christarazi christarazi force-pushed the pr/christarazi/fix-metrics-default-docs branch from de64597 to ddb7392 Compare November 21, 2022 23:57
@christarazi christarazi mentioned this pull request Nov 21, 2022
Merged
@christarazi
docs: Update API rate limiter metrics to match style of other metrics
6666359 
We do this by removing the extraneous "cilium_" prefix from the metrics
to align with the other metrics names in this file.

Signed-off-by: Chris Tarazi <chris@isovalent.com>
@christarazi
docs: Fix incorrect FQDN metrics which are disabled by default
4ee5d78 
This metrics were incorrectly stating that they were enabled by default
which confused users. Fix it to mention they are disabled by default and
must be enabled explicitly via --metrics.

Fixes: 1133bd5 ("docs: Added `Default` column in metrics details")
Fixes: cilium#20255

Signed-off-by: Chris Tarazi <chris@isovalent.com>
@christarazi christarazi force-pushed the pr/christarazi/fix-metrics-default-docs branch from ddb7392 to 4ee5d78 Compare November 21, 2022 23:59
@christarazi christarazi marked this pull request as ready for review November 21, 2022 23:59
@christarazi christarazi requested review from a team as code owners November 21, 2022 23:59
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.12.5 Nov 21, 2022
@joestringer joestringer merged commit f072dbd into cilium:master Nov 22, 2022
@christarazi christarazi deleted the pr/christarazi/fix-metrics-default-docs branch November 22, 2022 05:12
@tklauser tklauser mentioned this pull request Nov 22, 2022
Merged
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.12 in 1.12.5 Nov 22, 2022
@jrajahalme jrajahalme added backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. and removed backport-pending/1.12 labels Nov 24, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.12 to Backport done to v1.12 in 1.12.5 Nov 24, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.12 to Backport done to v1.12 in 1.12.5 Nov 24, 2022
@joestringer joestringer mentioned this pull request Dec 16, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joestringer joestringer joestringer approved these changes

@michi-covalent michi-covalent michi-covalent approved these changes

@aditighag aditighag Awaiting requested review from aditighag aditighag was automatically assigned from cilium/sig-policy

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. release-note/misc This PR makes changes that have no direct user impact. sig/policy Impacts whether traffic is allowed or denied based on user-defined policies.
Projects
No open projects
1.12.5
Backport done to v1.12
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@christarazi @joestringer @michi-covalent @tklauser @jrajahalme