Package org.apache.solr.handler.admin.api

Class NodeLoggingAPI

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.NodeLoggingAPI

@Path("/node/logging")
public class NodeLoggingAPI
extends JerseyResource

V2 APIs for getting or setting log levels on an individual node.

These APIs ('/api/node/logging' and descendants) are analogous to the v1 /admin/info/logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeLoggingAPI.ListLevelsResponse	Response format for the 'GET /api/node/logging/levels' API.
static class	NodeLoggingAPI.LoggingResponse	Generic logging response that includes the name of the log watcher (e.g.
static class	NodeLoggingAPI.LogLevelChange	A user-requested modification in the level that a specified logger reports at.
static class	NodeLoggingAPI.LogLevelInfo	Representation of a single logger and its current state.
static class	NodeLoggingAPI.LogMessageInfo	Metadata about the log messages returned by the 'GET /api/node/logging/messages' API
static class	NodeLoggingAPI.LogMessagesResponse	Response format for the 'GET /api/node/logging/messages' API.
static class	NodeLoggingAPI.SetThresholdRequestBody	The request body for the 'PUT /api/node/logging/messages/threshold' API.

Field Summary

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
NodeLoggingAPI(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
NodeLoggingAPI.LogMessagesResponse	fetchLocalLogMessages(Long boundingTimeMillis)
NodeLoggingAPI.ListLevelsResponse	listAllLoggersAndLevels()
NodeLoggingAPI.LoggingResponse	modifyLocalLogLevel(List<NodeLoggingAPI.LogLevelChange> requestBody)
NodeLoggingAPI.LoggingResponse	setMessageThreshold(NodeLoggingAPI.SetThresholdRequestBody requestBody)
static void	writeLogsForTesting()

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeLoggingAPI

@Inject
public NodeLoggingAPI(CoreContainer coreContainer)

Method Detail

listAllLoggersAndLevels

@Path("/levels")
@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public NodeLoggingAPI.ListLevelsResponse listAllLoggersAndLevels()

modifyLocalLogLevel

@Path("/levels")
@PUT
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public NodeLoggingAPI.LoggingResponse modifyLocalLogLevel(List<NodeLoggingAPI.LogLevelChange> requestBody)

fetchLocalLogMessages

@Path("/messages")
@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public NodeLoggingAPI.LogMessagesResponse fetchLocalLogMessages(@QueryParam("since")
                                                                Long boundingTimeMillis)

setMessageThreshold

@Path("/messages/threshold")
@PUT
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public NodeLoggingAPI.LoggingResponse setMessageThreshold(NodeLoggingAPI.SetThresholdRequestBody requestBody)

writeLogsForTesting

public static void writeLogsForTesting()