io.deephaven.server.log.LogModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-server Show documentation
The 'server' project
The newest version!
//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.server.log;

import dagger.Binds;
import dagger.Module;
import dagger.Provides;
import dagger.multibindings.ElementsIntoSet;
import dagger.multibindings.IntoSet;
import io.deephaven.base.system.StandardStreamReceiver;
import io.deephaven.base.system.StandardStreamState;
import io.deephaven.base.system.StreamToPrintStreams;
import io.deephaven.internal.log.InitSink;
import io.deephaven.internal.log.LoggerFactory;
import io.deephaven.io.log.LogSink;
import io.deephaven.io.logger.LogBuffer;
import io.deephaven.io.logger.LogBufferGlobal;
import io.deephaven.io.logger.StreamToLogBuffer;

import javax.annotation.Nullable;
import javax.inject.Named;
import javax.inject.Singleton;
import java.io.PrintStream;
import java.util.ServiceLoader;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;

@Module
public interface LogModule {

    @Provides
    static LogBuffer providesLogBuffer() {
        return LogBufferGlobal.getInstance().orElseThrow(() -> new RuntimeException("No global LogBuffer found"));
    }

    @Provides
    static LogSink providesLogSink() {
        // In contract, this should be a singleton - see LogInit#checkLogSinkIsSingleton()
        return LoggerFactory.getLogger(LogModule.class).getSink();
    }

    @Provides
    @ElementsIntoSet
    static Set providesLoggerSinkSetups() {
        return StreamSupport
                .stream(ServiceLoader.load(InitSink.class).spliterator(), false)
                .collect(Collectors.toSet());
    }

    @Provides
    @Singleton // StreamToLogBuffer maintains state
    static StreamToLogBuffer providesStreamToLogBuffer(LogBuffer logBuffer) {
        final boolean toStdout = Boolean.parseBoolean(System.getProperty("stdout.toLogBuffer", "true"));
        final boolean toStderr = Boolean.parseBoolean(System.getProperty("stderr.toLogBuffer", "true"));
        // TODO (core#90): Add configuration and documentation for LogBufferOutputStream
        return new StreamToLogBuffer(logBuffer, toStdout, toStderr, 256, 1 << 19); // 512 KiB
    }

    @Provides
    static StreamToPrintStreams providesStreamToReal(@Nullable @Named("out") PrintStream out,
            @Nullable @Named("err") PrintStream err) {
        final boolean skipStdout = Boolean.getBoolean("stdout.skipReal");
        final boolean skipStderr = Boolean.getBoolean("stderr.skipReal");
        return new StreamToPrintStreams(skipStdout ? null : out, skipStderr ? null : err);
    }

    @Provides
    @Singleton
    static StandardStreamState providesStandardStreamState(Set receivers) {
        return new StandardStreamState(receivers);
    }

    @Binds
    @IntoSet
    StandardStreamReceiver bindsStreamToReal(StreamToPrintStreams streamToReal);

    @Binds
    @IntoSet
    StandardStreamReceiver bindsStreamToLogBufferInstance(StreamToLogBuffer streamToLogBuffer);
}