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