blob: 9bc3c11f683b6e5f0bcf97fe124e52e30d0d28b4 (
plain)
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
|
// SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
//
// SPDX-License-Identifier: LGPL-3.0-or-later
package eu.mulk.quarkus.googlecloud.jsonlogging;
import javax.json.JsonObjectBuilder;
/**
* A structured parameter usable as logging payload.
*
* <p>Any instance of {@link StructuredParameter} can be passed as a log parameter to the {@code *f}
* family of logging functions on {@link org.jboss.logging.Logger}.
*
* <p>Example:
*
* <pre>{@code
* StructuredParameter p1 = ...;
* StructuredParameter p2 = ...;
*
* logger.logf("Something interesting happened.", p1, p2);
* }</pre>
*
* @see KeyValueParameter
* @see Label
*/
public interface StructuredParameter {
/**
* The JSON to be embedded in the payload of the log entry.
*
* <p>May contain multiple keys and values as well as nested objects. Each top-level entry of the
* returned object is embedded as a top-level entry in the payload of the log entry.
*
* @return A {@link JsonObjectBuilder} holding a set of key–value pairs.
*/
JsonObjectBuilder json();
}
|
