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.

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

Add CloudDocs documentation for metric descriptions #223

Open
megamattzilla opened this issue Sep 8, 2022 · 1 comment
Open

Add CloudDocs documentation for metric descriptions #223

megamattzilla opened this issue Sep 8, 2022 · 1 comment
Labels
enhancement New feature or request untriaged Issue needs to be reviewed for validity

Comments

@megamattzilla
Copy link

Is your feature request related to a problem? Please describe.

Understanding the resulting TS metrics and making them useful can be difficult. It would be helpful to have documentation explaining the metrics so that customers make better use of them.

Describe the solution you'd like

A page on cloud docs that explain the metrics output and any recommendations on analysis like aggregate or average/sum.
Example data from Azure LB metrics: https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-standard-diagnostics

Additional context

Example: a customer is reviewing metric output from Prometheus pull consumer and it can be difficult to identify what these metrics are for:

f5_system_configSyncSucceeded
f5_counters_bitsIn,
f5_numberReqs
f5_2xxResp,f5_3xxResp,f5_4xxResp,f5_5xxResp
f5_counters_bitsOut
@megamattzilla megamattzilla added enhancement New feature or request untriaged Issue needs to be reviewed for validity labels Sep 8, 2022
@tizianorosato-gr
Copy link

Hi, some metrics are not so intuitive.
Prometheus metrics documentation will be greatly useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request untriaged Issue needs to be reviewed for validity
Projects
None yet
Development

No branches or pull requests

2 participants