-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
[Documentation] No documentation for metric definitions #6730
Comments
We have this section that explains the performance metrics. Feel free to update if you think it needs to be improved. |
@ashutosh-narkar I don't see the |
If you see any missing ones feel free to update. We keep on adding more metrics and probably the doc hasn't been updated. |
@ashutosh-narkar any comments on this? If this metric doesn't exist yet, I could work on adding this. |
I don't think so. There is a metric around inter-query cache hits. It would be better if you could create a separate issue for that with details about the need for such a metric. Thanks. |
What is the underlying problem you're trying to solve?
I could not find any proper documentation that lists all metrics emitted by OPA or the envoy plugin today. Although the names are self explanatory, some might need a more thorough explanation.
Few examples of such scenarios from top of my head:
Please do let me know if there is any source I might have missed!
Describe the ideal solution
Although deep diving of the code gives a good insight on these questions, a documentation page/table dedicated to metrics and how they are captured will help the user interpret those metrics better.
Describe a "Good Enough" solution
If not a documentation page, a simple README would do.
Additional Context
N/A
The text was updated successfully, but these errors were encountered: