001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022
023/**
024 * Contract for handling database statement log events.
025 * <p>
026 * Implementations should be threadsafe.
027 *
028 * @author <a href="https://www.revetkn.com">Mark Allen</a>
029 * @since 1.0.0
030 */
031@ThreadSafe
032@FunctionalInterface
033public interface StatementLogger {
034        /**
035         * Performs a logging operation on the given {@code statementLog}.
036         * <p>
037         * Implementors might choose to no-op, write to stdout or a logging framework, send alerts about slow queries, and so
038         * on.
039         * <p>
040         * Unlike {@link MetricsCollector} failures, {@code StatementLogger} failures are not silently discarded. If this method
041         * throws after a statement has otherwise completed successfully, the thrown exception propagates to the caller. Inside a
042         * Pyranid transaction, logger failures participate in normal transaction failure handling and cause rollback. If the
043         * statement itself already failed, the logger failure is attached as a suppressed exception to the primary failure.
044         *
045         * @param statementLog The event to log
046         */
047        void log(@NonNull StatementLog statementLog);
048}