io.apptik.comm.jus.JusLog Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jus-java Show documentation
Show all versions of jus-java Show documentation
Communication library for Android and Java
The newest version!
/*
* Copyright (C) 2015 AppTik Project
*
* 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 io.apptik.comm.jus;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import io.apptik.comm.jus.error.JusError;
public class JusLog {
public static Log log = new DefaultLog();
private static boolean markerLogOn = false;
private static boolean reponseLogOn = false;
private static boolean errorLogOn = false;
public static void log(String msg) {
if(log!=null) {
log.log(msg);
}
}
public static void error(String msg) {
if(log!=null) {
log.error(msg);
}
}
public static class ErrorLog {
public static void on() {
errorLogOn = true;
}
public static boolean isOn() {
return errorLogOn;
}
public static void off() {
errorLogOn = false;
}
static RequestListener.ErrorListener getLogger(final Request request) {
return new RequestListener.ErrorListener() {
@Override
public void onError(JusError error) {
if (log == null) return;
log.error(buildMessage(request, "Error: %s", error));
}
};
}
}
public static class ResponseLog {
public static void on() {
reponseLogOn = true;
}
public static void off() {
reponseLogOn = false;
}
public static boolean isOn() {
return reponseLogOn;
}
static RequestListener.ResponseListener getLogger(final Request request) {
return new RequestListener.ResponseListener() {
@Override
public void onResponse(Object response) {
if (log == null) return;
log.log(buildMessage(request, "Response: %s", response));
}
};
}
}
/**
* A simple event log with records containing a name, threadId ID, and timestamp.
*/
public static class MarkerLog {
public static void on() {
markerLogOn = true;
}
public static void off() {
markerLogOn = false;
}
public static boolean isOn() {
return markerLogOn;
}
/**
* Minimum duration from first marker to last in an marker log to warrant logging.
*/
private static final long MIN_DURATION_FOR_LOGGING_MS = 0;
static RequestListener.MarkerListener getLogger(final Request request) {
return new RequestListener.MarkerListener() {
final MarkerLog markerLog = new MarkerLog(request);
@Override
public void onMarker(Marker marker, Object... args) {
if (log == null) return;
markerLog.add(marker, args);
}
};
}
private final List mMarkers = new ArrayList();
private volatile boolean mFinished = false;
private Request request;
public MarkerLog(Request request) {
this.request = request;
}
/**
* Adds a marker to this log with the specified name.
*/
public synchronized void add(Marker marker, Object... args) {
if (mFinished) {
throw new IllegalStateException("Marker added to finished request");
}
log.log(buildMarkerMessage(request, "\n\t\targs=%s", marker,
Arrays.toString(args)));
mMarkers.add(marker);
if (Request.EVENT_DONE.equals(marker.name)) {
finish("[" + request.getMethod() + "][" + request.getTag() + "]" +
request.getUrlString());
}
}
/**
* Closes the log, dumping it to logcat if the time difference between
* the first and last markers is greater than {@link #MIN_DURATION_FOR_LOGGING_MS}.
*
* @param header Header string to print above the marker log.
*/
public synchronized void finish(String header) {
mFinished = true;
long duration = getTotalDuration();
if (duration <= MIN_DURATION_FOR_LOGGING_MS) {
return;
}
long prevTime = mMarkers.get(0).time;
log.log(buildFinishMessage("(%-10d ns) %s", duration, header));
for (Marker marker : mMarkers) {
long thisTime = marker.time;
log.log(String.format("(+%-10d) [%2d/%s] %s", (thisTime - prevTime)
, marker.threadId, marker
.threadName, marker.name));
prevTime = thisTime;
}
}
@Override
protected void finalize() throws Throwable {
// Catch requests that have been collected (and hence end-of-lifed)
// but had no debugging output printed for them.
if (!mFinished) {
finish("Request on the loose");
log.log(buildMessage(request, "Marker log finalized without finish() - " +
"uncaught exit point for request"));
}
super.finalize();
}
/**
* Returns the time difference between the first and last events in this log.
*/
private long getTotalDuration() {
if (mMarkers.size() == 0) {
return 0;
}
long first = mMarkers.get(0).time;
long last = mMarkers.get(mMarkers.size() - 1).time;
return last - first;
}
}
private static String buildMarkerMessage(Request request, String format, Marker marker,
Object... args) {
String msg = (args == null) ? format : String.format(Locale.US, format, args);
return String.format(Locale.US, "[%d]: %s:\n\t%s\n\t\t%s",
Thread.currentThread().getId(), marker.toString(), request.toString(), msg);
}
private static String buildFinishMessage(String format, Object... args) {
String msg = (args == null) ? format : String.format(Locale.US, format, args);
return String.format(Locale.US, "[%d]: %s",
Thread.currentThread().getId(), msg);
}
private static String buildMessage(Request request, String format, Object... args) {
String msg = (args == null) ? format : String.format(Locale.US, format, args);
return String.format(Locale.US, "[%d]: %s:\n\t\t%s",
Thread.currentThread().getId(), request.toString(), msg);
}
/**
* Formats the caller's provided message and prepends useful info like
* calling threadId ID and method name.
*/
private static String buildCallerMessage(String format, Object... args) {
String msg = (args == null) ? format : String.format(Locale.US, format, args);
StackTraceElement[] trace = new Throwable().fillInStackTrace().getStackTrace();
String caller = "";
// Walk up the stack looking for the first caller outside of JusLog.
// It will be at least two frames up, so start there.
for (int i = 2; i < trace.length; i++) {
Class clazz = trace[i].getClass();
if (!clazz.equals(JusLog.class)) {
String callingClass = trace[i].getClassName();
callingClass = callingClass.substring(callingClass.lastIndexOf('.') + 1);
callingClass = callingClass.substring(callingClass.lastIndexOf('$') + 1);
caller = callingClass + "." + trace[i].getMethodName();
break;
}
}
return String.format(Locale.US, "[%d] %s: %s",
Thread.currentThread().getId(), caller, msg);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy