Manager info on Monitor `rest/manager` -> `rest-v2/manager` #5894

kevinrr888 · 2025-09-18T20:32:16Z

Manager info on the Monitor (displayed on homepage (/) and Manager page (/manager)) now obtains and displays info from the existing (but unused) rest-v2/manager endpoint.

Updated the homepage to display table data corresponding to the rest-v2/manager endpoint.
Updated the manager page to display table data corresponding to the rest-v2/manager endpoint.
Created new endpoint rest-v2/manager/metrics which returns the Manager metrics as json. This is linked in the Manager table in both the homepage and the manager page.
Server navigation bar now only considers the Manager status (as obtained from rest/status) (ERROR, WARN, OK). Previously took into account the manager state (e.g., if the state or goal state was SAFE_MODE or CLEAN_STOP), but this info was only included in the rest/manager endpoint.
Deleted the rest/manager endpoint and associated code used to gather data for this endpoint.
Deleted systemAlert.js and systemAlert.ftl as this alert was entirely based on Manager info included in rest/manager (manager state being SAFE_MODE or CLEAN_STOP). No longer applicable with rest-v2/manager.
Removed no longer applicable tables: badTServersTable and deadTServersTable from /tservers page.

closes #5882

Manager info on the Monitor (displayed on homepage (`/`) and Manager page (`/manager`)) now obtains and displays info from the existing (but unused) `rest-v2/manager` endpoint. * Updated the homepage to display table data corresponding to the `rest-v2/manager` endpoint. * Updated the manager page to display table data corresponding to the `rest-v2/manager` endpoint. * Created new endpoint `rest-v2/manager/metrics` which returns the Manager metrics as json. This is linked in the Manager table in both the homepage and the manager page. * Server navigation bar now only considers the Manager status (as obtained from `rest/status`) (ERROR, WARN, OK). Previously took into account the manager state (e.g., if the state or goal state was SAFE_MODE or CLEAN_STOP), but this info was only included in the `rest/manager` endpoint. * Deleted the `rest/manager` endpoint and associated code used to gather data for this endpoint. * Deleted `systemAlert.js` and `systemAlert.ftl` as this alert was entirely based on Manager info included in `rest/manager` (manager state being SAFE_MODE or CLEAN_STOP). No longer applicable with `rest-v2/manager`.

kevinrr888 · 2025-09-18T20:39:17Z

The following are images of some of the Monitor pages with these changes

Image of homepage with Manager up:

Image of Manager page with Manager up:

Image of new `rest-v2/manager/monitor` endpoint

Image of existing `rest-v2/manager` endpoint (no metrics)

Image of homepage with Manager down:

Image of Manager page with Manager down:

kevinrr888 · 2025-09-18T20:43:53Z

The following are images of some of the Monitor pages before these changes

Image of homepage with Manager up:

Image of Manager page with Manager up:

Image of `rest/manager` endpoint

Image of homepage with Manager down:

Image of Manager page with Manager down:

kevinrr888 · 2025-09-18T20:54:16Z

server/monitor/src/main/java/org/apache/accumulo/monitor/rest/SummaryInformation.java

 * @since 2.0.0
 */
 @XmlRootElement(name = "stats")
 public class SummaryInformation {


This class is used for summarizing Monitor info at /xml and /json. Maybe there's info in rest-v2/manager that we would want to include in the summary. For now, I just deleted all the rest/manager related data.

kevinrr888 · 2025-09-18T20:55:11Z

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/manager.js

+    // show the manager error banner and hide manager table
+    $('#managerRunningBanner').show();
+    $('#managerStatusTable').hide();
+  } else {
+    // otherwise, hide the error banner and show manager table
+    $('#managerRunningBanner').hide();
+    $('#managerStatusTable').show();
+  }


managerStatus_wrapper does not exist (preexisting bug). Fixed here

kevinrr888 · 2025-09-18T20:56:35Z

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/manager.js

-  getManager().then(function () {
-    const managerData = JSON.parse(sessionStorage.manager);
-    const managerState = managerData.managerState;
-    const managerGoalState = managerData.managerGoalState;
-
-    const isStateGoalSame = managerState === managerGoalState;
-
-    // if the manager state is normal and the goal state is the same as the current state,
-    // or of the manager is not running, hide the state banner and return early
-    if ((managerState === 'NORMAL' && isStateGoalSame) || managerState === null) {
-      $('#managerStateBanner').hide();
-      return;
-    }
-
-    // update the manager state banner message and show it
-    let bannerMessage = 'Manager state: ' + managerState;
-    if (!isStateGoalSame) {
-      // only show the goal state if it differs from the manager's current state
-      bannerMessage += '. Manager goal state: ' + managerGoalState;
-    }
-    $('#manager-banner-message').text(bannerMessage);
-    $('#managerStateBanner').show();
-  });


no longer applicable as the rest-v2/manager does not contain state of the manager.

Should we add Metrics for the Manager.ManagerState enum?

#5894 (comment) (only first part relevant)

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/functions.js

ddanielr · 2025-09-19T16:33:22Z

Ran locally. The manager pages worked but I could never get metric information to display at rest-v2/manager/metrics
It would just return a 200 code and []

ddanielr · 2025-09-19T16:36:13Z

Enabled auto-refresh and did get an error message

Uncaught ReferenceError: updateSystemAlerts is not defined
    at refreshNavBar (navbar.js:131:3)
    at functions.js:71:5

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/navbar.js

dlmarion · 2025-09-19T20:59:32Z

server/monitor/src/main/java/org/apache/accumulo/monitor/next/Endpoints.java

    return monitor.getInformationFetcher().getAllMetrics().asMap().get(s);
  }

+  @GET


The metrics are already returned as part of the MetricResponse json from the getManager call. Just wondering if we really need this, it seems duplicative.

I wrote this so we can easily link to just the "metrics" key of the "rest-v2/manager" json endpoint via an href:
<a href=\"rest-v2/manager/metrics\">Metrics</a>
Not sure of a way to easily do this without more custom javascript/html, and I think the extra Java code is more maintainable than more js/html

dlmarion · 2025-09-19T21:08:57Z

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/manager.js

-  getManager().then(function () {
-    const managerData = JSON.parse(sessionStorage.manager);
-    const managerState = managerData.managerState;
-    const managerGoalState = managerData.managerGoalState;
-
-    const isStateGoalSame = managerState === managerGoalState;
-
-    // if the manager state is normal and the goal state is the same as the current state,
-    // or of the manager is not running, hide the state banner and return early
-    if ((managerState === 'NORMAL' && isStateGoalSame) || managerState === null) {
-      $('#managerStateBanner').hide();
-      return;
-    }
-
-    // update the manager state banner message and show it
-    let bannerMessage = 'Manager state: ' + managerState;
-    if (!isStateGoalSame) {
-      // only show the goal state if it differs from the manager's current state
-      bannerMessage += '. Manager goal state: ' + managerGoalState;
-    }
-    $('#manager-banner-message').text(bannerMessage);
-    $('#managerStateBanner').show();
-  });


Should we add Metrics for the Manager.ManagerState enum?

dlmarion · 2025-09-19T21:09:46Z

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/manager.js

-  });
-
-  // Generates the recovery table
-  recoveryListTable = $('#recoveryList').DataTable({


Do we need to add metrics for recovery?

I'm not sure. I just made the front-end adhere to what is in the v2 endpoint. I don't know the history of why some things were removed from v1 to v2, but I assumed they were intentional.

Did you make this comment under the assumption I removed this code? This looks like a weird GitHub bug... This comment is showing that I deleted this code, but this has always been present in my commits. Very strange never seen something like this

- Fix error on using auto-refresh - Move REST_V2_PREFIX to top of script

kevinrr888 · 2025-10-07T17:18:59Z

Ran locally. The manager pages worked but I could never get metric information to display at rest-v2/manager/metrics
It would just return a 200 code and []

Metrics aren't configured to emit by default. Can view the pictures I posted above for an idea, or configure accumulo to gather metrics.

DomGarguilo · 2025-10-15T18:41:31Z

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/manager.js

 function refreshManagerTables() {
-  ajaxReloadTable(managerStatusTable);
  refreshManagerBanners();
+  if (managerStatus !== 'ERROR') {
+    ajaxReloadTable(managerStatusTable);
+  }
  ajaxReloadTable(recoveryListTable);
 }


There are some things we need to fix here I think. If the manager process is killed after the page loads, the table still tries to refresh since we do not update the managerStatus variable. Also the table will never update properly for the same reason.

I think to fix this we could refactor out the creation logic for the managerStatusTable so we can call it in the $() function (where the table is created now) as well as in the refreshManagerTables function after we refresh managerStatus by calling getStatus() again and updating managerStatus by parsing the session storage again.

Good find!
fixed in d1c8630 for both the homepage and manager page

I think I did a bad job of explaining the two issues I saw. You fixed the status update one. But the other issue still exists.

If the manager page is loaded while the manager is down, the datatable will never be initialized even if the manager comes back up. I think to fix this we can refactor the creation of the managerStatusTable into a new method and conditionally call that on page load (when the status of the manager is not ERROR. And also call it in the refreshManagerTables() when the managerStatusTable is undefined (which means has never been initialized in the main run method) AND the status is not ERROR. That way, if we load the manager page while the manager is down, once the manager comes back up, the auto refresh should properly initialize the datatable.

server/monitor/src/main/java/org/apache/accumulo/monitor/next/Endpoints.java

Did not properly auto-refresh "/manager" and "/" pages when the manager was killed after the page was already loaded

kevinrr888 added this to the 4.0.0 milestone Sep 18, 2025

kevinrr888 self-assigned this Sep 18, 2025

removed unused declared dependency

ceeab75

kevinrr888 commented Sep 18, 2025

View reviewed changes

ddanielr reviewed Sep 19, 2025

View reviewed changes

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/functions.js Show resolved Hide resolved

ddanielr reviewed Sep 19, 2025

View reviewed changes

server/monitor/src/main/resources/org/apache/accumulo/monitor/resources/js/navbar.js Show resolved Hide resolved

dlmarion reviewed Sep 19, 2025

View reviewed changes

Minor fixes:

3419635

- Fix error on using auto-refresh - Move REST_V2_PREFIX to top of script

DomGarguilo requested changes Oct 15, 2025

View reviewed changes

DomGarguilo reviewed Oct 15, 2025

View reviewed changes

server/monitor/src/main/java/org/apache/accumulo/monitor/next/Endpoints.java Outdated Show resolved Hide resolved

kevinrr888 added 2 commits October 16, 2025 15:57

fixes issue with auto-refresh:

d1c8630

Did not properly auto-refresh "/manager" and "/" pages when the manager was killed after the page was already loaded

trivial: avoid repeated call

331c9d2

Manager info on Monitor rest/manager -> rest-v2/manager #5894

Are you sure you want to change the base?

Manager info on Monitor rest/manager -> rest-v2/manager #5894

Uh oh!

Conversation

kevinrr888 commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevinrr888 commented Sep 18, 2025

The following are images of some of the Monitor pages with these changes

Image of homepage with Manager up:

Image of Manager page with Manager up:

Image of new rest-v2/manager/monitor endpoint

Image of existing rest-v2/manager endpoint (no metrics)

Image of homepage with Manager down:

Image of Manager page with Manager down:

Uh oh!

kevinrr888 commented Sep 18, 2025

The following are images of some of the Monitor pages before these changes

Image of homepage with Manager up:

Image of Manager page with Manager up:

Image of rest/manager endpoint

Image of homepage with Manager down:

Image of Manager page with Manager down:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ddanielr commented Sep 19, 2025

Uh oh!

ddanielr commented Sep 19, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevinrr888 commented Oct 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Manager info on Monitor `rest/manager` -> `rest-v2/manager` #5894

Manager info on Monitor `rest/manager` -> `rest-v2/manager` #5894

kevinrr888 commented Sep 18, 2025 •

edited

Loading

Image of new `rest-v2/manager/monitor` endpoint

Image of existing `rest-v2/manager` endpoint (no metrics)

Image of `rest/manager` endpoint