Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 1 | package eu.mulk.quarkus.googlecloud.jsonlogging; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 2 | |
| 3 | import java.io.PrintWriter; |
| 4 | import java.io.StringWriter; |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 5 | import java.util.ArrayList; |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame^] | 6 | import java.util.Collection; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 7 | import java.util.HashMap; |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 8 | import java.util.List; |
| 9 | import java.util.Map; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 10 | import java.util.logging.Level; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 11 | import org.jboss.logmanager.ExtFormatter; |
| 12 | import org.jboss.logmanager.ExtLogRecord; |
| 13 | |
| 14 | /** |
| 15 | * Formats log records as JSON for consumption by Google Cloud Logging. |
| 16 | * |
| 17 | * <p>Meant to be used in containers running on Google Kubernetes Engine (GKE). |
| 18 | * |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 19 | * @see LogEntry |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 20 | */ |
Matthias Andreas Benkard | c066d89 | 2021-05-11 21:27:23 +0200 | [diff] [blame] | 21 | public class Formatter extends ExtFormatter { |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 22 | |
| 23 | private static final String TRACE_LEVEL = "TRACE"; |
| 24 | private static final String DEBUG_LEVEL = "DEBUG"; |
| 25 | private static final String INFO_LEVEL = "INFO"; |
| 26 | private static final String WARNING_LEVEL = "WARNING"; |
| 27 | private static final String ERROR_LEVEL = "ERROR"; |
| 28 | |
| 29 | private static final String ERROR_EVENT_TYPE = |
| 30 | "type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent"; |
| 31 | |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame^] | 32 | private final List<ParameterProvider> parameterProviders; |
| 33 | |
| 34 | public Formatter(Collection<ParameterProvider> parameterProviders) { |
| 35 | this.parameterProviders = List.copyOf(parameterProviders); |
| 36 | } |
| 37 | |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 38 | @Override |
| 39 | public String format(ExtLogRecord logRecord) { |
| 40 | var message = formatMessageWithStackTrace(logRecord); |
| 41 | |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 42 | List<StructuredParameter> parameters = new ArrayList<>(); |
| 43 | Map<String, String> labels = new HashMap<>(); |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame^] | 44 | |
| 45 | for (var parameterProvider : parameterProviders) { |
| 46 | var parameter = parameterProvider.get(); |
| 47 | if (parameter != null) { |
| 48 | parameters.add(parameter); |
| 49 | } |
| 50 | } |
| 51 | |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 52 | if (logRecord.getParameters() != null) { |
| 53 | for (var parameter : logRecord.getParameters()) { |
Matthias Andreas Benkard | 121a631 | 2021-05-12 05:41:25 +0200 | [diff] [blame] | 54 | if (parameter instanceof StructuredParameter) { |
| 55 | parameters.add((StructuredParameter) parameter); |
| 56 | } else if (parameter instanceof Label) { |
| 57 | var label = (Label) parameter; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 58 | labels.put(label.key(), label.value()); |
| 59 | } |
| 60 | } |
| 61 | } |
| 62 | |
| 63 | var mdc = logRecord.getMdcCopy(); |
| 64 | var ndc = logRecord.getNdc(); |
| 65 | |
| 66 | var sourceLocation = |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 67 | new LogEntry.SourceLocation( |
Matthias Andreas Benkard | 4bae5f1 | 2021-05-03 19:16:48 +0200 | [diff] [blame] | 68 | logRecord.getSourceFileName(), |
| 69 | String.valueOf(logRecord.getSourceLineNumber()), |
| 70 | String.format( |
| 71 | "%s.%s", logRecord.getSourceClassName(), logRecord.getSourceMethodName())); |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 72 | |
| 73 | var entry = |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 74 | new LogEntry( |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 75 | message, |
| 76 | severityOf(logRecord.getLevel()), |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 77 | new LogEntry.Timestamp(logRecord.getInstant()), |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 78 | null, |
| 79 | null, |
| 80 | sourceLocation, |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 81 | labels, |
| 82 | parameters, |
| 83 | mdc, |
| 84 | ndc, |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 85 | logRecord.getLevel().intValue() >= 1000 ? ERROR_EVENT_TYPE : null); |
| 86 | |
Matthias Andreas Benkard | b8fbc37 | 2021-05-11 06:50:45 +0200 | [diff] [blame] | 87 | return entry.json().build().toString() + "\n"; |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Formats the log message corresponding to {@code logRecord} including a stack trace of the |
| 92 | * {@link ExtLogRecord#getThrown()} exception if any. |
| 93 | */ |
| 94 | private String formatMessageWithStackTrace(ExtLogRecord logRecord) { |
| 95 | var messageStringWriter = new StringWriter(); |
| 96 | var messagePrintWriter = new PrintWriter(messageStringWriter); |
| 97 | messagePrintWriter.append(this.formatMessage(logRecord)); |
| 98 | |
| 99 | if (logRecord.getThrown() != null) { |
| 100 | messagePrintWriter.println(); |
| 101 | logRecord.getThrown().printStackTrace(messagePrintWriter); |
| 102 | } |
| 103 | |
| 104 | messagePrintWriter.close(); |
| 105 | return messageStringWriter.toString(); |
| 106 | } |
| 107 | |
Matthias Andreas Benkard | 4bae5f1 | 2021-05-03 19:16:48 +0200 | [diff] [blame] | 108 | /** Computes the Google Cloud Logging severity corresponding to a given {@link Level}. */ |
Matthias Andreas Benkard | c8144a9 | 2021-05-03 08:04:53 +0200 | [diff] [blame] | 109 | private static String severityOf(Level level) { |
| 110 | if (level.intValue() < 500) { |
| 111 | return TRACE_LEVEL; |
| 112 | } else if (level.intValue() < 700) { |
| 113 | return DEBUG_LEVEL; |
| 114 | } else if (level.intValue() < 900) { |
| 115 | return INFO_LEVEL; |
| 116 | } else if (level.intValue() < 1000) { |
| 117 | return WARNING_LEVEL; |
| 118 | } else { |
| 119 | return ERROR_LEVEL; |
| 120 | } |
| 121 | } |
| 122 | } |