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

Clarify DEAD partition state in Grafana dashboard #10046

Merged
merged 2 commits into from
Aug 16, 2022

Conversation

korthout
Copy link
Member

@korthout korthout commented Aug 9, 2022

Description

As an incident follow-up, this clarifies the DEAD partition health state in the Grafana Zeebe Overview dashboard.

Related issues

closes #10043

Definition of Done

Not all items need to be done depending on the issue and the pull request.

Code changes:

  • The changes are backwards compatibility with previous versions
  • If it fixes a bug then PRs are created to backport the fix to the last two minor versions. You can trigger a backport by assigning labels (e.g. backport stable/1.3) to the PR, in case that fails you need to create backports manually.

Testing:

  • There are unit/integration tests that verify all acceptance criterias of the issue
  • New tests are written to ensure backwards compatibility with further versions
  • The behavior is tested manually
  • The change has been verified by a QA run
  • The impact of the changes is verified by a benchmark

Documentation:

  • The documentation is updated (e.g. BPMN reference, configuration, examples, get-started guides, etc.)
  • New content is added to the release announcement
  • If the PR changes how BPMN processes are validated (e.g. support new BPMN element) then the Camunda modeling team should be informed to adjust the BPMN linting.

Please refer to our review guidelines.

A partition can either be HEALTHY, UNHEALTHY or DEAD. However, we never
had any way to show this in the partition health overview.

This adds an additional field override for health -1 -> DEAD with the
red color. To differentiate it from UNHEALTHY, I've also changed the
color of UNHEALTHY to orange.
The README is a great source to test the Grafana dashboard locally. But
I struggled a bit with finding how to login. This clarifies it a bit.
@korthout
Copy link
Member Author

korthout commented Aug 9, 2022

@ Reviewer, when I exported the dashboard a lot of unnecessary changes came along with it. I've extracted those to d36e3ef. Please let me know if you think those should be part of this PR as well. I'll keep the PR in draft mode until this is cleared up.

@korthout korthout requested a review from Zelldon August 9, 2022 12:57
@github-actions
Copy link
Contributor

github-actions bot commented Aug 9, 2022

Test Results

   843 files  ±  0     843 suites  ±0   1h 39m 55s ⏱️ + 4m 43s
6 399 tests  - 58  6 388 ✔️  - 58  11 💤 ±0  0 ±0 
6 583 runs   - 58  6 572 ✔️  - 58  11 💤 ±0  0 ±0 

Results for commit a41f465. ± Comparison against base commit 17630e8.

♻️ This comment has been updated with latest results.

Copy link
Member

@Zelldon Zelldon left a comment

Choose a reason for hiding this comment

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

I guess you exported the dashboard via the locally testing? Please make sure to change the dashboard here http://34.77.165.228/d/NzsO1mUnk/zeebe-overview?orgId=1&refresh=10s and export that to the repo. This is how we normally do it, then the version and other properties should be ok.

monitor/grafana/zeebe-overview.json Outdated Show resolved Hide resolved
monitor/grafana/zeebe-overview.json Outdated Show resolved Hide resolved
@@ -16,7 +16,7 @@ file](../docker/compose/docker-compose.yaml) in combination with the one [here](
docker-compose --project-directory ./ -f docker-compose.yml -f ../docker/compose/docker-compose.yaml up -d
```

This will start the usual 3 brokers cluster, as well as a Grafana instance (on port 3000) and a Prometheus instance on
This will start the usual 3 brokers cluster, as well as a Grafana [instance](http://localhost:3000/) (on port 3000; login: u `admin`, p `camunda`) and a Prometheus instance on
Copy link
Member

Choose a reason for hiding this comment

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

😆 wasn't aware of this "testing guide"

@korthout korthout force-pushed the korthout-10043-grafana-dead-state branch from d36e3ef to a41f465 Compare August 16, 2022 09:19
@korthout korthout marked this pull request as ready for review August 16, 2022 09:19
@korthout korthout requested a review from Zelldon August 16, 2022 09:19
Copy link
Member

@Zelldon Zelldon left a comment

Choose a reason for hiding this comment

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

Thanks @korthout 🚀

@korthout
Copy link
Member Author

bors merge

@zeebe-bors-camunda
Copy link
Contributor

Build succeeded:

@zeebe-bors-camunda zeebe-bors-camunda bot merged commit d8ea670 into main Aug 16, 2022
@zeebe-bors-camunda zeebe-bors-camunda bot deleted the korthout-10043-grafana-dead-state branch August 16, 2022 11:49
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.

Clarify DEAD state in Grafana dashboard
2 participants