io.helidon.webserver.observe.metrics.PostRequestMetricsSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-webserver-observe-metrics Show documentation

Metrics output, either Prometheus format, or JSON

There is a newer version: 4.1.4

Show newest version

/*
 * Copyright (c) 2022, 2023 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.metrics;

import java.util.function.BiConsumer;

import io.helidon.webserver.http.ServerRequest;
import io.helidon.webserver.http.ServerResponse;

/**
 * Encapsulates metrics-related post-request processing that other components use and factory methods for creating instances of
 * the related context.
 */
public interface PostRequestMetricsSupport {

    /**
     * Creates a new instance.
     *
     * @return new instance
     */
    static PostRequestMetricsSupport create() {
        return PostRequestMetricsSupportImpl.create();
    }

    /**
     * Records a post-processing task to be performed once the response has been sent to the client.
     *
     * @param request {@code ServerRequest} with which to associate the post-processing task
     * @param task the work to perform
     */
    static void recordPostProcessingWork(ServerRequest request, BiConsumer task) {
        PostRequestMetricsSupport prms = request.context()
                .get(PostRequestMetricsSupport.class)
                .orElseThrow();

        prms.registerPostRequestWork(task);
    }

    /**
     * Records post-request processing to be performed once the server sends the response to the client.
     *
     * @param task the work to perform
     */
    void registerPostRequestWork(BiConsumer task);

    /**
     * Run the post-processing tasks.
     *
     * @param request the {@code ServerRequest} from the client
     * @param response the {@code ServerResponse} already sent to the client
     * @param throwable the {@code Throwable} for any problem encountered in preparing the response; null if successful
     */
    void runTasks(ServerRequest request, ServerResponse response, Throwable throwable);
}