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

[Documentation] No documentation for metric definitions #6730

Open
rudrakhp opened this issue May 2, 2024 · 5 comments
Open

[Documentation] No documentation for metric definitions #6730

rudrakhp opened this issue May 2, 2024 · 5 comments

Comments

@rudrakhp
Copy link
Contributor

rudrakhp commented May 2, 2024

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:

  1. What does http send metric capture if there are multiple send calls in a single query execution?
  2. Is http send metric emitted if there is an inter query cache hit?

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

@ashutosh-narkar
Copy link
Member

We have this section that explains the performance metrics. Feel free to update if you think it needs to be improved.

@rudrakhp
Copy link
Contributor Author

@ashutosh-narkar I don't see the http.send() builtin metrics here (or any other builtin for that matter), will it be good to have them here?
Also does OPA emit a metric for number of http.send() calls in each policy execution. Today we would have to look into policy code to check this.

@ashutosh-narkar
Copy link
Member

If you see any missing ones feel free to update. We keep on adding more metrics and probably the doc hasn't been updated.

@rudrakhp
Copy link
Contributor Author

rudrakhp commented May 28, 2024

Also does OPA emit a metric for number of http.send() calls in each policy execution. Today we would have to look into policy code to check this.

@ashutosh-narkar any comments on this? If this metric doesn't exist yet, I could work on adding this.

@ashutosh-narkar
Copy link
Member

Also does OPA emit a metric for number of http.send() calls in each policy execution.

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.

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

No branches or pull requests

2 participants