Matthias Andreas Benkard | 8090924 | 2022-02-03 20:47:47 +0100 | [diff] [blame] | 1 | // SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de> |
| 2 | // |
| 3 | // SPDX-License-Identifier: LGPL-3.0-or-later |
| 4 | |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 5 | /** |
| 6 | * Provides structured logging to standard output according to the Google Cloud Logging |
| 7 | * specification. |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 8 | * |
| 9 | * <ul> |
| 10 | * <li><a href="#sect-summary">Summary</a> |
Matthias Andreas Benkard | 348f205 | 2022-01-15 16:13:01 +0100 | [diff] [blame] | 11 | * <li><a href="#sect-installation">Installation</a> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 12 | * <li><a href="#sect-usage">Usage</a> |
| 13 | * </ul> |
| 14 | * |
| 15 | * <h2 id="sect-summary">Summary</h2> |
| 16 | * |
| 17 | * <p>This package contains a log formatter for JBoss Logging in the form of a Quarkus plugin that |
| 18 | * implements the <a href="https://cloud.google.com/logging/docs/structured-logging">Google Cloud |
| 19 | * Logging JSON format</a> on standard output. |
| 20 | * |
| 21 | * <p>It is possible to log unstructured text, structured data, or a mixture of both depending on |
| 22 | * the situation. |
| 23 | * |
Matthias Andreas Benkard | 348f205 | 2022-01-15 16:13:01 +0100 | [diff] [blame] | 24 | * <h2 id="sect-installation">Installation</h2> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 25 | * |
| 26 | * <ul> |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 27 | * <li><a href="#sect-installation-maven">Installation with Maven</a> |
| 28 | * <li><a href="#sect-installation-gradle">Installation with Gradle</a> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 29 | * </ul> |
| 30 | * |
| 31 | * <p>Add the runtime POM to your dependency list. As long as the JAR is on the classpath at both |
| 32 | * build time and runtime, the log formatter automatically registers itself on startup. |
| 33 | * |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 34 | * <h3 id="sect-installation-maven">Installation with Maven</h3> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 35 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 36 | * {@snippet lang="xml" : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 37 | * <project> |
| 38 | * ... |
| 39 | * |
| 40 | * <dependencies> |
| 41 | * ... |
| 42 | * |
| 43 | * <dependency> |
| 44 | * <groupId>eu.mulk.quarkus-googlecloud-jsonlogging</groupId> |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 45 | * <artifactId>quarkus-googlecloud-jsonlogging-core</artifactId> |
Matthias Andreas Benkard | 62ee2f5 | 2022-10-05 07:57:02 +0200 | [diff] [blame] | 46 | * <version>5.0.0</version> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 47 | * </dependency> |
| 48 | * |
| 49 | * ... |
| 50 | * </dependencies> |
| 51 | * |
| 52 | * ... |
| 53 | * </project> |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 54 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 55 | * |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 56 | * <h3 id="sect-installation-gradle">Installation with Gradle</h3> |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 57 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 58 | * {@snippet lang="groovy" : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 59 | * dependencies { |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 60 | * // ... |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 61 | * |
Matthias Andreas Benkard | 62ee2f5 | 2022-10-05 07:57:02 +0200 | [diff] [blame] | 62 | * implementation("eu.mulk.quarkus-googlecloud-jsonlogging:quarkus-googlecloud-jsonlogging-core:5.0.0") |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 63 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 64 | * // ... |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 65 | * } |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 66 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 67 | * |
| 68 | * <h2 id="sect-usage">Usage</h2> |
| 69 | * |
| 70 | * <ul> |
| 71 | * <li><a href="#sect-usage-parameter">Using Label and StructuredParameter</a> |
| 72 | * <li><a href="#sect-usage-provider">Using LabelProvider and StructuredParameterProvider</a> |
| 73 | * <li><a href="#sect-usage-mdc">Using the Mapped Diagnostic Context</a> |
| 74 | * </ul> |
| 75 | * |
| 76 | * <p>Logging unstructured data requires no code changes. All logs are automatically converted to |
| 77 | * Google-Cloud-Logging-compatible JSON. |
| 78 | * |
| 79 | * <p>Structured data can be logged in one of 3 different ways: by passing {@link |
| 80 | * eu.mulk.quarkus.googlecloud.jsonlogging.Label}s and {@link |
| 81 | * eu.mulk.quarkus.googlecloud.jsonlogging.StructuredParameter}s as parameters to individual log |
| 82 | * entries, by supplying {@link eu.mulk.quarkus.googlecloud.jsonlogging.LabelProvider}s and {@link |
| 83 | * eu.mulk.quarkus.googlecloud.jsonlogging.StructuredParameterProvider}s, or by using the Mapped |
| 84 | * Diagnostic Context. |
| 85 | * |
| 86 | * <h3 id="sect-usage-parameter">Using Label and StructuredParameter</h3> |
| 87 | * |
| 88 | * <p>Instances of {@link eu.mulk.quarkus.googlecloud.jsonlogging.Label} and {@link |
| 89 | * eu.mulk.quarkus.googlecloud.jsonlogging.StructuredParameter} can be passed as log parameters to |
| 90 | * the {@code *f} family of logging functions on JBoss Logging's {@link org.jboss.logging.Logger}. |
| 91 | * |
| 92 | * <p>Simple key–value pairs are represented by {@link |
| 93 | * eu.mulk.quarkus.googlecloud.jsonlogging.KeyValueParameter}. |
| 94 | * |
| 95 | * <p><strong>Example:</strong> |
| 96 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 97 | * {@snippet : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 98 | * logger.logf( |
| 99 | * "Request rejected: unauthorized.", |
| 100 | * Label.of("requestId", "123"), |
| 101 | * KeyValueParameter.of("resource", "/users/mulk"), |
| 102 | * KeyValueParameter.of("method", "PATCH"), |
| 103 | * KeyValueParameter.of("reason", "invalid token")); |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 104 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 105 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 106 | * <p>Result: |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 107 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 108 | * {@snippet lang="json" : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 109 | * { |
| 110 | * "jsonPayload": { |
| 111 | * "message": "Request rejected: unauthorized.", |
| 112 | * "resource": "/users/mulk", |
| 113 | * "method": "PATCH", |
| 114 | * "reason": "invalid token" |
| 115 | * }, |
| 116 | * "labels": { |
| 117 | * "requestId": "123" |
| 118 | * } |
| 119 | * } |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 120 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 121 | * |
| 122 | * <h3 id="sect-usage-provider">Using LabelProvider and StructuredParameterProvider</h3> |
| 123 | * |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 124 | * <p>If you pass {@link eu.mulk.quarkus.googlecloud.jsonlogging.LabelProvider}s and {@link |
| 125 | * eu.mulk.quarkus.googlecloud.jsonlogging.StructuredParameterProvider}s to {@link |
| 126 | * eu.mulk.quarkus.googlecloud.jsonlogging.Formatter}, then they are consulted to provide labels and |
| 127 | * parameters for each message that is logged. This can be used to provide contextual information |
| 128 | * such as tracing and request IDs stored in thread-local storage. |
| 129 | * |
Matthias Andreas Benkard | 93ecfd1 | 2022-01-15 14:03:41 +0100 | [diff] [blame] | 130 | * <p><strong>Service provider support:</strong> Providers can be registered using the {@link |
| 131 | * java.util.ServiceLoader} mechanism, in which case {@link |
| 132 | * eu.mulk.quarkus.googlecloud.jsonlogging.Formatter#load} picks them up automatically. |
| 133 | * |
| 134 | * <p><strong>CDI support:</strong> If you are using the Quarkus extension, CDI beans that implement |
| 135 | * one of the provider interfaces are automatically detected at build time and passed to the |
| 136 | * formatter on startup. In addition, providers using the {@link java.util.ServiceLoader} mechanism |
| 137 | * are detected and passed to the formatter as well. |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 138 | * |
| 139 | * <p><strong>Example:</strong> |
| 140 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 141 | * {@snippet : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 142 | * @Singleton |
| 143 | * @Unremovable |
| 144 | * public final class TraceLogParameterProvider implements StructuredParameterProvider, LabelProvider { |
| 145 | * |
| 146 | * @Override |
| 147 | * public StructuredParameter getParameter() { |
| 148 | * var b = Json.createObjectBuilder(); |
| 149 | * b.add("traceId", Span.current().getSpanContext().getTraceId()); |
| 150 | * b.add("spanId", Span.current().getSpanContext().getSpanId()); |
| 151 | * return () -> b; |
| 152 | * } |
| 153 | * |
| 154 | * @Override |
| 155 | * public Collection<Label> getLabels() { |
| 156 | * return List.of(Label.of("requestId", "123")); |
| 157 | * } |
| 158 | * } |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 159 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 160 | * |
| 161 | * Result: |
| 162 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 163 | * {@snippet lang="json" : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 164 | * { |
| 165 | * "jsonPayload": { |
| 166 | * "message": "Request rejected: unauthorized.", |
| 167 | * "traceId": "39f9a49a9567a8bd7087b708f8932550", |
| 168 | * "spanId": "c7431b14630b633d" |
| 169 | * }, |
| 170 | * "labels": { |
| 171 | * "requestId": "123" |
| 172 | * } |
| 173 | * } |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 174 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 175 | * |
| 176 | * <h3 id="sect-usage-mdc">Using the Mapped Diagnostic Context</h3> |
| 177 | * |
| 178 | * <p>Any key–value pairs in JBoss Logging's thread-local {@link org.jboss.logging.MDC} are added to |
| 179 | * the resulting JSON. |
| 180 | * |
| 181 | * <p><strong>Example:</strong> |
| 182 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 183 | * {@snippet : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 184 | * MDC.put("resource", "/users/mulk"); |
| 185 | * MDC.put("method", "PATCH"); |
| 186 | * logger.logf("Request rejected: unauthorized."); |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 187 | * } |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 188 | * |
| 189 | * Result: |
| 190 | * |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 191 | * {@snippet lang="json" : |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 192 | * { |
| 193 | * "jsonPayload": { |
| 194 | * "message": "Request rejected: unauthorized.", |
| 195 | * "resource": "/users/mulk", |
| 196 | * "method": "PATCH" |
| 197 | * } |
| 198 | * } |
Matthias Andreas Benkard | e369c51 | 2022-04-15 20:54:52 +0200 | [diff] [blame] | 199 | * } |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 200 | */ |
| 201 | package eu.mulk.quarkus.googlecloud.jsonlogging; |