io.helidon.webserver.observe.log.LogObserver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-webserver-observe-log Show documentation
Logging setup and log files
The newest version!
/*
 * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.helidon.webserver.observe.log;

import java.util.List;
import java.util.function.Consumer;
import java.util.function.UnaryOperator;

import io.helidon.builder.api.RuntimeType;
import io.helidon.webserver.http.HttpFeature;
import io.helidon.webserver.http.HttpRouting;
import io.helidon.webserver.observe.DisabledObserverFeature;
import io.helidon.webserver.observe.spi.Observer;
import io.helidon.webserver.spi.ServerFeature;

/**
 * Observer for information about loggers, and possibly to obtain log stream.
 */
@RuntimeType.PrototypedBy(LogObserverConfig.class)
public class LogObserver implements Observer, RuntimeType.Api {
    private final LogObserverConfig config;

    private LogObserver(LogObserverConfig config) {
        this.config = config;
    }

    /**
     * Create a new builder to configure Log observer.
     *
     * @return a new builder
     */
    public static LogObserverConfig.Builder builder() {
        return LogObserverConfig.builder();
    }

    /**
     * Create a new Log observer using the provided configuration.
     *
     * @param config configuration
     * @return a new observer
     */
    public static LogObserver create(LogObserverConfig config) {
        return new LogObserver(config);
    }

    /**
     * Create a new Log observer customizing its configuration.
     *
     * @param consumer configuration consumer
     * @return a new observer
     */
    public static LogObserver create(Consumer consumer) {
        return builder()
                .update(consumer)
                .build();
    }

    /**
     * Create a new Log observer with default configuration.
     *
     * @return a new observer
     */
    public static LogObserver create() {
        return builder()
                .build();
    }

    @Override
    public LogObserverConfig prototype() {
        return config;
    }

    @Override
    public String type() {
        return "log";
    }

    @Override
    public void register(ServerFeature.ServerFeatureContext featureContext,
                         List observeEndpointRouting,
                         UnaryOperator endpointFunction) {
        String endpoint = endpointFunction.apply(config.endpoint());

        if (config.enabled()) {
            for (HttpRouting.Builder routing : observeEndpointRouting) {
                // register the service itself
                routing.addFeature(new LogHttpFeature(endpoint, this.config));
            }
        } else {
            for (HttpRouting.Builder builder : observeEndpointRouting) {
                builder.addFeature(DisabledObserverFeature.create("Log", endpoint + "/*"));
            }
        }
    }

    private static class LogHttpFeature implements HttpFeature {
        private final String endpoint;
        private final LogObserverConfig config;

        private LogHttpFeature(String endpoint, LogObserverConfig config) {
            this.endpoint = endpoint;
            this.config = config;
        }

        @Override
        public void setup(HttpRouting.Builder routing) {
            routing.register(endpoint, new LogService(this.config));
        }
    }
}