[
https://issues.apache.org/jira/browse/SOLR-15823?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Eric Pugh updated SOLR-15823:
-----------------------------
Description:
Currently, the /v2/node/logging API (and it's v1 counterpart:
/solr/admin/info/logging) use the same API to both set and get log-level
information.
In the v2 world at least, this could be split up to depend on the HTTP verb,
using POST or PUT for changes to log-levels, and GET for retrieval of log-level
information.
Doing so would be more consistent with the HTTP-verb-aware design of the v2
API. Practically though, it'd also help us get around a limitation of the
current annotation framework, where each API can only be governed by a single
{{PermissionNameProvider.Name}} value. Splitting the APIs into different verbs
lets us govern them with the appropriate permissions in v2-land.
We also need to deal with the single node/multiple nodes thing.
NodeLoggingApis ('/api/node/logging/...', implemented by NodeLogging.java) only
ever
operates on the receiving node. There's no way to broadcast a log-level change
to every
live node via v2 today, so the Admin UI's "set log level" feature
(LoggingLevelController
in logging.js) still falls back to the legacy v1
'/admin/info/logging?nodes=all' handler
in SolrCloud mode (see the "Intentionally still v1" comment in logging.js and
the TODO in
NodeLogging.java).
SOLR-16738 already added v2-API-compatible proxy support in general
(V2SolrRequestBasedProxy), and GetNodeSystemInfo (NodeSystemInfoApi, also under
'/api/node')
already uses it to support a 'nodes' query param that fans a request out to a
specified set
of nodes (or 'all') and aggregates the responses. That's the exact pattern
needed here;
NodeLoggingApis just hasn't been wired up to it yet.
Proposed change:
- Add a 'nodes' query param to NodeLoggingApis.modifyLocalLogLevel (and
NodeLoggingApis
interface method signature), following the same shape as
NodeSystemInfoApi.getNodeSystemInfo.
- In NodeLogging.java, when 'nodes' is present, proxy the request via
V2SolrRequestBasedProxy
the same way GetNodeSystemInfo.proxyToNodes(...) does, instead of (or in
addition to) applying
the change locally.
- Update the generated SolrJ/js-client (LoggingApi) accordingly - should be
automatic from the
OpenAPI annotation change.
- Once this lands, LoggingLevelController.setLevel in logging.js can drop its
SolrCloud-mode v1
branch entirely and always call LoggingV2.modifyLocalLogLevel with
nodes:'all' (or omitted in
standalone mode, as already handled by SOLR-18317) - retiring the 'Logging'
v1 $resource
factory in services.js for good.
Acceptance criteria:
- PUT /api/node/logging/levels?nodes=all applies the given log-level change(s)
to every live
node and aggregates success/failure like GetNodeSystemInfo does.
- PUT /api/node/logging/levels with no 'nodes' param continues to behave
exactly as it does
today (local node only) - no regression for existing callers.
- The Admin UI's logging-levels screen is updated to use
LoggingV2.modifyLocalLogLevel
unconditionally, and the v1 'Logging' factory in services.js is removed.
- Existing LoggingHandlerTest / AdminUiLoggingScreenTest /
AdminUiLoggingStandaloneTest
(SOLR-18317) continue to pass.
was:
Currently, the /v2/node/logging API (and it's v1 counterpart:
/solr/admin/info/logging) use the same API to both set and get log-level
information.
In the v2 world at least, this could be split up to depend on the HTTP verb,
using POST or PUT for changes to log-levels, and GET for retrieval of log-level
information.
Doing so would be more consistent with the HTTP-verb-aware design of the v2
API. Practically though, it'd also help us get around a limitation of the
current annotation framework, where each API can only be governed by a single
{{PermissionNameProvider.Name}} value. Splitting the APIs into different verbs
lets us govern them with the appropriate permissions in v2-land.
> Split v2 /node/logging API into separate GET and PUT APIs
> ---------------------------------------------------------
>
> Key: SOLR-15823
> URL: https://issues.apache.org/jira/browse/SOLR-15823
> Project: Solr
> Issue Type: Bug
> Components: v2 API
> Reporter: Jason Gerlowski
> Priority: Major
> Labels: V2
>
> Currently, the /v2/node/logging API (and it's v1 counterpart:
> /solr/admin/info/logging) use the same API to both set and get log-level
> information.
> In the v2 world at least, this could be split up to depend on the HTTP verb,
> using POST or PUT for changes to log-levels, and GET for retrieval of
> log-level information.
> Doing so would be more consistent with the HTTP-verb-aware design of the v2
> API. Practically though, it'd also help us get around a limitation of the
> current annotation framework, where each API can only be governed by a single
> {{PermissionNameProvider.Name}} value. Splitting the APIs into different
> verbs lets us govern them with the appropriate permissions in v2-land.
> We also need to deal with the single node/multiple nodes thing.
>
> NodeLoggingApis ('/api/node/logging/...', implemented by NodeLogging.java)
> only ever
> operates on the receiving node. There's no way to broadcast a log-level
> change to every
> live node via v2 today, so the Admin UI's "set log level" feature
> (LoggingLevelController
> in logging.js) still falls back to the legacy v1
> '/admin/info/logging?nodes=all' handler
> in SolrCloud mode (see the "Intentionally still v1" comment in logging.js and
> the TODO in
> NodeLogging.java).
>
> SOLR-16738 already added v2-API-compatible proxy support in general
> (V2SolrRequestBasedProxy), and GetNodeSystemInfo (NodeSystemInfoApi, also
> under '/api/node')
> already uses it to support a 'nodes' query param that fans a request out to a
> specified set
> of nodes (or 'all') and aggregates the responses. That's the exact pattern
> needed here;
> NodeLoggingApis just hasn't been wired up to it yet.
> Proposed change:
> - Add a 'nodes' query param to NodeLoggingApis.modifyLocalLogLevel (and
> NodeLoggingApis
> interface method signature), following the same shape as
> NodeSystemInfoApi.getNodeSystemInfo.
> - In NodeLogging.java, when 'nodes' is present, proxy the request via
> V2SolrRequestBasedProxy
> the same way GetNodeSystemInfo.proxyToNodes(...) does, instead of (or in
> addition to) applying
> the change locally.
> - Update the generated SolrJ/js-client (LoggingApi) accordingly - should be
> automatic from the
> OpenAPI annotation change.
> - Once this lands, LoggingLevelController.setLevel in logging.js can drop its
> SolrCloud-mode v1
> branch entirely and always call LoggingV2.modifyLocalLogLevel with
> nodes:'all' (or omitted in
> standalone mode, as already handled by SOLR-18317) - retiring the 'Logging'
> v1 $resource
> factory in services.js for good.
> Acceptance criteria:
> - PUT /api/node/logging/levels?nodes=all applies the given log-level
> change(s) to every live
> node and aggregates success/failure like GetNodeSystemInfo does.
> - PUT /api/node/logging/levels with no 'nodes' param continues to behave
> exactly as it does
> today (local node only) - no regression for existing callers.
> - The Admin UI's logging-levels screen is updated to use
> LoggingV2.modifyLocalLogLevel
> unconditionally, and the v1 'Logging' factory in services.js is removed.
> - Existing LoggingHandlerTest / AdminUiLoggingScreenTest /
> AdminUiLoggingStandaloneTest
> (SOLR-18317) continue to pass.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
