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.

Sign up for GitHub

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

Jump to bottom

mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled #38473

Merged
merged 1 commit into from Dec 17, 2020
Merged

mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled #38473

merged 1 commit into from Dec 17, 2020

Conversation

votdev
Copy link
Member

@votdev votdev commented Dec 7, 2020 •
edited

Set a health check warning if debug mode is enabled.

health_check

Fixes: https://tracker.ceph.com/issues/48475

Signed-off-by: Volker Theile vtheile@suse.com

Checklist

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox

@votdev votdev requested a review from a team as a code owner December 7, 2020 13:01
@votdev votdev requested review from s0nea, prokopto-dev and aaSharma14 and removed request for a team December 7, 2020 13:01
@github-actions github-actions bot added the pybind label Dec 7, 2020
@votdev votdev added feature and removed pybind labels Dec 7, 2020
@votdev votdev added this to In progress in Dashboard via automation Dec 7, 2020
@votdev votdev moved this from In progress to Review in progress in Dashboard Dec 7, 2020
@votdev votdev requested a review from epuertat December 7, 2020 13:01
@github-actions github-actions bot added the pybind label Dec 7, 2020
s0nea
s0nea reviewed Dec 8, 2020
View reviewed changes
Copy link
Member

@s0nea s0nea left a comment

Choose a reason for hiding this comment

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

Hey @votdev ,

I just tested your PR and it works perfectly but I noticed one thing:

When I create a new vstart cluster the debug flag for the dashboard is already enabled. Unfortunately the ceph -s command doesn't show the warning. It only shows the warning if I disable and enable the dasboard debug (by ceph dashboard debug disable/enable). Is it on purpose?

@votdev
Copy link
Member Author

votdev commented Dec 8, 2020 •
edited

Hey @votdev ,

I just tested your PR and it works perfectly but I noticed one thing:

When I create a new vstart cluster the debug flag for the dashboard is already enabled. Unfortunately the ceph -s command doesn't show the warning. It only shows the warning if I disable and enable the dasboard debug (by ceph dashboard debug disable/enable). Is it on purpose?

I wondering that this happens because the debug plugin is initialized at module startup and should trigger the health warning immediately. Maybe it is because how Dashboard is activated in a vstart environment (using the --force parameter).

To answer your question, it shouldn't behave like that.

@votdev
Copy link
Member Author

votdev commented Dec 8, 2020 •
edited

Hey @votdev ,

I just tested your PR and it works perfectly but I noticed one thing:

When I create a new vstart cluster the debug flag for the dashboard is already enabled. Unfortunately the ceph -s command doesn't show the warning. It only shows the warning if I disable and enable the dasboard debug (by ceph dashboard debug disable/enable). Is it on purpose?

OK, i investigated that and found out, that our downstream scripts enable debugging using ceph config set mgr mgr/dashboard/debug true after the Mgr module (incl. Dashboard) has been started. This means, when the Dashboard module is started, debugging is disabled and it is enabled afterwards using the configuration and not ceph dashboard debug enable.

@votdev votdev changed the title mgr/dashboard: Display a warning message in Dashboard when debugging is enabled [WIP] mgr/dashboard: Display a warning message in Dashboard when debugging is enabled Dec 8, 2020
@votdev votdev changed the title [WIP] mgr/dashboard: Display a warning message in Dashboard when debugging is enabled mgr/dashboard: Display a warning message in Dashboard when debugging is enabled Dec 8, 2020
@s0nea
Copy link
Member

s0nea commented Dec 8, 2020

jenkins test dashboard

1 similar comment
@callithea
Copy link
Member

jenkins test dashboard

@votdev votdev force-pushed the issue_48474_health_check branch 2 times, most recently from 5c8f746 to 946d9ea Compare December 9, 2020 12:42
@votdev
Copy link
Member Author

votdev commented Dec 9, 2020

jenkins test make check

1 similar comment
@nizamial09
Copy link
Member

jenkins test make check

Dashboard automation moved this from Review in progress to Reviewer approved Dec 15, 2020
s0nea
s0nea approved these changes Dec 15, 2020
View reviewed changes
Copy link
Member

@s0nea s0nea left a comment

Choose a reason for hiding this comment

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

LGTM 👍

epuertat
epuertat approved these changes Dec 15, 2020
View reviewed changes
Copy link
Member

@epuertat epuertat left a comment

Choose a reason for hiding this comment

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

Nice improvement! Thank you @votdev! I wasn't aware of how easy was to report health checks.

Does it make sense to document this new heath check in https://docs.ceph.com/en/latest/rados/operations/health-checks/, or mgr modules health checks are not documented anywhere? Perhaps @zdover23 can shed light on this.

src/pybind/mgr/dashboard/plugins/debug.py Outdated Show resolved Hide resolved
@votdev votdev changed the title mgr/dashboard: Display a warning message in Dashboard when debugging is enabled mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled Dec 16, 2020
@callithea
Copy link
Member

callithea commented Dec 16, 2020 •
edited

@votdev
mgr/dashboard: Display a warning message in Dashboard when debug mode…
a1aa760 
… is enabled

Set a health check warning if debug mode is enabled.

Fixes: https://tracker.ceph.com/issues/48475

Signed-off-by: Volker Theile <vtheile@suse.com>
@votdev
Copy link
Member Author

votdev commented Dec 16, 2020

Added documentation to health-check.rst.

@callithea
Copy link
Member

jenkins test dashboard

callithea
callithea approved these changes Dec 16, 2020
View reviewed changes
Copy link
Member

@callithea callithea left a comment

Choose a reason for hiding this comment

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

Lgtm

@callithea callithea moved this from Reviewer approved to Ready-to-merge in Dashboard Dec 16, 2020
@epuertat epuertat merged commit 65b11e9 into ceph:master Dec 17, 2020
Dashboard automation moved this from Ready-to-merge to Done Dec 17, 2020
@votdev votdev deleted the issue_48474_health_check branch January 5, 2021 13:29
This was referenced Jan 7, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@s0nea s0nea s0nea approved these changes

@callithea callithea callithea approved these changes

@epuertat epuertat epuertat approved these changes

@prokopto-dev prokopto-dev Awaiting requested review from prokopto-dev

@aaSharma14 aaSharma14 Awaiting requested review from aaSharma14

Assignees
No one assigned
Labels
core dashboard documentation feature pybind TESTED
Projects
Ceph-Dashboard
Archived in project
Dashboard
  
Done
Milestone
No milestone
5 participants
@votdev @s0nea @callithea @nizamial09 @epuertat