com.networknt.logging.handler.LoggerGetHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of logger-config Show documentation
Show all versions of logger-config Show documentation
This module will provide the information about logging and switch logging level.
/*
* Copyright (c) 2016 Network New Technologies Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.networknt.logging.handler;
import ch.qos.logback.classic.LoggerContext;
import com.fasterxml.jackson.core.type.TypeReference;
import com.networknt.client.Http2Client;
import com.networknt.client.simplepool.SimpleConnectionHolder;
import com.networknt.config.Config;
import com.networknt.handler.LightHttpHandler;
import com.networknt.common.ContentType;
import com.networknt.logging.model.LoggerConfig;
import com.networknt.logging.model.LoggerInfo;
import com.networknt.monad.Failure;
import com.networknt.monad.Result;
import com.networknt.monad.Success;
import com.networknt.status.Status;
import com.networknt.utility.Constants;
import com.networknt.utility.ModuleRegistry;
import io.undertow.UndertowOptions;
import io.undertow.client.ClientConnection;
import io.undertow.client.ClientRequest;
import io.undertow.client.ClientResponse;
import io.undertow.server.HttpServerExchange;
import io.undertow.util.HeaderValues;
import io.undertow.util.Headers;
import io.undertow.util.Methods;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xnio.OptionMap;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicReference;
/**
* This handler will provide all the available logging levels for the all loggers.
*/
public class LoggerGetHandler implements LightHttpHandler {
private static final Logger logger = LoggerFactory.getLogger(LoggerGetHandler.class);
static final String LOGGER_INFO_DISABLED = "ERR12108";
static final String GENERIC_EXCEPTION = "ERR10014";
static final String API_ERROR_RESPONSE = "ERR10083";
static final String DOWNSTREAM_ADMIN_DISABLED = "ERR10084";
protected static LoggerConfig config;
public LoggerGetHandler() {
if(logger.isInfoEnabled()) logger.info("LoggerGetHandler is constructed.");
config = LoggerConfig.load();
ModuleRegistry.registerModule(LoggerConfig.CONFIG_NAME, LoggerConfig.class.getName(), config.getMappedConfig(),null);
}
@Override
public void handleRequest(final HttpServerExchange exchange) throws Exception {
if(!config.isEnabled()) {
if(logger.isDebugEnabled()) logger.debug("logging is disabled");
setExchangeStatus(exchange, LOGGER_INFO_DISABLED);
return;
}
// first, we need to check if the X-Adm-PassThrough header exists and if it is true.
// If it is true, we will just pass the request to the downstream API.
HeaderValues passThroughObject = exchange.getRequestHeaders().get(Constants.ADM_PASSTHROUGH_STRING);
if(passThroughObject != null && passThroughObject.getFirst().equals("true")) {
if(logger.isDebugEnabled()) logger.debug("pass through is true");
if(config.isDownstreamEnabled()) {
Result> loggersResult = getBackendLogger();
if(loggersResult.isSuccess()) {
exchange.getResponseHeaders().put(Headers.CONTENT_TYPE, ContentType.APPLICATION_JSON.value());
exchange.getResponseSender().send(Config.getInstance().getMapper().writeValueAsString(loggersResult.getResult()));
} else {
setExchangeStatus(exchange, API_ERROR_RESPONSE, loggersResult.getError().getCode());
}
} else {
// need to return an error status to indicate that downstream API access is disabled.
setExchangeStatus(exchange, DOWNSTREAM_ADMIN_DISABLED);
}
} else {
if(logger.isDebugEnabled()) logger.debug("pass through is false");
List loggersList = new ArrayList();
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
for (ch.qos.logback.classic.Logger log : lc.getLoggerList()) {
if (log.getLevel() != null) {
LoggerInfo loggerInfo = new LoggerInfo();
loggerInfo.setName(log.getName());
loggerInfo.setLevel(log.getLevel().toString());
loggersList.add(loggerInfo);
}
}
exchange.getResponseHeaders().put(Headers.CONTENT_TYPE, ContentType.APPLICATION_JSON.value());
exchange.getResponseSender().send(Config.getInstance().getMapper().writeValueAsString(loggersList));
}
}
/**
* Try to access the downstream API logger endpoint to get the current logging level for loggers.
*
* @return result String of loggers or status error.
*/
private Result> getBackendLogger() {
long start = System.currentTimeMillis();
Result> result = null;
SimpleConnectionHolder.ConnectionToken connectionToken = null;
try {
if(config.getDownstreamHost().startsWith(Constants.HTTPS)) {
connectionToken = Http2Client.getInstance().borrow(new URI(config.getDownstreamHost()), Http2Client.WORKER, Http2Client.getInstance().getDefaultXnioSsl(), Http2Client.BUFFER_POOL, OptionMap.create(UndertowOptions.ENABLE_HTTP2, true));
} else {
connectionToken = Http2Client.getInstance().borrow(new URI(config.getDownstreamHost()), Http2Client.WORKER, Http2Client.BUFFER_POOL, OptionMap.EMPTY);
}
ClientConnection connection = (ClientConnection) connectionToken.getRawConnection();
final CountDownLatch latch = new CountDownLatch(1);
final AtomicReference reference = new AtomicReference<>();
ClientRequest request = new ClientRequest().setMethod(Methods.GET).setPath(getRequestPath());
request.getRequestHeaders().put(Headers.HOST, "localhost");
connection.sendRequest(request, Http2Client.getInstance().createClientCallback(reference, latch));
latch.await();
int statusCode = reference.get().getResponseCode();
String body = reference.get().getAttachment(Http2Client.RESPONSE_BODY);
if(logger.isDebugEnabled()) logger.debug("statusCode = " + statusCode + " body = " + body);
if(statusCode >= 400) {
// error response from the backend API.
return Failure.of(new Status(API_ERROR_RESPONSE, statusCode));
}
long responseTime = System.currentTimeMillis() - start;
if(logger.isDebugEnabled()) logger.debug("Downstream health check response time = " + responseTime);
return Success.of(getFrameworkLoggers(body));
} catch (Exception ex) {
logger.error("Could not create connection to the backend: " + config.getDownstreamHost() + ":", ex);
Status status = new Status(GENERIC_EXCEPTION, ex.getMessage());
return Failure.of(status);
} finally {
Http2Client.getInstance().restore(connectionToken);
}
}
private static String getRequestPath() {
String framework = config.getDownstreamFramework();
switch (framework) {
case Constants.SPRING_BOOT:
return "/actuator/loggers";
default:
return "/adm/logger";
}
}
private static List getFrameworkLoggers(String responseBody) throws Exception {
String framework = config.getDownstreamFramework();
switch (framework) {
case Constants.SPRING_BOOT:
// transform the response from the spring boot actuator to the LoggerInfo object.
List loggersList = new ArrayList();
Map map = Config.getInstance().getMapper().readValue(responseBody, new TypeReference>() {});
Map loggers = (Map) map.get("loggers");
for(Map.Entry entry: loggers.entrySet()) {
LoggerInfo loggerInfo = new LoggerInfo();
loggerInfo.setName(entry.getKey());
Map logger = (Map) entry.getValue();
loggerInfo.setLevel((String) logger.get("effectiveLevel"));
loggersList.add(loggerInfo);
}
return loggersList;
default:
// light-4j response will be used directly.
return Config.getInstance().getMapper().readValue(responseBody, new TypeReference>() {});
}
}
/**
* Try to access the downstream API logger endpoint to get the current logging level for loggers.
*
* @return result String of loggers or status error.
*/
private Result> postBackendLogger() {
long start = System.currentTimeMillis();
Result> result = null;
SimpleConnectionHolder.ConnectionToken connectionToken = null;
try {
if(config.getDownstreamHost().startsWith(Constants.HTTPS)) {
connectionToken = Http2Client.getInstance().borrow(new URI(config.getDownstreamHost()), Http2Client.WORKER, Http2Client.getInstance().getDefaultXnioSsl(), Http2Client.BUFFER_POOL, OptionMap.create(UndertowOptions.ENABLE_HTTP2, true));
} else {
connectionToken = Http2Client.getInstance().borrow(new URI(config.getDownstreamHost()), Http2Client.WORKER, Http2Client.BUFFER_POOL, OptionMap.EMPTY);
}
ClientConnection connection = (ClientConnection) connectionToken.getRawConnection();
final CountDownLatch latch = new CountDownLatch(1);
final AtomicReference reference = new AtomicReference<>();
ClientRequest request = new ClientRequest().setMethod(Methods.GET).setPath(getRequestPath());
request.getRequestHeaders().put(Headers.HOST, "localhost");
connection.sendRequest(request, Http2Client.getInstance().createClientCallback(reference, latch));
latch.await();
int statusCode = reference.get().getResponseCode();
String body = reference.get().getAttachment(Http2Client.RESPONSE_BODY);
if(logger.isDebugEnabled()) logger.debug("statusCode = " + statusCode + " body = " + body);
if(statusCode >= 400) {
// error response from the backend API.
return Failure.of(new Status(API_ERROR_RESPONSE, statusCode));
}
long responseTime = System.currentTimeMillis() - start;
if(logger.isDebugEnabled()) logger.debug("Downstream health check response time = " + responseTime);
return Success.of(getFrameworkLoggers(body));
} catch (Exception ex) {
logger.error("Could not create connection to the backend: " + config.getDownstreamHost() + ":", ex);
Status status = new Status(GENERIC_EXCEPTION, ex.getMessage());
return Failure.of(status);
} finally {
Http2Client.getInstance().restore(connectionToken);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy