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

Grafana Dashboards: Fix Query Errors and Improve Instance Filtering in Erlang Distribution and BEAM Dashboards #12720

Merged

Conversation

anhanhnguyen
Copy link
Contributor

Proposed Changes

Hi,

During the testing with Grafana 11.3.0 and RabbitMQ 3.13.7, deployed on Kubernetes, we noticed several issues with the Erlang Distribution and Erlang BEAM dashboards.

Erlang Distribution dashboard:

  • The "State of distribution links" panel on the Erlang Distribution dashboard was failing due to a query error caused by duplicate series in the match group, resulting in many-to-many matching conflicts.
    Screenshot_14-11-2024_142747_a4076d80e635246b6a27df68356a7971-1747288694 eu-central-1 elb amazonaws com
    Screenshot_14-11-2024_151510_a4076d80e635246b6a27df68356a7971-1747288694 eu-central-1 elb amazonaws

  • The "Process state" panel was unable to display correctly due to the flant status map being deprecated.
    Screenshot_14-11-2024_142845_a4076d80e635246b6a27df68356a7971-1747288694 eu-central-1 elb amazonaws com

Erlang-BEAM dashboard:

  • Data was unable to be retrieved due to the missing DS_Prometheus variable, which was not defined as a datasource.
    Screenshot_14-11-2024_142926_a4076d80e635246b6a27df68356a7971-1747288694 eu-central-1 elb amazonaws

  • The "Erlang VM Run Queue Length" panel displayed data for all nodes in the cluster rather than filtering to show data only for the selected node.
    Screenshot_14-11-2024_1755_3 70 218 181

Changes:

  • Updated the Erlang Distribution dashboard to refine instance filtering, preventing many-to-many matching errors.
  • Replaced the deprecated flant status map of "Process state" panel to status map.
  • On the Erlang-BEAM dashboard, defined the DS_Prometheus variable as a datasource to ensure accurate data retrieval.
  • Enhanced the "Erlang VM Run Queue Length" panel to filter data by the currently selected node.

Types of Changes

What types of changes does your code introduce to this project?
Put an x in the boxes that apply

  • Bug fix (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause an observable behavior change in existing systems)
  • Documentation improvements (corrections, new content, etc)
  • Cosmetic change (whitespace, formatting, etc)
  • Build system and/or CI

Checklist

Put an x in the boxes that apply.
You can also fill these out after creating the PR.
If you're unsure about any of them, don't hesitate to ask on the mailing list.
We're here to help!
This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING.md document
  • I have signed the CA (see https://cla.pivotal.io/sign/rabbitmq)
  • I have added tests that prove my fix is effective or that my feature works
  • All tests pass locally with my changes
  • If relevant, I have added necessary documentation to https://github.com/rabbitmq/rabbitmq-website
  • If relevant, I have added this change to the first version(s) in release-notes that I expect to introduce it

Further Comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution
you did and what alternatives you considered, etc.

- Updated metric expressions to include instance filtering with {instance=\"$node\"}
  for the following metrics:
  - erlang_vm_statistics_run_queues_length
  - erlang_vm_statistics_dirty_io_run_queue_length
  - erlang_vm_statistics_dirty_cpu_run_queue_length
- Added 'DS_PROMETHEUS' as a templated data source variable
- Modified metric expression and legend format in State of distribution links
- Changed panel type from 'flant-statusmap-panel' to 'status-history' for Process state
Copy link
Member

@michaelklishin michaelklishin left a comment

Choose a reason for hiding this comment

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

The changes only affect the dashboards, re-submitting for a full CI run is not necessary.

@michaelklishin michaelklishin merged commit 79f7128 into rabbitmq:main Nov 14, 2024
263 of 267 checks passed
michaelklishin added a commit that referenced this pull request Nov 14, 2024
Grafana Dashboards: Fix Query Errors and Improve Instance Filtering in Erlang Distribution and BEAM Dashboards (backport #12720)
@michaelklishin michaelklishin added this to the 4.1.0 milestone Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants