detail description for metrics in document

[JayiceZ]

VictoriaLogs provide detailed descriptions of the exposed metrics: https://docs.victoriametrics.com/victorialogs/metrics/

it will be nice if VictoriaTraces can have one!

[jiekun]

Hi. I like the suggestion and we had internal discussion regarding this.

Currently we have official dashboard, and they should be available on Grafana soon. And usually users want to see the explanation of a metrics because they find something is missing on the dashboard, so they have to build another one/another charts.

I think what would be more useful is: understand what user wants on the dashboard, and add charts and explanation there.

Take VictoriaMetrics as an example, if you check its dashboard, we have detailed explanation there especially for the Troubleshooting row:

And additionally, maintaining a metrics list does require more efforts.

In conclusion, I think we can wait and see which solution—either creating a metrics list page or perfecting the dashboard—is better and more likely to be accepted by users in VictoriaLogs, rather than rushing to provide such a metrics list for VictoriaTraces.