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

chore: adds dashboard. #222

Merged
merged 6 commits into from
Jan 5, 2024
Merged

chore: adds dashboard. #222

merged 6 commits into from
Jan 5, 2024

Conversation

jcchavezs
Copy link
Member

Often people talks about memory consumption by coraza-proxy-wasm, however it would be easier to understand what is going on with the config applied plus a dashboard screenshot, hence this PR.

Related to #191 #219

Closes #221

@jcchavezs jcchavezs requested a review from anuraaga as a code owner August 11, 2023 18:05
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -0,0 +1,234 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this or other files are copied from somewhere it would be good to have a link somewhere.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this was done myself from try/fail. Couldn't find a decent dashboard to work for me (there are many and also an official but I couldn't make them work)

example/envoy-config.yaml Outdated Show resolved Hide resolved
@M4tteoP
Copy link
Member

M4tteoP commented Oct 23, 2023

I rebased the PR, addressed some reviews and extended the dashboard. Now it looks like:
Screenshot 2023-10-23 at 18 47 56

@jcchavezs
Copy link
Member Author

Shall we borrow some metrics from https://grafana.com/grafana/dashboards/13277-istio-wasm-extension-dashboard/ ? cc @zirain

@zirain
Copy link

zirain commented Oct 25, 2023

Shall we borrow some metrics from https://grafana.com/grafana/dashboards/13277-istio-wasm-extension-dashboard/ ? cc @zirain

absolutely, you should.

@zirain
Copy link

zirain commented Oct 25, 2023

I rebased the PR, addressed some reviews and extended the dashboard. Now it looks like: Screenshot 2023-10-23 at 18 47 56

why not use MiB?

example/grafana/dashboard.json Outdated Show resolved Hide resolved
example/grafana/dashboard.json Outdated Show resolved Hide resolved
example/grafana/dashboard.json Outdated Show resolved Hide resolved
example/prometheus.yaml Outdated Show resolved Hide resolved
instance_name = "grafana"

[security]
admin_user = admin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to set these as environment variables in the docker-compose rather than a file to avoid making an example of insecure values

https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#override-configuration-with-environment-variables
GC_SECURITY_ADMIN_USER / _PASSWORD

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not overcomplicate it as this is just for example purposes and inside the scope of docker compose.

Copy link
Contributor

@anuraaga anuraaga Oct 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Especially if moving the files it's probably ok - though I don't know if it's particularly complicated using variables either :P

@M4tteoP
Copy link
Member

M4tteoP commented Jan 2, 2024

Reviews should be addressed, PTAL. I would love to merge an initial memory dashboard also for doing some comparisons about #252.

@jcchavezs jcchavezs enabled auto-merge (squash) January 5, 2024 12:07
@jcchavezs jcchavezs merged commit 51ef05a into main Jan 5, 2024
2 checks passed
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.

Create metrics dashboard to monitor consumption with envoy
4 participants