Skip to content

docs(metrics): clarify MetricsConfiguration metric names#2181

Open
officialasishkumar wants to merge 1 commit intomicrosoft:mainfrom
officialasishkumar:docs/metricsconfiguration-names
Open

docs(metrics): clarify MetricsConfiguration metric names#2181
officialasishkumar wants to merge 1 commit intomicrosoft:mainfrom
officialasishkumar:docs/metricsconfiguration-names

Conversation

@officialasishkumar
Copy link
Copy Markdown

Description

Clarifies that Advanced metrics documentation lists exported Prometheus metric names, while MetricsConfiguration uses base metric names in spec.contextOptions[].metricName.

Adds a mapping table for the Advanced metrics names, including the TCP retransmission case where the exported metric is adv_tcpretrans_count and the CRD value is tcp_retransmission_count.

Related Issue

Fixes #1999

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Screenshots (if applicable) or Testing Completed

  • npx --yes markdownlint-cli2 --config .github/.markdownlint.json 'docs/**/*.md'
  • npm install --prefix site/ && npm run build --prefix site/

Additional Notes

No runtime changes are included.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@officialasishkumar
Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Copy link
Copy Markdown
Member

@SRodi SRodi 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 this contribution @officialasishkumar ! Your signature/key needs to be verified, see steps here https://retina.sh/docs/Contributing/development#cryptographic-signing-of-commits

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation and Code for adv_tcpretrans_count doesn't align

2 participants