summaryrefslogtreecommitdiff
path: root/runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-09-02 18:47:28 +0200
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-09-02 18:47:28 +0200
commit42da9f14b44fdfe91c60c95738480ce390749edd (patch)
tree39a9b7b4eae4b9e8444a82b0599459693b3f8f3f /runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java
parented20bb4d2dfed45176ac5aa3e934a1acf1a2cc13 (diff)
Add missing Javadocs.
Change-Id: I63f0086ed99a259391ef6094a5218744d4b2fc60
Diffstat (limited to 'runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java')
-rw-r--r--runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java b/runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java
index a26f4da..7234a71 100644
--- a/runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java
+++ b/runtime/src/main/java/eu/mulk/quarkus/googlecloud/jsonlogging/GoogleCloudJsonLoggingRecorder.java
@@ -3,12 +3,22 @@ package eu.mulk.quarkus.googlecloud.jsonlogging;
import io.quarkus.arc.Arc;
import io.quarkus.runtime.RuntimeValue;
import io.quarkus.runtime.annotations.Recorder;
+import java.util.Collection;
import java.util.Optional;
import java.util.stream.Collectors;
/** A Quarkus recorder that registers {@link Formatter} as a log formatter for the application. */
@Recorder
public class GoogleCloudJsonLoggingRecorder {
+
+ /**
+ * Registers {@link Formatter} as a log formatter for the application.
+ *
+ * <p>Collects all discoverable {@link StructuredParameterProvider}s and {@link LabelProvider}s
+ * and passes them to {@link Formatter#Formatter(Collection, Collection)}.
+ *
+ * @return the registered {@link Formatter}.
+ */
public RuntimeValue<Optional<java.util.logging.Formatter>> initialize() {
var parameterProviders =