SOLR-18161: improve node system response by igiguere · Pull Request #4240 · apache/solr

igiguere · 2026-03-25T21:16:04Z

https://issues.apache.org/jira/browse/SOLR-18161

Description

The existing v2 /api/node/system endpoint returns fields (host, node, jvm, lucene, etc.) at the top level of the response alongside the header. This is a bit inconsistent with other APIs and doesn't extrapolate well to multi-node responses.

Solution

Two changes to the v2 endpoint:

Wrap response fields in nodeInfo - All system info fields are moved into a nodeInfo sub-object in the response, separating them from the top-level responseHeader. (v2 API only)
Add a path parameter for more selective data fetching - new GET /api/node/system/{requestedInfo} allows callers to fetch only the data they care about (lucene, jvm, gpu, security) rather than the full payload every time.

(Much of this was previously proposed in #4078 but was extracted here for review purposes.)

Tests

Unit tests added or adapted for the wrapped response and the path parameter.

Functional test on "devSlim", running with the "cloud" example.

Checklist

Please review the following and check all that apply:

I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
I have created a Jira issue and added the issue ID to my pull request title.
I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
I have developed this patch against the main branch.
I have run ./gradlew check.
I have added tests for my changes.
I have added documentation for the Reference Guide
I have added a changelog entry for my change

Add NodeSystemIfoApi (notice the lower-case last chars), to (eventually) replace Endpoint NodeSystemIfoAPI. Lo warning about deprecation. Add GetNodeSystemInfo, move the info-gathering logic to a separate class NodeSystemInfoProvider, adjust SystemInfoHandler. Known Issue: NodeSystemInfoResponse does not support responses from multiple nodes. More testing and clean-up to do.

Fix NodeSystemResponse to contain a map of node name to node info. Fix responses for Json and XML. TODO : nodes=all is ignored

Clean-up unused imports

forgot those in the previous commit

Fix log calls. Add unit tests for HTTP call.

Remove the Map from NodeSystemInfoResponse: the AdminHandlersProxy wraps all nodes responses into a map, it should not belong to the response class.

Replace the Map wrapper by just a single object wrapper: NodeSystemInfo. It provides some separation between the response header and the actual node info.

Ensure back-compatible response from V1 path (and from old V2 path)

Add method getSpecificNodeSystemInfo, with path parameter, to get only selected info. Add query param "nodes": not used, because AdminHandlersProxy does not support V2 yet.

Merge remote-tracking branch 'origin-solr/main' into NodeSystemInfoApi-JerseyResource

Commented-out for now. Revert to class name NodeSystemResponse

Split core info response into a different model class. Place the getCoreInfo method in the utility class, to re-use in back-compatible /admin/info/system response. Rename a few classes Adjust documentation

…guere/solr.git into NodeSystemInfoApi-JerseyResource

using the PR rather that the mixed-up Jira ticket

Wrap node info into "nodeInfo" field, to separate from the response headers. Add a method to get specific node info (gpu, lucence, jvm,...) Other modifications as previously discussed on PR apache#4078 Relevant unit tests pass, functional test and gradlew check to do...

gradlew tidy gradlew clean check one unrelated unit test (JWT) failing

changelog!

HoustonPutman · 2026-03-26T23:19:03Z

This still uses the same security to protect secrets in SysProps right? And envVars are not exposed?

igiguere · 2026-03-27T15:10:27Z

This still uses the same security to protect secrets in SysProps right? And envVars are not exposed?

There is no change in functionality with regards to system properties and environment variables. This PR adds features that were left out of PR #4078, itself entirely based on pre-exisiting logic.

The method SystemInfoProvider.getInputArgumentsRedacted(NodeConfig, RuntimeMXBean) is exactly the same as in the patch in https://issues.apache.org/jira/browse/SOLR-16809. The method was just moved to a new class (as part of PR #4078).
SystemInfoProvider will output redacted properties according to the hiddenSysProps parameter.

improve changelog title

Merge remote-tracking branch 'origin-solr/main' into SOLR-18161-improve-node-system-response Fixed Conflicts: solr/api/src/java/org/apache/solr/client/api/model/NodeSystemResponse.java

...tidy!...

gerlowskija · 2026-06-11T01:16:22Z

Hey @igiguere - going through to review this now; sorry for the delay.

After the long time away I had a bit of trouble remembering the full context here. These time gaps tend to be more common than you'd think (or want), so giving lots of detail in the PR description is a great lifeline for both returning reviewers and folks that are new altogether.

I took the liberty of updating your PR writeup above with some context; might be a nice example to try to shoot for in subsequent PRs. (If I've gotten anything wrong in that revised writeup, lmk!)

gerlowskija · 2026-06-11T00:22:11Z

 androidx-lifecycle-runtimeCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-runtime-compose", version.ref = "androidx-lifecycle" }
-androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 androidx-lifecycle-viewModelNav3 = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "androidx-lifecycle" }
+androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }


Hmm, wonder why this changed 🤔

Oh well 🤷

gerlowskija · 2026-06-11T10:22:58Z

@@ -0,0 +1,8 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Improve /node/system response with a wrapper to separate the system info from the response header, and add a method to return only selected info


Suggested change

title: Improve /node/system response with a wrapper to separate the system info from the response header, and add a method to return only selected info

title: Added new `/api/node/system` sub APIs to fetch specific subsets of the normal `/api/node/system` response. e.g. `/api/node/system/jvm`

The new API endpoints are the most relevant bit to a user, so might be better to focus mainly on those in the changelog entry.

gerlowskija · 2026-06-11T10:25:00Z

+  - name: Isabelle Giguère
+links:
+  - name: SOLR-18161
+    url: https://issues.apache.org/jira/browse/SOLR-18161


Suggested change

url: https://issues.apache.org/jira/browse/SOLR-18161

url: https://issues.apache.org/jira/browse/SOLR-18161

- name: Github PR

url: https://github.com/apache/solr/pull/4240

Not sure I got the indentation on that quite right in Github, but hopefully you get the idea.

gerlowskija · 2026-06-11T10:32:00Z

+      })
+  @Path("/{requestedInfo}")
+  NodeSystemResponse getSpecificNodeSystemInfo(
+      @PathParam(value = "requestedInfo") String requestedInfo,


[0] I wonder if we could change this from a "String" to some type of enum so that Jersey would do the value-checking for us...

Turns out we can! This "just kindof worked" when I tried switching it over. I've pushed the changes to your branch - if you don't like the change just lmk and I'm happy to roll it back.

There are a bunch of other places (mostly marked by TODOs in the api/ module) where I've thought about using an enum in these API definitions but didn't quite have time to check if that'd work. Should tackle these in a follow-on PR....

gerlowskija · 2026-06-11T10:38:59Z

+
+  @Test
+  public void testGetSpecificNodeInfo() throws Exception {
+    final var req = new SystemApi.GetSpecificNodeSystemInfo("lucene");


[+1] Love to see the generated SolrJ class getting used here - 🎉

gerlowskija · 2026-06-11T10:40:52Z

+    assertEquals(0, infoRsp.responseHeader.status);
+    assertNotNull(infoRsp.nodeInfo.lucene);
+    assertEquals(Version.LATEST.toString(), infoRsp.nodeInfo.lucene.luceneSpecVersion);
+    assertNull(infoRsp.nodeInfo.jvm);


[0] From an OAS or API documentation perspective, it might be nice at some point to have separate methods and response classes for (e.g.) /api/node/system/lucene so that the response object doesn't even have fields for things that'll never be set like .nodeInfo.gpu.

But I'm happy to punt that down the road unless you think it's worth tackling here?

gerlowskija · 2026-06-11T10:44:11Z

 == Response

+
+== Node Information Object


[-0] Documenting this is kindof tricky, since the "nodeInfo" object exists for v2 responses, but not v1 responses. Maybe it's worth putting a sentence right under this header indicating that this sub-object is only present in the v2 API response, with fields being present on the top level response in the v1 case.

gerlowskija · 2026-06-11T10:45:41Z

 ----
+
+
+=== Retrieve specific system information.


[+1] Excellent, thanks!

gerlowskija · 2026-06-11T10:48:45Z


    return result;
  }
+


[Q/-0] Hmm, can you explain why this is here? At a glance it doesn't seem related to the rest of the PR but maybe I'm forgetting some context.

Jersey now validates the "sub-resource" requested and returns a 404 if it's not one of the expected values ('jvm', 'lucene', 'gpu', etc).

gerlowskija · 2026-06-11T11:37:19Z

Hey @igiguere - I've left a few review comments. The only real hold up at this point is a question I left on the JacksonDataBind changes - I don't quite understand their relation to this change and could use a bit more context there.

Once you're able to chime in there I can proceed with getting this merged. Thanks again for the contribution!

Isabelle Giguere and others added 30 commits January 15, 2026 10:17

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

7232819

SOLR-16397: Replace V2 Endpoint for system info by JerseyResource impl

af9757a

Fix NodeSystemResponse to contain a map of node name to node info. Fix responses for Json and XML. TODO : nodes=all is ignored

SOLR-16397: V2 Node systme info - clean up

9654a32

Clean-up unused imports

SOLR-16397: files changed by tidy

fdfab36

forgot those in the previous commit

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

b18283a

SOLR-16458: System Info V2 API

b3dd6c7

Fix log calls. Add unit tests for HTTP call.

SOLR-16458: Node system info V2 Jersey resource

2b7aba0

Remove the Map from NodeSystemInfoResponse: the AdminHandlersProxy wraps all nodes responses into a map, it should not belong to the response class.

SOLR-16458: Node System V2 jersey resource

3257bb7

Replace the Map wrapper by just a single object wrapper: NodeSystemInfo. It provides some separation between the response header and the actual node info.

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

90a9e48

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

d971626

SOLR-16458: NodeSystemInfoApi JerseyResource review comments

65d7479

Ensure back-compatible response from V1 path (and from old V2 path)

SOLR-16458: NodeSystemInfoApi JerseyResource - path param

d7b8638

Add method getSpecificNodeSystemInfo, with path parameter, to get only selected info. Add query param "nodes": not used, because AdminHandlersProxy does not support V2 yet.

SOLR-16458: resolve conflict and sync with main

bf95c1f

Merge remote-tracking branch 'origin-solr/main' into NodeSystemInfoApi-JerseyResource

SOLR-16458: fix merge conflicts

f1c7fc5

Merge remote-tracking branch 'origin-solr/main' into NodeSystemInfoApi-JerseyResource

SOLR-16458: fix bad merge, adjust documentation

3976986

SOLR-16458: gradlew tidy

b394dd1

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

47afaee

SOLR-16458: remove Core info from System info

f096b9a

Commented-out for now. Revert to class name NodeSystemResponse

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

9271e65

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

311fa15

SOLR-16458: Node System Info V2 Jersey resource

a289705

Split core info response into a different model class. Place the getCoreInfo method in the utility class, to re-use in back-compatible /admin/info/system response. Rename a few classes Adjust documentation

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

5ad3c25

Merge branch 'NodeSystemInfoApi-JerseyResource' of git@github.com:igi…

2424e29

…guere/solr.git into NodeSystemInfoApi-JerseyResource

SOLR-16458: add changelog entry

5638540

using the PR rather that the mixed-up Jira ticket

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

ffcd838

Merge branch 'apache:main' into NodeSystemInfoApi-JerseyResource

7511cfd

fix local conflicts

9cfef86

SOLR-18131: improve system info response

314c521

gradlew tidy gradlew clean check one unrelated unit test (JWT) failing

SOLR-18161: improve system info response

dcf1125

changelog!

github-actions Bot added documentation Improvements or additions to documentation client:solrj tests cat:api cat:packagemanager labels Mar 25, 2026

dsmiley reviewed Mar 27, 2026

View reviewed changes

Comment thread changelog/unreleased/SOLR-18161-improve-system-info-response.yml Outdated

Isabelle Giguere and others added 5 commits March 27, 2026 11:12

SOLR-18161: improve /node/system response

5749033

improve changelog title

Merge branch 'apache:main' into SOLR-18161-improve-node-system-response

e973759

Merge branch 'apache:main' into SOLR-18161-improve-node-system-response

6aedc78

SOLR-18161: improve node system response

94452e7

Merge remote-tracking branch 'origin-solr/main' into SOLR-18161-improve-node-system-response Fixed Conflicts: solr/api/src/java/org/apache/solr/client/api/model/NodeSystemResponse.java

SOLR-18161: improve node system response

9502aad

...tidy!...

github-actions Bot added dependencies Dependency upgrades tool:build labels May 9, 2026

gerlowskija reviewed Jun 11, 2026

View reviewed changes

Merge branch 'main' into SOLR-18161-improve-node-system-response

3055e1d

github-actions Bot removed dependencies Dependency upgrades tool:build labels Jun 11, 2026

Replace string with enum in sub-response method

dd027eb

Jersey now validates the "sub-resource" requested and returns a 404 if it's not one of the expected values ('jvm', 'lucene', 'gpu', etc).

		@@ -0,0 +1,8 @@
		# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
		title: Improve /node/system response with a wrapper to separate the system info from the response header, and add a method to return only selected info

	title: Improve /node/system response with a wrapper to separate the system info from the response header, and add a method to return only selected info
	title: Added new `/api/node/system` sub APIs to fetch specific subsets of the normal `/api/node/system` response. e.g. `/api/node/system/jvm`

Conversation

igiguere commented Mar 25, 2026 • edited by gerlowskija Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Solution

Tests

Checklist

Uh oh!

HoustonPutman commented Mar 26, 2026

Uh oh!

Uh oh!

igiguere commented Mar 27, 2026

Uh oh!

gerlowskija commented Jun 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Choose a reason for hiding this comment

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!

gerlowskija commented Jun 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

igiguere commented Mar 25, 2026 •

edited by gerlowskija

Loading

gerlowskija commented Jun 11, 2026 •

edited

Loading