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