Documentation

Signed-off-by: Hendrik Ebbers <[email protected]>

Author: hendrikebbers

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/interceptors/ReceiveRecordInterceptor.java

@@ -6,14 +6,36 @@
 import java.util.Objects;
 import org.jspecify.annotations.NonNull;
 
+/**
+ * First simple interceptor for receiving a record. This interceptor is used to intercept the call for receiving a
+ * record for a transaction. Frameworks like Spring can use this interceptor to add functionalities like metrics,
+ * tracing, or logging to the calls.
+ */
 @FunctionalInterface
 public interface ReceiveRecordInterceptor {
 
+    /**
+     * Default interceptor that does nothing.
+     */
     ReceiveRecordInterceptor DEFAULT_INTERCEPTOR = data -> data.handle();
 
+    /**
+     * Intercept the call for receiving a record for a transaction.
+     *
+     * @param handler the handler that will be used to receive the record
+     * @return the record for the transaction
+     * @throws Exception if the interceptor fails
+     */
     @NonNull
     TransactionRecord getRecordFor(@NonNull ReceiveRecordHandler handler) throws Exception;
 
+    /**
+     * Handler for receiving a record for a transaction.
+     *
+     * @param transaction the transaction for which the record is received
+     * @param receipt     the receipt for the transaction
+     * @param function    the function that will be used to receive the record
+     */
     record ReceiveRecordHandler(@NonNull Transaction transaction, @NonNull TransactionReceipt receipt,
                                 @NonNull ReceiveRecordFunction function) {
 
@@ -23,14 +45,31 @@ record ReceiveRecordHandler(@NonNull Transaction transaction, @NonNull Transacti
             Objects.requireNonNull(function, "handler must not be null");
         }
 
+        /**
+         * Handle the call for receiving a record for a transaction.
+         *
+         * @return the record for the transaction
+         * @throws Exception if the interceptor fails
+         */
         @NonNull
         public TransactionRecord handle() throws Exception {
             return function.handle(receipt);
         }
     }
 
+    /**
+     * Function that will be used to receive the record for a transaction.
+     */
     @FunctionalInterface
     interface ReceiveRecordFunction {
+
+        /**
+         * Handle the call for receiving a record for a transaction.
+         *
+         * @param receipt the receipt for the transaction
+         * @return the record for the transaction
+         * @throws Exception if the interceptor fails
+         */
         @NonNull
         TransactionRecord handle(@NonNull TransactionReceipt receipt) throws Exception;
     }

hiero-enterprise-spring-sample/src/main/resources/application.properties

@@ -5,4 +5,5 @@ spring.hiero.network.name=${HEDERA_NETWORK:hedera-testnet}
 logging.level.com.openelements=DEBUG
 logging.pattern.console=%d{HH:mm:ss.SSS} %logger{36} - %msg%n
 server.port=${SERVER_PORT:8080}
+# Needs to be done to activate the actuator endpoints (for metrics)
 management.endpoints.web.exposure.include=*

hiero-enterprise-spring/src/main/java/com/openelements/hiero/spring/implementation/MicrometerSupportConfig.java

@@ -15,6 +15,12 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 
+/**
+ * Micrometer support for Hiero. This configuration class is used to create a {@link ReceiveRecordInterceptor} that will
+ * measure metrics for Hiero transactions. The config is only loaded if the {@code spring.hiero.metrics.enabled}
+ * property is set to {@code true} or not set at all. Next to that, the {@code MetricsAutoConfiguration} configuration
+ * must be on the classpath.
+ */
 @AutoConfiguration
 @ConditionalOnProperty(name = "spring.hiero.metrics.enabled", havingValue = "true", matchIfMissing = true)
 @ConditionalOnClass(name = "org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration")
@@ -25,6 +31,12 @@ public class MicrometerSupportConfig {
     public static final String TIMER_NAME = "hiero.transaction.record.time";
     public static final String COUNTER_NAME = "hiero.transaction.record";
 
+    /**
+     * Creates a {@link ReceiveRecordInterceptor} that will measure metrics for Hiero transactions.
+     *
+     * @param meterRegistry the {@link MeterRegistry} to use for metrics
+     * @return the {@link ReceiveRecordInterceptor} to use for metrics
+     */
     @Bean
     @NonNull
     public ReceiveRecordInterceptor interceptRecordReceive(@NonNull final MeterRegistry meterRegistry) {