Manager info on Monitor `rest/manager` -> `rest-v2/manager` by kevinrr888 · Pull Request #5894 · apache/accumulo

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:56:35Z

-  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)

Added metrics for Manager goal state in #6080

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

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

-  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

-  });
-
-  // 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

Added recovery metrics in #6081

- 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.

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

Handles a couple edge cases for /manager endpoint: - If manager is dead on first loading the page (in this case, no manager table is created), but later comes online and we are using the auto-refresh feature, previously would never create the manager table. auto-refresh will now create the table if it does not yet exist. - There was a case where /manager could result in a DataTables alert/error. If the manager was up but the endpoint used to get the table data was not yet available (small window where this could occur), a DataTables alert would occur. Handle this instead as a console log and populate the table with no data.

kevinrr888 · 2025-11-19T18:03:09Z

+    "ajax": function (data, callback, settings) {
+      $.ajax({
+        url: contextPath + 'rest-v2/manager',
+        method: 'GET'
+      }).done(function (json) {
+        callback({
+          "data": [json]
+        });
+      }).fail(function (jqXHR, textStatus, errorThrown) {
+        // This is needed if the url is not yet available, but the manager is up. E.g., Short
+        // window where a 404 could occur, which would lead to DataTables error/alert w/out fail()
+        console.error("DataTables Ajax error :", errorThrown);
+        callback({
+          "data": []
+        });
+      });
+    },


Differs from original impl to handle edge case described in #5894 (comment)

DomGarguilo

LGTM. I'll create some follow on tickets to re-enable the manager goal state and recovery features.

kevinrr888 · 2026-02-02T14:19:41Z

@dlmarion do you have any more comments/concerns? Otherwise, I'll merge this in

dlmarion · 2026-02-02T16:01:03Z

@dlmarion do you have any more comments/concerns? Otherwise, I'll merge this in

No issue with you merging this. @DomGarguilo captured the follow-ons.

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

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

ddanielr reviewed Sep 19, 2025

View reviewed changes

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

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

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

DomGarguilo reviewed Oct 15, 2025

View reviewed changes

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

kevinrr888 added 3 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

kevinrr888 commented Nov 19, 2025

View reviewed changes

DomGarguilo approved these changes Jan 30, 2026

View reviewed changes

This was referenced Jan 30, 2026

4.0 Monitor - re-enable manager goal state info #6105

Closed

4.0 Monitor - re-enable recovery information in monitor #6106

Open

kevinrr888 merged commit 480c88a into apache:main Feb 2, 2026
8 checks passed

kevinrr888 deleted the 4.0-feature-5882 branch February 2, 2026 16:27

kevinrr888 mentioned this pull request Feb 2, 2026

Update monitor summary #6108

Open

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!

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!

Uh oh!

ddanielr commented Sep 19, 2025

Uh oh!

ddanielr commented Sep 19, 2025

Uh oh!

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!

kevinrr888 commented Oct 7, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DomGarguilo left a comment

Choose a reason for hiding this comment

Uh oh!

kevinrr888 commented Feb 2, 2026

Uh oh!

dlmarion commented Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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