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 | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame] | 5 | package eu.mulk.quarkus.googlecloud.jsonlogging; |
| 6 | |
| 7 | /** |
| 8 | * A user-supplied provider for {@link StructuredParameter}s. |
| 9 | * |
Matthias Andreas Benkard | 2021024 | 2022-01-15 10:39:30 +0100 | [diff] [blame] | 10 | * <p>Instances of this interface that are registered with the {@link Formatter} are applied to each |
| 11 | * log entry that is logged. |
| 12 | * |
| 13 | * <p>If you are using the Quarkus extension, any CDI beans registered under this interface are |
| 14 | * registered automatically. |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 15 | * |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 16 | * <p><strong>Example:</strong> |
| 17 | * |
| 18 | * <pre>{@code |
| 19 | * @Singleton |
| 20 | * @Unremovable |
| 21 | * public final class TraceLogParameterProvider implements StructuredParameterProvider { |
| 22 | * |
| 23 | * @Override |
| 24 | * public StructuredParameter getParameter() { |
| 25 | * var b = Json.createObjectBuilder(); |
| 26 | * b.add("traceId", Span.current().getSpanContext().getTraceId()); |
| 27 | * b.add("spanId", Span.current().getSpanContext().getSpanId()); |
| 28 | * return () -> b; |
| 29 | * } |
| 30 | * } |
| 31 | * }</pre> |
| 32 | * |
| 33 | * Result: |
| 34 | * |
| 35 | * <pre>{@code |
| 36 | * { |
| 37 | * "jsonPayload": { |
| 38 | * "message": "Request rejected: unauthorized.", |
| 39 | * "traceId": "39f9a49a9567a8bd7087b708f8932550", |
| 40 | * "spanId": "c7431b14630b633d" |
| 41 | * } |
| 42 | * } |
| 43 | * }</pre> |
| 44 | * |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 45 | * @see LabelProvider |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame] | 46 | */ |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 47 | public interface StructuredParameterProvider { |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame] | 48 | |
Matthias Andreas Benkard | 42da9f1 | 2021-09-02 18:47:28 +0200 | [diff] [blame] | 49 | /** |
| 50 | * Provides a {@link StructuredParameter} to add to each log entry that is logged. |
| 51 | * |
| 52 | * <p>It is often useful to return a custom {@link StructuredParameter} rather than a {@link |
| 53 | * KeyValueParameter} from this method. This way multiple key–value pairs can be generated by a |
| 54 | * single invocation. |
| 55 | * |
| 56 | * @return a {@link StructuredParameter} to add to each log entry that is logged. |
| 57 | */ |
Matthias Andreas Benkard | 692f48d | 2021-08-31 21:06:50 +0200 | [diff] [blame] | 58 | StructuredParameter getParameter(); |
Matthias Andreas Benkard | 82d7e44 | 2021-08-29 08:34:11 +0200 | [diff] [blame] | 59 | } |