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

Mixin: Add Query Frontend grafana dashboard #4856

Merged
merged 7 commits into from
Nov 12, 2021

Conversation

jessicalins
Copy link
Contributor

  • I added CHANGELOG entry for this change.
  • Change is not relevant to the end user.

Changes

Hey! 👋
I've added a grafana dashboard for the Query Frontend component. I used the Query/Store dashboards as base.
Here is a screenshot of how it currently looks like:

query_frontend_dashboard

I'm not sure if all metrics that are interesting are represented in the dashboard, but I've tried to add some basic ones (RED metrics/caching/resources)

Verification

I've ran make examples to generate the query_frontend.json file and I've imported it to Grafana to get an idea how it looks like.

@@ -28,6 +28,10 @@
selector: 'job=~".*thanos-query.*"',
title: '%(prefix)sQuery' % $.dashboard.prefix,
},
query_frontend+:: {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I saw that we would like to fix the naming convention to e.g. queryFrontend (this TODO: https://github.com/thanos-io/thanos/blob/main/mixin/config.libsonnet#L52)
I've tried at first to use it like that, but when running make examples and when it tries to generate the json file, I get:

/home/jessica/go/bin/jsonnet-v0.17.0 -J mixin/vendor -m examples/dashboards mixin/dashboards.jsonnet
RUNTIME ERROR: Field does not exist: query_frontend

Does someone have an idea of what it could be?

Copy link
Member

Choose a reason for hiding this comment

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

I was able to replicate this error by changing everything to queryFrontend except the query_frontend.json in this line. Once changed to queryFrontend.json, make examples runs successfully!

I think this is due to how examples are generated by dashboards.jsonnet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, that solved the problem!
since I'm already touching those files, should I also update https://github.com/thanos-io/thanos/blob/main/mixin/config.libsonnet#L52 to this convention in this PR? or better in another one?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it would be better to do the update in a separate PR! 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, added here: #4859

Jéssica Lins added 6 commits November 12, 2021 10:15
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Signed-off-by: Jéssica Lins <jlins@redhat.com>
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

Amazing work!

Let's merge and iterate, looks good! Thanks 💪🏽

@bwplotka bwplotka merged commit b1c7483 into thanos-io:main Nov 12, 2021
@jessicalins jessicalins deleted the add-query-fe-dashboard branch November 12, 2021 15:35
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.

3 participants